BokaMera.API.Host

ReferenceQuery

The following routes are available for this service:
GET	/references	Get all valid references	Get all valid references.

**ReferenceQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
Id	query	Guid?	No	Id of the reference
OwnerId	query	Guid?	No	Internal Id of the reference. Example could be the Booking Id
ReferenceType	query	string	No	The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
ExternalData	query	string	No	The external data. Could be a Id or a JSON object or anything

**QueryBase** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	query	int	No	Skip 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`
Take	query	int	No	Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: `?take=20`
OrderBy	query	string	No	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. Example: `?orderBy=Id,-Age,FirstName`
OrderByDesc	query	string	No	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. Example: `?orderByDesc=Id,-Age,FirstName`
Include	query	string	No	Include 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`
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**ExternalReference** Parameters:
Name	Parameter	Data Type	Required
CompanyId	form	Guid	Yes
Id	form	Guid	Yes
OwnerId	form	Guid	Yes
ReferenceType	form	string	Yes
ExternalData	form	string	No
CreatedBy	form	string	No
Updated	form	DateTime	Yes
Created	form	DateTime	Yes
ModifiedDate	form	DateTimeOffset?	No

**ReferenceQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company id
Id	form	Guid	No	Id of the reference
OwnerId	form	Guid	No	Internal Id of the reference. Example could be the Booking Id
ReferenceType	form	string	No	The type of reference, you can name this parameter what you like. Example could be system_bookingid where the system is the external system
ExternalData	form	string	No	The external data. Could be a Id or a JSON object or anything
Updated	form	datetime	No	Will show when the reference was updated.
Created	form	datetime	No	Will show when the reference was created.
CreatedBy	form	datetime	No	Will show who created the reference.
UpdatedBy	form	datetime	No	Will show who update the reference.
ResponseStatus	form	ResponseStatus	No

**QueryResponse<AccessKeyTypeResponse>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	No
Description	form	string	No

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

HTTP + 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"}}}