BokaMera.API.Host

<back to all web services

DeleteMessageTemplate

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/messages/templates/{Id}Delete an existing company message templatesDelete an existing 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 DeleteMessageTemplate {
    /** @param {{CompanyId?:string,Id?: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 template id. */
    Id;
}

JavaScript DeleteMessageTemplate DTOs

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.

DELETE /messages/templates/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	]
}