BokaMera.API.Host

<back to all web services

ReferenceQuery

The following routes are available for this service:
GET/referencesGet all valid referencesGet all valid references.
ReferenceQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdqueryGuid?NoId of the reference
OwnerIdqueryGuid?NoInternal Id of the reference. Example could be the Booking Id
ReferenceTypequerystringNoThe type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
ExternalDataquerystringNoThe external data. Could be a Id or a JSON object or anything
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.

Example:
?skip=10&orderBy=Id
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma 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.

Example:
?orderBy=Id,-Age,FirstName
OrderByDescquerystringNoComma 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.

Example:
?orderByDesc=Id,-Age,FirstName
IncludequerystringNoInclude any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.

Example:
?include=COUNT(*) as Total

or multiple fields with
?include=Count(*) Total, Min(Age), AVG(Age) AverageAge

or unique with
?include=COUNT(DISTINCT LivingStatus) as UniqueStatus
FieldsformstringNo
MetaformDictionary<string, string>No
ExternalReference Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformGuidYes
OwnerIdformGuidYes
ReferenceTypeformstringYes
ExternalDataformstringNo
CreatedByformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
ReferenceQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
IdformGuidNoId of the reference
OwnerIdformGuidNoInternal Id of the reference. Example could be the Booking Id
ReferenceTypeformstringNoThe type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
ExternalDataformstringNoThe external data. Could be a Id or a JSON object or anything
UpdatedformdatetimeNoWill show when the reference was updated.
CreatedformdatetimeNoWill show when the reference was created.
CreatedByformdatetimeNoWill show who created the reference.
UpdatedByformdatetimeNoWill show who update the reference.
ResponseStatusformResponseStatusNo
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}