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.
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class CreateMessageTemplate : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * The message type id. See GET /messages/templates/types 
    */
    // @ApiMember(Description="The message type id. See GET /messages/templates/types ", IsRequired=true)
    public var typeId:Int

    /**
    * The message template name.
    */
    // @ApiMember(Description="The message template name.", IsRequired=true)
    public var name:String

    /**
    * The message template title.
    */
    // @ApiMember(Description="The message template title.", IsRequired=true)
    public var title:String

    /**
    * The message template title.
    */
    // @ApiMember(Description="The message template title.", IsRequired=true)
    public var body:String

    /**
    * 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 var sender:String

    /**
    * Template Language sv / en
    */
    // @ApiMember(Description="Template Language sv / en")
    public var language:String

    /**
    * 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 var services:[Int] = []

    required public init(){}
}

public class MessageTemplatesQueryResponse : Codable
{
    /**
    * The message template id
    */
    // @ApiMember(Description="The message template id")
    public var id:Int

    /**
    * The message template name.
    */
    // @ApiMember(Description="The message template name.")
    public var name:String

    /**
    * The message template title.
    */
    // @ApiMember(Description="The message template title.")
    public var title:String

    /**
    * The message template title.
    */
    // @ApiMember(Description="The message template title.")
    public var body:String

    /**
    * 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 var sender:String

    /**
    * 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 var `default`:Bool

    /**
    * If the message type information.
    */
    // @ApiMember(Description="If the message type information.")
    public var messageType:MessageTypeQueryResponse

    /**
    * Template language.
    */
    // @ApiMember(Description="Template language.")
    public var language:String

    /**
    * 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 var services:[MessageServices] = []

    required public init(){}
}

public class MessageTypeQueryResponse : Codable
{
    /**
    * The message type id
    */
    // @ApiMember(Description="The message type id")
    public var id:Int

    /**
    * The message type name.
    */
    // @ApiMember(Description="The message type name.")
    public var name:String

    /**
    * The message type description.
    */
    // @ApiMember(Description="The message type description.")
    public var Description:String

    /**
    * 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 var maxCharacters:Int

    /**
    * 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 var defaultText:String

    /**
    * The send method for this type. 1 = Email, 2 = SMS.
    */
    // @ApiMember(Description="The send method for this type. 1 = Email, 2 = SMS.")
    public var sendMethodId:Int

    required public init(){}
}

public class MessageServices : Codable
{
    public var id:Int
    /**
    * Name of the service
    */
    // @ApiMember(Description="Name of the service")
    public var name:String

    /**
    * The image url of the service
    */
    // @ApiMember(Description="The image url of the service")
    public var imageUrl:Uri

    required public init(){}
}


Swift 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>