BokaMera.API.Host

SendNewsLetter

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

The following routes are available for this service:
POST	/newsletter/send	Send a newsletter to a customers.


export class SendNewslettersResponse
{
    /** @description The number of messages that are added into queue. */
    // @ApiMember(Description="The number of messages that are added into queue.")
    public Total: number;

    /** @description Send Method. 1 = Email, 2 = SMS */
    // @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    public SendMethodId: number;

    /** @description Message example sent (in HTML format) */
    // @ApiMember(Description="Message example sent (in HTML format)")
    public MessageExample: string;

    public constructor(init?: Partial<SendNewslettersResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class SendNewsLetter implements ICompany
{
    /** @description The newsletter template id. */
    // @ApiMember(Description="The newsletter template id.", IsRequired=true)
    public Id: number;

    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description The datetime when the newsletters should be sent. */
    // @ApiMember(Description="The datetime when the newsletters should be sent.", IsRequired=true)
    public SendDate: string;

    /** @description The customer ids to send newsletters to. */
    // @ApiMember(Description="The customer ids to send newsletters to.", IsRequired=true)
    public Customers: string[];

    public constructor(init?: Partial<SendNewsLetter>) { (Object as any).assign(this, init); }
}

TypeScript SendNewsLetter DTOs

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.

POST /newsletter/send HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendNewsLetter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Customers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Customers>
  <Id>0</Id>
  <SendDate>0001-01-01T00:00:00</SendDate>
</SendNewsLetter>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendNewslettersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <MessageExample>String</MessageExample>
  <SendMethodId>0</SendMethodId>
  <Total>0</Total>
</SendNewslettersResponse>