BokaMera.API.Host

NewsletterLogQuery

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

The following routes are available for this service:
GET	/newsletter/log	Search the newsletter log for any messages	Search the newsletter log for any messages.

**NewsletterLogQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	path	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
Sent	query	boolean	No	If you want to search on sent messages
Id	query	int	No	Message Id
Receiver	query	string	No	If you want to search on a messages for a specific receiver
Created	query	datetime	No	If you want to search on a messages created a specific date
SentDate	query	datetime	No	If you want to search on a messages sent a specific date
ResponseStatus	query	ResponseStatus	No

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

**NewsletterLog** Parameters:
Name	Parameter	Data Type	Required
NewslettersId	form	int?	No
SenderName	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
CorrelationId	form	Guid?	No
CompanyId	form	Guid	Yes
Id	form	int	No
SendMethodId	form	int	Yes
Receiver	form	string	Yes
Sender	form	string	Yes
MessageTitle	form	string	No
MessageBody	form	string	Yes
Sent	form	bool	Yes
ToSendDate	form	DateTime	Yes
SentDate	form	DateTime?	No
MessageCount	form	int?	No
SMSStatus	form	int?	No
MessageRetries	form	int	Yes
CreatedBy	form	string	No
Created	form	DateTime	Yes
StorageUrl	form	string	No

**NewsletterLogQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The message log id
Receiver	form	string	No	The message receiver. Either a email or a mobile phone number.
MessageTitle	form	string	No	Nessage Title.
MessageBody	form	string	No	Nessage Body.
Created	form	DateTime	No	When message was created.
ToSendDate	form	DateTime	No	When the message will be sent.
SentDate	form	DateTime?	No	When the message was sent.
Sent	form	bool	No	If Message is sent
MessageRetries	form	int	No	Number of retries to send the message
SendMethodId	form	int	No	Send Method. 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 .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 /newsletter/log 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":[{"Id":0,"Receiver":"String","MessageTitle":"String","MessageBody":"String","SentDate":"0001-01-01T00:00:00","Sent":false,"MessageRetries":0,"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"}}}