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	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

**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	No	The message type name.
Description	form	string	No	The message type description.
MaxCharacters	form	int	No	The maximum number of charachters that can be entered into message body using this type.
DefaultText	form	string	No	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<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 .jsv suffix or ?format=jsv

HTTP + JSV

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.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}