| 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.*;
public class dtos
{
public static class ReferenceQuery extends QueryDb<ExternalReference, ReferenceQueryResponse> implements 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.")
public UUID CompanyId = null;
/**
* Id of the reference
*/
@ApiMember(Description="Id of the reference")
public UUID Id = 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")
public UUID OwnerId = 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")
public String ReferenceType = 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")
public String ExternalData = null;
public UUID getCompanyId() { return CompanyId; }
public ReferenceQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public UUID getId() { return Id; }
public ReferenceQuery setId(UUID value) { this.Id = value; return this; }
public UUID getOwnerId() { return OwnerId; }
public ReferenceQuery setOwnerId(UUID value) { this.OwnerId = value; return this; }
public String getReferenceType() { return ReferenceType; }
public ReferenceQuery setReferenceType(String value) { this.ReferenceType = value; return this; }
public String getExternalData() { return ExternalData; }
public ReferenceQuery setExternalData(String value) { this.ExternalData = value; return this; }
}
public static class QueryDb<From, Into> extends QueryBase
{
}
@DataContract
public static 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)
public Integer Skip = 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)
public Integer Take = 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)
public String OrderBy = 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)
public String OrderByDesc = 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)
public String Include = null;
@DataMember(Order=6)
public String Fields = null;
@DataMember(Order=7)
public HashMap<String,String> Meta = null;
public Integer getSkip() { return Skip; }
public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
public Integer getTake() { return Take; }
public QueryBase setTake(Integer value) { this.Take = value; return this; }
public String getOrderBy() { return OrderBy; }
public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
public String getOrderByDesc() { return OrderByDesc; }
public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
public String getInclude() { return Include; }
public QueryBase setInclude(String value) { this.Include = value; return this; }
public String getFields() { return Fields; }
public QueryBase setFields(String value) { this.Fields = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
}
public static class ExternalReference extends BaseModel
{
@Required()
public UUID CompanyId = null;
@Required()
public UUID Id = null;
@Required()
public UUID OwnerId = null;
@Required()
public String ReferenceType = null;
public String ExternalData = null;
public String CreatedBy = null;
@Required()
public Date Updated = null;
@Required()
public Date Created = null;
public Date ModifiedDate = null;
public UUID getCompanyId() { return CompanyId; }
public ExternalReference setCompanyId(UUID value) { this.CompanyId = value; return this; }
public UUID getId() { return Id; }
public ExternalReference setId(UUID value) { this.Id = value; return this; }
public UUID getOwnerId() { return OwnerId; }
public ExternalReference setOwnerId(UUID value) { this.OwnerId = value; return this; }
public String getReferenceType() { return ReferenceType; }
public ExternalReference setReferenceType(String value) { this.ReferenceType = value; return this; }
public String getExternalData() { return ExternalData; }
public ExternalReference setExternalData(String value) { this.ExternalData = value; return this; }
public String getCreatedBy() { return CreatedBy; }
public ExternalReference setCreatedBy(String value) { this.CreatedBy = value; return this; }
public Date getUpdated() { return Updated; }
public ExternalReference setUpdated(Date value) { this.Updated = value; return this; }
public Date getCreated() { return Created; }
public ExternalReference setCreated(Date value) { this.Created = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public ExternalReference setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
}
public static class BaseModel
{
}
public static class ReferenceQueryResponse
{
/**
* The company id
*/
@ApiMember(Description="The company id")
public UUID CompanyId = null;
/**
* Id of the reference
*/
@ApiMember(Description="Id of the reference")
public UUID Id = 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")
public UUID OwnerId = 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")
public String ReferenceType = 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")
public String ExternalData = null;
/**
* Will show when the reference was updated.
*/
@ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
public Date Updated = null;
/**
* Will show when the reference was created.
*/
@ApiMember(DataType="datetime", Description="Will show when the reference was created.")
public Date Created = null;
/**
* Will show who created the reference.
*/
@ApiMember(DataType="datetime", Description="Will show who created the reference.")
public String CreatedBy = null;
/**
* Will show who update the reference.
*/
@ApiMember(DataType="datetime", Description="Will show who update the reference.")
public String UpdatedBy = null;
public ResponseStatus ResponseStatus = null;
public UUID getCompanyId() { return CompanyId; }
public ReferenceQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
public UUID getId() { return Id; }
public ReferenceQueryResponse setId(UUID value) { this.Id = value; return this; }
public UUID getOwnerId() { return OwnerId; }
public ReferenceQueryResponse setOwnerId(UUID value) { this.OwnerId = value; return this; }
public String getReferenceType() { return ReferenceType; }
public ReferenceQueryResponse setReferenceType(String value) { this.ReferenceType = value; return this; }
public String getExternalData() { return ExternalData; }
public ReferenceQueryResponse setExternalData(String value) { this.ExternalData = value; return this; }
public Date getUpdated() { return Updated; }
public ReferenceQueryResponse setUpdated(Date value) { this.Updated = value; return this; }
public Date getCreated() { return Created; }
public ReferenceQueryResponse setCreated(Date value) { this.Created = value; return this; }
public String getCreatedBy() { return CreatedBy; }
public ReferenceQueryResponse setCreatedBy(String value) { this.CreatedBy = value; return this; }
public String getUpdatedBy() { return UpdatedBy; }
public ReferenceQueryResponse setUpdatedBy(String value) { this.UpdatedBy = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public ReferenceQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
@DataContract
public static class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<AccessKeyTypeResponse> Results = null;
@DataMember(Order=4)
public HashMap<String,String> Meta = null;
@DataMember(Order=5)
public ResponseStatus ResponseStatus = null;
public Integer getOffset() { return Offset; }
public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AccessKeyTypeResponse
{
public Integer Id = null;
public String KeyType = null;
public String Description = null;
public Integer getId() { return Id; }
public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getKeyType() { return KeyType; }
public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
public String getDescription() { return Description; }
public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /references HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfReferenceQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<d2p1:ReferenceQueryResponse>
<d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:CreatedBy>String</d2p1:CreatedBy>
<d2p1:ExternalData>String</d2p1:ExternalData>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:OwnerId>00000000-0000-0000-0000-000000000000</d2p1:OwnerId>
<d2p1:ReferenceType>String</d2p1:ReferenceType>
<d2p1:ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</d2p1:ResponseStatus>
<d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
<d2p1:UpdatedBy>String</d2p1:UpdatedBy>
</d2p1:ReferenceQueryResponse>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfReferenceQueryResponseWg5EthtI>