BokaMera.API.Host

CreateMessageTemplate

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

The following routes are available for this service:
POST	/messages/templates	Create a new company message templates	Create a new company message templates.

"use strict";
export class MessageTypeQueryResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,MaxCharacters?:number,DefaultText?:string,SendMethodId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The message type id */
    Id;
    /**
     * @type {string}
     * @description The message type name. */
    Name;
    /**
     * @type {string}
     * @description The message type description. */
    Description;
    /**
     * @type {number}
     * @description The maximum number of charachters that can be entered into message body using this type. */
    MaxCharacters;
    /**
     * @type {string}
     * @description The default text that is always included when sending messages of this type. */
    DefaultText;
    /**
     * @type {number}
     * @description The send method for this type. 1 = Email, 2 = SMS. */
    SendMethodId;
}
export class MessageServices {
    /** @param {{Id?:number,Name?:string,ImageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /**
     * @type {string}
     * @description Name of the service */
    Name;
    /**
     * @type {string}
     * @description The image url of the service */
    ImageUrl;
}
export class MessageTemplatesQueryResponse {
    /** @param {{Id?:number,Name?:string,Title?:string,Body?:string,Sender?:string,Default?:boolean,MessageType?:MessageTypeQueryResponse,Language?:string,Services?:MessageServices[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The message template id */
    Id;
    /**
     * @type {string}
     * @description The message template name. */
    Name;
    /**
     * @type {string}
     * @description The message template title. */
    Title;
    /**
     * @type {string}
     * @description The message template title. */
    Body;
    /**
     * @type {string}
     * @description The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set). */
    Sender;
    /**
     * @type {boolean}
     * @description If the message template is the default message currently in use. */
    Default;
    /**
     * @type {MessageTypeQueryResponse}
     * @description If the message type information. */
    MessageType;
    /**
     * @type {string}
     * @description Template language. */
    Language;
    /**
     * @type {MessageServices[]}
     * @description The connected services which the template is valid for. If empty then it's valid for all services. */
    Services;
}
export class CreateMessageTemplate {
    /** @param {{CompanyId?:string,TypeId?:number,Name?:string,Title?:string,Body?:string,Sender?:string,Language?:string,Services?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {number}
     * @description The message type id. See GET /messages/templates/types  */
    TypeId;
    /**
     * @type {string}
     * @description The message template name. */
    Name;
    /**
     * @type {string}
     * @description The message template title. */
    Title;
    /**
     * @type {string}
     * @description The message template title. */
    Body;
    /**
     * @type {string}
     * @description The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set). */
    Sender;
    /**
     * @type {string}
     * @description Template Language sv / en */
    Language;
    /**
     * @type {number[]}
     * @description The services that is connected to the template. If null it will be connected to all services. */
    Services;
}

JavaScript CreateMessageTemplate DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /messages/templates HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","TypeId":0,"Name":"String","Title":"String","Body":"String","Sender":"String","Language":"String","Services":[0]}

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

{"Id":0,"Name":"String","Title":"String","Body":"String","Sender":"String","Default":false,"MessageType":{"Id":0,"Name":"String","Description":"String","MaxCharacters":0,"DefaultText":"String","SendMethodId":0},"Language":"String","Services":[{"Id":0,"Name":"String"}]}