BokaMera.API.Host

<back to all web services

UpdateMessageTemplate

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/messages/templates/{Id}Updates an existing company message templatesUpdate an existing 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
{
    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; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class UpdateMessageTemplate
        : ICompany
    {
        public UpdateMessageTemplate()
        {
            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 template id.
        ///</summary>
        [ApiMember(Description="The message template id.", IsRequired=true, ParameterType="path")]
        public virtual int Id { get; set; }

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

        ///<summary>
        ///The message should be default and the one to be used. All other messages for the same message type will be set to Default = false
        ///</summary>
        [ApiMember(Description="The message should be default and the one to be used. All other messages for the same message type will be set to Default = false")]
        public virtual bool? Default { 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>
        ///Message template lanugage
        ///</summary>
        [ApiMember(Description="Message template lanugage", IsRequired=true)]
        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; }
    }

}

C# UpdateMessageTemplate DTOs

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

HTTP + CSV

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

PUT /messages/templates/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"TypeId":0,"Default":false,"Name":"String","Title":"String","Body":"String","Sender":"String","Language":"String","Services":[0]}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]}