| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /messages/templates | Create a new company message templates | Create a new company message templates. |
|---|
export class MessageTypeQueryResponse
{
/** @description The message type id */
// @ApiMember(Description="The message type id")
public Id: number;
/** @description The message type name. */
// @ApiMember(Description="The message type name.")
public Name: string;
/** @description The message type description. */
// @ApiMember(Description="The message type description.")
public Description: string;
/** @description The maximum number of charachters that can be entered into message body using this type. */
// @ApiMember(Description="The maximum number of charachters that can be entered into message body using this type.")
public MaxCharacters: number;
/** @description The default text that is always included when sending messages of this type. */
// @ApiMember(Description="The default text that is always included when sending messages of this type.")
public DefaultText: string;
/** @description The send method for this type. 1 = Email, 2 = SMS. */
// @ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")
public SendMethodId: number;
public constructor(init?: Partial<MessageTypeQueryResponse>) { (Object as any).assign(this, init); }
}
export class MessageServices
{
public Id: number;
/** @description Name of the service */
// @ApiMember(Description="Name of the service")
public Name: string;
/** @description The image url of the service */
// @ApiMember(Description="The image url of the service")
public ImageUrl: string;
public constructor(init?: Partial<MessageServices>) { (Object as any).assign(this, init); }
}
export class MessageTemplatesQueryResponse
{
/** @description The message template id */
// @ApiMember(Description="The message template id")
public Id: number;
/** @description The message template name. */
// @ApiMember(Description="The message template name.")
public Name: string;
/** @description The message template title. */
// @ApiMember(Description="The message template title.")
public Title: string;
/** @description The message template title. */
// @ApiMember(Description="The message template title.")
public Body: string;
/** @description The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set). */
// @ApiMember(Description="The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).")
public Sender: string;
/** @description If the message template is the default message currently in use. */
// @ApiMember(Description="If the message template is the default message currently in use.")
public Default: boolean;
/** @description If the message type information. */
// @ApiMember(Description="If the message type information.")
public MessageType: MessageTypeQueryResponse;
/** @description Template language. */
// @ApiMember(Description="Template language.")
public Language: string;
/** @description The connected services which the template is valid for. If empty then it's valid for all services. */
// @ApiMember(Description="The connected services which the template is valid for. If empty then it's valid for all services.")
public Services: MessageServices[];
public constructor(init?: Partial<MessageTemplatesQueryResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateMessageTemplate implements ICompany
{
/** @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 message type id. See GET /messages/templates/types */
// @ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
public TypeId: number;
/** @description The message template name. */
// @ApiMember(Description="The message template name.", IsRequired=true)
public Name: string;
/** @description The message template title. */
// @ApiMember(Description="The message template title.", IsRequired=true)
public Title: string;
/** @description The message template title. */
// @ApiMember(Description="The message template title.", IsRequired=true)
public Body: string;
/** @description The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set). */
// @ApiMember(Description="The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).")
public Sender: string;
/** @description Template Language sv / en */
// @ApiMember(Description="Template Language sv / en")
public Language: string;
/** @description The services that is connected to the template. If null it will be connected to all services. */
// @ApiMember(Description="The services that is connected to the template. If null it will be connected to all services.")
public Services: number[];
public constructor(init?: Partial<CreateMessageTemplate>) { (Object as any).assign(this, init); }
}
TypeScript 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
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: api.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"}]}