| GET | /references | Get all valid references | Get all valid references. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class ReferenceQuery : QueryDb<ExternalReference, ReferenceQueryResponse>(), ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
var CompanyId:UUID? = null
/**
* Id of the reference
*/
@ApiMember(Description="Id of the reference")
var Id:UUID? = null
/**
* Internal Id of the reference. Example could be the Booking Id
*/
@ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
var OwnerId:UUID? = null
/**
* The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
*/
@ApiMember(Description="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
var ReferenceType:String? = null
/**
* The external data. Could be a Id or a JSON object or anything
*/
@ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
var ExternalData:String? = null
}
open class QueryDb<From, Into> : QueryBase()
{
}
@DataContract
open class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
@DataMember(Order=1)
var Skip:Int? = null
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
@DataMember(Order=2)
var Take:Int? = null
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
@DataMember(Order=3)
var OrderBy:String? = null
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
@DataMember(Order=4)
var OrderByDesc:String? = null
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
@DataMember(Order=5)
var Include:String? = null
@DataMember(Order=6)
var Fields:String? = null
@DataMember(Order=7)
var Meta:HashMap<String,String> = HashMap<String,String>()
}
open class ExternalReference : BaseModel()
{
@Required()
var CompanyId:UUID? = null
@Required()
var Id:UUID? = null
@Required()
var OwnerId:UUID? = null
@Required()
var ReferenceType:String? = null
var ExternalData:String? = null
var CreatedBy:String? = null
@Required()
var Updated:Date? = null
@Required()
var Created:Date? = null
var ModifiedDate:Date? = null
}
open class BaseModel
{
}
open class ReferenceQueryResponse
{
/**
* The company id
*/
@ApiMember(Description="The company id")
var CompanyId:UUID? = null
/**
* Id of the reference
*/
@ApiMember(Description="Id of the reference")
var Id:UUID? = null
/**
* Internal Id of the reference. Example could be the Booking Id
*/
@ApiMember(Description="Internal Id of the reference. Example could be the Booking Id")
var OwnerId:UUID? = null
/**
* The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
*/
@ApiMember(Description="The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system")
var ReferenceType:String? = null
/**
* The external data. Could be a Id or a JSON object or anything
*/
@ApiMember(Description="The external data. Could be a Id or a JSON object or anything")
var ExternalData:String? = null
/**
* Will show when the reference was updated.
*/
@ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
var Updated:Date? = null
/**
* Will show when the reference was created.
*/
@ApiMember(DataType="datetime", Description="Will show when the reference was created.")
var Created:Date? = null
/**
* Will show who created the reference.
*/
@ApiMember(DataType="datetime", Description="Will show who created the reference.")
var CreatedBy:String? = null
/**
* Will show who update the reference.
*/
@ApiMember(DataType="datetime", Description="Will show who update the reference.")
var UpdatedBy:String? = null
var ResponseStatus:ResponseStatus? = null
}
@DataContract
open class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
var Offset:Int? = null
@DataMember(Order=2)
var Total:Int? = null
@DataMember(Order=3)
var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()
@DataMember(Order=4)
var Meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
var Id:Int? = null
var KeyType:String? = null
var Description:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /references HTTP/1.1 Host: api.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"ReferenceType":"String","ExternalData":"String","CreatedBy":"String","UpdatedBy":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}