| GET | /references | Get all valid references | Get all valid references. |
|---|
// @DataContract
export class QueryBase
{
/** @description 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 Skip?: number;
/** @description 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 Take?: number;
/** @description 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 OrderBy: string;
/** @description 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 OrderByDesc: string;
/** @description 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 Include: string;
// @DataMember(Order=6)
public Fields: string;
// @DataMember(Order=7)
public Meta: { [index: string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<From, Into> extends QueryBase
{
public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}
export class ReferenceQueryResponse
{
/** @description The company id */
// @ApiMember(Description="The company id")
public CompanyId: string;
/** @description Id of the reference */
// @ApiMember(Description="Id of the reference")
public Id: string;
/** @description 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 OwnerId: string;
/** @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 */
// @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 ReferenceType: string;
/** @description 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 ExternalData: string;
/** @description Will show when the reference was updated. */
// @ApiMember(DataType="datetime", Description="Will show when the reference was updated.")
public Updated: string;
/** @description Will show when the reference was created. */
// @ApiMember(DataType="datetime", Description="Will show when the reference was created.")
public Created: string;
/** @description Will show who created the reference. */
// @ApiMember(DataType="datetime", Description="Will show who created the reference.")
public CreatedBy: string;
/** @description Will show who update the reference. */
// @ApiMember(DataType="datetime", Description="Will show who update the reference.")
public UpdatedBy: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<ReferenceQueryResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class ExternalReference extends BaseModel
{
// @Required()
public CompanyId: string;
// @Required()
public Id: string;
// @Required()
public OwnerId: string;
// @Required()
public ReferenceType: string;
public ExternalData: string;
public CreatedBy: string;
// @Required()
public Updated: string;
// @Required()
public Created: string;
public ModifiedDate?: string;
public constructor(init?: Partial<ExternalReference>) { super(init); (Object as any).assign(this, init); }
}
export class ReferenceQuery extends QueryDb<ExternalReference, ReferenceQueryResponse> implements ICompany
{
/** @description 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 CompanyId?: string;
/** @description Id of the reference */
// @ApiMember(Description="Id of the reference")
public Id?: string;
/** @description 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 OwnerId?: string;
/** @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 */
// @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 ReferenceType: string;
/** @description 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 ExternalData: string;
public constructor(init?: Partial<ReferenceQuery>) { super(init); (Object as any).assign(this, init); }
}
export class AccessKeyTypeResponse
{
public Id: number;
public KeyType: string;
public Description: string;
public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
// @DataMember(Order=1)
public Offset: number;
// @DataMember(Order=2)
public Total: number;
// @DataMember(Order=3)
public Results: AccessKeyTypeResponse[];
// @DataMember(Order=4)
public Meta: { [index: string]: string; };
// @DataMember(Order=5)
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}
TypeScript ReferenceQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}