BokaMera.API.Host

<back to all web services

CreateMessageTemplate

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/messages/templatesCreate a new company message templatesCreate a new company message templates.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class CreateMessageTemplate
        : ICompany
    {
        public CreateMessageTemplate()
        {
            Services = new int[]{};
        }

        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The message type id. See GET /messages/templates/types 
        ///</summary>
        [ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)]
        public virtual int TypeId { get; set; }

        ///<summary>
        ///The message template name.
        ///</summary>
        [ApiMember(Description="The message template name.", IsRequired=true)]
        public virtual string Name { get; set; }

        ///<summary>
        ///The message template title.
        ///</summary>
        [ApiMember(Description="The message template title.", IsRequired=true)]
        public virtual string Title { get; set; }

        ///<summary>
        ///The message template title.
        ///</summary>
        [ApiMember(Description="The message template title.", IsRequired=true)]
        public virtual string Body { get; set; }

        ///<summary>
        ///The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).
        ///</summary>
        [ApiMember(Description="The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).")]
        public virtual string Sender { get; set; }

        ///<summary>
        ///Template Language sv / en
        ///</summary>
        [ApiMember(Description="Template Language sv / en")]
        public virtual string Language { get; set; }

        ///<summary>
        ///The services that is connected to the template. If null it will be connected to all services.
        ///</summary>
        [ApiMember(Description="The services that is connected to the template. If null it will be connected to all services.")]
        public virtual int[] Services { get; set; }
    }

    public partial class MessageServices
    {
        public virtual int Id { get; set; }
        ///<summary>
        ///Name of the service
        ///</summary>
        [ApiMember(Description="Name of the service")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The image url of the service
        ///</summary>
        [ApiMember(Description="The image url of the service")]
        public virtual Uri ImageUrl { get; set; }
    }

    public partial class MessageTemplatesQueryResponse
    {
        public MessageTemplatesQueryResponse()
        {
            Services = new List<MessageServices>{};
        }

        ///<summary>
        ///The message template id
        ///</summary>
        [ApiMember(Description="The message template id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The message template name.
        ///</summary>
        [ApiMember(Description="The message template name.")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The message template title.
        ///</summary>
        [ApiMember(Description="The message template title.")]
        public virtual string Title { get; set; }

        ///<summary>
        ///The message template title.
        ///</summary>
        [ApiMember(Description="The message template title.")]
        public virtual string Body { get; set; }

        ///<summary>
        ///The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).
        ///</summary>
        [ApiMember(Description="The message template sender (an email for message types with sendmethod 1, for SMS this cannot be set).")]
        public virtual string Sender { get; set; }

        ///<summary>
        ///If the message template is the default message currently in use.
        ///</summary>
        [ApiMember(Description="If the message template is the default message currently in use.")]
        public virtual bool Default { get; set; }

        ///<summary>
        ///If the message type information.
        ///</summary>
        [ApiMember(Description="If the message type information.")]
        public virtual MessageTypeQueryResponse MessageType { get; set; }

        ///<summary>
        ///Template language.
        ///</summary>
        [ApiMember(Description="Template language.")]
        public virtual string Language { get; set; }

        ///<summary>
        ///The connected services which the template is valid for. If empty then it's valid for all services.
        ///</summary>
        [ApiMember(Description="The connected services which the template is valid for. If empty then it's valid for all services.")]
        public virtual List<MessageServices> Services { get; set; }
    }

    public partial class MessageTypeQueryResponse
    {
        ///<summary>
        ///The message type id
        ///</summary>
        [ApiMember(Description="The message type id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The message type name.
        ///</summary>
        [ApiMember(Description="The message type name.")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The message type description.
        ///</summary>
        [ApiMember(Description="The message type description.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The maximum number of charachters that can be entered into message body using this type.
        ///</summary>
        [ApiMember(Description="The maximum number of charachters that can be entered into message body using this type.")]
        public virtual int MaxCharacters { get; set; }

        ///<summary>
        ///The default text that is always included when sending messages of this type.
        ///</summary>
        [ApiMember(Description="The default text that is always included when sending messages of this type.")]
        public virtual string DefaultText { get; set; }

        ///<summary>
        ///The send method for this type. 1 = Email, 2 = SMS.
        ///</summary>
        [ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")]
        public virtual int SendMethodId { get; set; }
    }

}

C# CreateMessageTemplate 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 /messages/templates HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateMessageTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Body>String</Body>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Language>String</Language>
  <Name>String</Name>
  <Sender>String</Sender>
  <Services xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </Services>
  <Title>String</Title>
  <TypeId>0</TypeId>
</CreateMessageTemplate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessageTemplatesQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Body>String</Body>
  <Default>false</Default>
  <Id>0</Id>
  <Language>String</Language>
  <MessageType>
    <DefaultText>String</DefaultText>
    <Description>String</Description>
    <Id>0</Id>
    <MaxCharacters>0</MaxCharacters>
    <Name>String</Name>
    <SendMethodId>0</SendMethodId>
  </MessageType>
  <Name>String</Name>
  <Sender>String</Sender>
  <Services>
    <MessageServices>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </MessageServices>
  </Services>
  <Title>String</Title>
</MessageTemplatesQueryResponse>