| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| DELETE | /messages/templates/{Id} | Delete an existing company message templates | Delete an existing company message templates. |
|---|
import Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class DeleteMessageTemplate : 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 template id.
*/
// @ApiMember(Description="The message template id.", IsRequired=true, ParameterType="path")
public var id: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 DeleteMessageTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}