| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /newsletter/templates/{Id} | Update a company newsletter template. | Update a company newsletter template. |
|---|
import Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateNewsletterTemplate : 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 newsletter template id.
*/
// @ApiMember(Description="The newsletter template id.", IsRequired=true, ParameterType="path")
public var id:Int
/**
* The newsletter template heading.
*/
// @ApiMember(Description="The newsletter template heading.")
public var heading:String
/**
* The newsletter template body.
*/
// @ApiMember(Description="The newsletter template body.")
public var body:String
/**
* The newsletter template image url.
*/
// @ApiMember(Description="The newsletter template image url.")
public var imageUrl:String
/**
* The newsletter template send method (1=email, 2=sms).
*/
// @ApiMember(Description="The newsletter template send method (1=email, 2=sms).")
public var sendMethodId:Int?
/**
* The email template id. Get valid email templates from GET /newsletter/emailtemplates
*/
// @ApiMember(Description="The email template id. Get valid email templates from GET /newsletter/emailtemplates")
public var emailTemplateId:Int?
required public init(){}
}
public class NewsletterTemplatesQueryResponse : Codable
{
/**
* The newsletter template id
*/
// @ApiMember(Description="The newsletter template id")
public var id:Int
/**
* The newsletter template heading.
*/
// @ApiMember(Description="The newsletter template heading.")
public var heading:String
/**
* The newsletter template body.
*/
// @ApiMember(Description="The newsletter template body.")
public var body:String
/**
* The email template the newsletter uses.
*/
// @ApiMember(Description="The email template the newsletter uses.")
public var emailTemplateId:Int?
/**
* Send Method. 1 = Email, 2 = SMS
*/
// @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
public var sendMethodId:Int
/**
* The newsletter template image url.
*/
// @ApiMember(Description="The newsletter template image url.")
public var imageUrl:String
/**
* The newsletter created date.
*/
// @ApiMember(Description="The newsletter created date.")
public var created:Date
/**
* Send method information.
*/
// @ApiMember(Description="Send method information.")
public var sendMethodInformation:NewsletterSendMethodQueryResponse
/**
* Email template information.
*/
// @ApiMember(Description="Email template information.")
public var emailTemplateInformation:NewsletterEmailTemplatesQueryResponse
required public init(){}
}
public class NewsletterSendMethodQueryResponse : Codable
{
/**
* The send method id
*/
// @ApiMember(Description="The send method id")
public var id:Int
/**
* The send method name.
*/
// @ApiMember(Description="The send method name.")
public var name:String
/**
* The send method description.
*/
// @ApiMember(Description="The send method description.")
public var Description:String
required public init(){}
}
public class NewsletterEmailTemplatesQueryResponse : Codable
{
/**
* The email template id
*/
// @ApiMember(Description="The email template id")
public var id:Int
/**
* The email template name.
*/
// @ApiMember(Description="The email template name.")
public var name:String
/**
* The email template description.
*/
// @ApiMember(Description="The email template description.")
public var Description:String
/**
* The email template html content.
*/
// @ApiMember(Description="The email template html content.")
public var body:String
required public init(){}
}
Swift UpdateNewsletterTemplate 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.
PUT /newsletter/templates/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Id: 0,
Heading: String,
Body: String,
ImageUrl: String,
SendMethodId: 0,
EmailTemplateId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Heading: String,
Body: String,
EmailTemplateId: 0,
SendMethodId: 0,
ImageUrl: String,
SendMethodInformation:
{
Id: 0,
Name: String,
Description: String
},
EmailTemplateInformation:
{
Id: 0,
Name: String,
Description: String,
Body: String
}
}