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.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class UpdateMessageTemplate : ICompany
{
    /**
    * 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.")
    var CompanyId:UUID? = null

    /**
    * The message template id.
    */
    @ApiMember(Description="The message template id.", IsRequired=true, ParameterType="path")
    var Id:Int? = null

    /**
    * The message type id. See GET /messages/templates/types 
    */
    @ApiMember(Description="The message type id. See GET /messages/templates/types ")
    var TypeId:Int? = null

    /**
    * 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
    */
    @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")
    var Default:Boolean? = null

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

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

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

    /**
    * 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).")
    var Sender:String? = null

    /**
    * Message template lanugage
    */
    @ApiMember(Description="Message template lanugage", IsRequired=true)
    var Language:String? = null

    /**
    * 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.")
    var Services:ArrayList<Int>? = null
}

open class MessageTemplatesQueryResponse
{
    /**
    * The message template id
    */
    @ApiMember(Description="The message template id")
    var Id:Int? = null

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

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

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

    /**
    * 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).")
    var Sender:String? = null

    /**
    * If the message template is the default message currently in use.
    */
    @ApiMember(Description="If the message template is the default message currently in use.")
    var Default:Boolean? = null

    /**
    * If the message type information.
    */
    @ApiMember(Description="If the message type information.")
    var MessageType:MessageTypeQueryResponse? = null

    /**
    * Template language.
    */
    @ApiMember(Description="Template language.")
    var Language:String? = null

    /**
    * 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.")
    var Services:ArrayList<MessageServices> = ArrayList<MessageServices>()
}

open class MessageTypeQueryResponse
{
    /**
    * The message type id
    */
    @ApiMember(Description="The message type id")
    var Id:Int? = null

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

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

    /**
    * 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.")
    var MaxCharacters:Int? = null

    /**
    * 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.")
    var DefaultText:String? = null

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

open class MessageServices
{
    var Id:Int? = null
    /**
    * Name of the service
    */
    @ApiMember(Description="Name of the service")
    var Name:String? = null

    /**
    * The image url of the service
    */
    @ApiMember(Description="The image url of the service")
    var ImageUrl:Uri? = null
}

Kotlin 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"}]}