BokaMera.API.Host

NewsletterTemplatesQuery

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

The following routes are available for this service:
GET	/newsletter/templates	Get company newsletter templates	Get all company newsletter templates.

**NewsletterTemplatesQuery** 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	int?	No	The newsletter template id.
IncludeSendMethodInformation	query	boolean	No	If you want to include the message send method information
IncludeEmailTemplateInformation	query	boolean	No	If you want to include the email template information

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

**NewsletterTemplate** Parameters:
Name	Parameter	Data Type	Required
SendMethod	form	SendMethod	No
EmailTemplate	form	EmailTemplate	No
CompanyId	form	Guid	Yes
Id	form	int	No
Heading	form	string	Yes
Body	form	string	Yes
ImageUrl	form	string	No
SendMethodId	form	int	Yes
EmailTemplateId	form	int?	No
Created	form	DateTime	Yes
ModifiedDate	form	DateTimeOffset?	No

**SendMethod** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
Description	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

**EmailTemplate** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
Description	form	string	Yes
Body	form	string	Yes
Type	form	int	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

**NewsletterTemplatesQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The newsletter template id
Heading	form	string	No	The newsletter template heading.
Body	form	string	No	The newsletter template body.
EmailTemplateId	form	int?	No	The email template the newsletter uses.
SendMethodId	form	int	No	Send Method. 1 = Email, 2 = SMS
ImageUrl	form	string	No	The newsletter template image url.
Created	form	DateTime	No	The newsletter created date.
SendMethodInformation	form	NewsletterSendMethodQueryResponse	No	Send method information.
EmailTemplateInformation	form	NewsletterEmailTemplatesQueryResponse	No	Email template information.

**NewsletterSendMethodQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The send method id
Name	form	string	No	The send method name.
Description	form	string	No	The send method description.

**NewsletterEmailTemplatesQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The email template id
Name	form	string	No	The email template name.
Description	form	string	No	The email template description.
Body	form	string	No	The email template html content.

**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 /newsletter/templates HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			Heading: String,
			Body: String,
			EmailTemplateId: 0,
			SendMethodId: 0,
			ImageUrl: String,
			SendMethodInformation: 
			{
				Id: 0,
				Name: String,
				Description: String
			},
			EmailTemplateInformation: 
			{
				Id: 0,
				Name: String,
				Description: String,
				Body: String
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}