BokaMera.API.Host

<back to all web services

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/logSearch the newsletter log for any messagesSearch the newsletter log for any messages.
NewsletterLogQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdpathGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
SentquerybooleanNoIf you want to search on sent messages
IdqueryintNoMessage Id
ReceiverquerystringNoIf you want to search on a messages for a specific receiver
CreatedquerydatetimeNoIf you want to search on a messages created a specific date
SentDatequerydatetimeNoIf you want to search on a messages sent a specific date
ResponseStatusqueryResponseStatusNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip 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
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma 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
OrderByDescquerystringNoComma 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
IncludequerystringNoInclude 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
FieldsformstringNo
MetaformDictionary<string, string>No
NewsletterLog Parameters:
NameParameterData TypeRequiredDescription
NewslettersIdformint?No
SenderNameformstringYes
ModifiedDateformDateTimeOffset?No
CorrelationIdformGuid?No
CompanyIdformGuidYes
IdformintNo
SendMethodIdformintYes
ReceiverformstringYes
SenderformstringYes
MessageTitleformstringNo
MessageBodyformstringYes
SentformboolYes
ToSendDateformDateTimeYes
SentDateformDateTime?No
MessageCountformint?No
SMSStatusformint?No
MessageRetriesformintYes
CreatedByformstringNo
CreatedformDateTimeYes
StorageUrlformstringNo
NewsletterLogQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe message log id
ReceiverformstringNoThe message receiver. Either a email or a mobile phone number.
MessageTitleformstringNoNessage Title.
MessageBodyformstringNoNessage Body.
CreatedformDateTimeNoWhen message was created.
ToSendDateformDateTimeNoWhen the message will be sent.
SentDateformDateTime?NoWhen the message was sent.
SentformboolNoIf Message is sent
MessageRetriesformintNoNumber of retries to send the message
SendMethodIdformintNoSend Method. 1 = Email, 2 = SMS
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfNewsletterLogQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:NewsletterLogQueryResponse>
      <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:MessageBody>String</d2p1:MessageBody>
      <d2p1:MessageRetries>0</d2p1:MessageRetries>
      <d2p1:MessageTitle>String</d2p1:MessageTitle>
      <d2p1:Receiver>String</d2p1:Receiver>
      <d2p1:SendMethodId>0</d2p1:SendMethodId>
      <d2p1:Sent>false</d2p1:Sent>
      <d2p1:SentDate>0001-01-01T00:00:00</d2p1:SentDate>
      <d2p1:ToSendDate>0001-01-01T00:00:00</d2p1:ToSendDate>
    </d2p1:NewsletterLogQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfNewsletterLogQueryResponseWg5EthtI>