BokaMera.API.Host

<back to all web services

DeleteMessageTemplate

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/messages/templates/{Id}Delete an existing company message templatesDelete an existing company message templates.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MessageTypeQueryResponse() = 
        ///<summary>
        ///The message type id
        ///</summary>
        [<ApiMember(Description="The message type id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The message type name.
        ///</summary>
        [<ApiMember(Description="The message type name.")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The message type description.
        ///</summary>
        [<ApiMember(Description="The message type description.")>]
        member val Description:String = null with 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.")>]
        member val MaxCharacters:Int32 = new Int32() with 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.")>]
        member val DefaultText:String = null with 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.")>]
        member val SendMethodId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type MessageServices() = 
        member val Id:Int32 = new Int32() with get,set
        ///<summary>
        ///Name of the service
        ///</summary>
        [<ApiMember(Description="Name of the service")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The image url of the service
        ///</summary>
        [<ApiMember(Description="The image url of the service")>]
        member val ImageUrl:Uri = null with get,set

    [<AllowNullLiteral>]
    type MessageTemplatesQueryResponse() = 
        ///<summary>
        ///The message template id
        ///</summary>
        [<ApiMember(Description="The message template id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The message template name.
        ///</summary>
        [<ApiMember(Description="The message template name.")>]
        member val Name:String = null with get,set

        ///<summary>
        ///The message template title.
        ///</summary>
        [<ApiMember(Description="The message template title.")>]
        member val Title:String = null with get,set

        ///<summary>
        ///The message template title.
        ///</summary>
        [<ApiMember(Description="The message template title.")>]
        member val Body:String = null with 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).")>]
        member val Sender:String = null with 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.")>]
        member val Default:Boolean = new Boolean() with get,set

        ///<summary>
        ///If the message type information.
        ///</summary>
        [<ApiMember(Description="If the message type information.")>]
        member val MessageType:MessageTypeQueryResponse = null with get,set

        ///<summary>
        ///Template language.
        ///</summary>
        [<ApiMember(Description="Template language.")>]
        member val Language:String = null with 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.")>]
        member val Services:ResizeArray<MessageServices> = new ResizeArray<MessageServices>() with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type DeleteMessageTemplate() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The message template id.
        ///</summary>
        [<ApiMember(Description="The message template id.", IsRequired=true, ParameterType="path")>]
        member val Id:Int32 = new Int32() with get,set

F# DeleteMessageTemplate DTOs

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

HTTP + JSV

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

DELETE /messages/templates/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	]
}