BokaMera.API.Host

MessageTypeQuery

The following routes are available for this service:
GET	/messages/templates/types	Get message types	Get all message types used by the message templates.

**MessageTypeQuery** Parameters:
Name	Parameter	Data Type	Required	Description
Id	query	int?	No	The message type id.
SendMethodId	query	int?	No	The message send method id. 1 = Email, 2 = SMS

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**MessageType** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
Description	form	string	Yes
MaxCharacters	form	int	Yes
DefaultText	form	string	Yes
SendMethodId	form	int	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

**MessageTypeQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The message type id
Name	form	string	Yes	The message type name.
Description	form	string	Yes	The message type description.
MaxCharacters	form	int	No	The maximum number of characters that can be entered into message body using this type.
DefaultText	form	string	Yes	The default text that is always included when sending messages of this type.
SendMethodId	form	int	No	The send method for this type. 1 = Email, 2 = SMS.

**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 .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 /messages/templates/types HTTP/1.1 
Host: api-staging.bookmore.com 
Accept: text/csv

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

{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","MaxCharacters":0,"DefaultText":"String","SendMethodId":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}