BokaMera.API.Host

TagQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/tags	Get tags for the company	Returns tags for the current company, optionally filtered by scope and active status.

**TagQuery** 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.
Scope	query	TagScope?	No	Filter by tag scope. 0 = Booking, 1 = Customer.
Active	query	bool?	No	Filter by active status. If not provided, only active tags are returned.
Skip	query	int?	No	Number of records to skip
Take	query	int?	No	Number of records to take
OrderBy	query	string	Yes	Sort field

**TagScope** Enum:
Booking
Customer

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

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

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /tags HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Scope":0,"Color":"String","SortOrder":0,"Active":false,"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"}}}