| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /newsletter/templates | Create a new company newsletter template. | Create a new company newsletter template. |
|---|
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 CreateNewsletterTemplate : 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 newsletter template heading.
*/
@ApiMember(Description="The newsletter template heading.")
var Heading:String? = null
/**
* The newsletter template body.
*/
@ApiMember(Description="The newsletter template body.")
var Body:String? = null
/**
* The newsletter template image url.
*/
@ApiMember(Description="The newsletter template image url.")
var ImageUrl:String? = null
/**
* The newsletter template send method (1=email, 2=sms).
*/
@ApiMember(Description="The newsletter template send method (1=email, 2=sms).")
var SendMethodId:Int? = null
/**
* 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")
var EmailTemplateId:Int? = null
}
open class NewsletterTemplatesQueryResponse
{
/**
* The newsletter template id
*/
@ApiMember(Description="The newsletter template id")
var Id:Int? = null
/**
* The newsletter template heading.
*/
@ApiMember(Description="The newsletter template heading.")
var Heading:String? = null
/**
* The newsletter template body.
*/
@ApiMember(Description="The newsletter template body.")
var Body:String? = null
/**
* The email template the newsletter uses.
*/
@ApiMember(Description="The email template the newsletter uses.")
var EmailTemplateId:Int? = null
/**
* Send Method. 1 = Email, 2 = SMS
*/
@ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
var SendMethodId:Int? = null
/**
* The newsletter template image url.
*/
@ApiMember(Description="The newsletter template image url.")
var ImageUrl:String? = null
/**
* The newsletter created date.
*/
@ApiMember(Description="The newsletter created date.")
var Created:Date? = null
/**
* Send method information.
*/
@ApiMember(Description="Send method information.")
var SendMethodInformation:NewsletterSendMethodQueryResponse? = null
/**
* Email template information.
*/
@ApiMember(Description="Email template information.")
var EmailTemplateInformation:NewsletterEmailTemplatesQueryResponse? = null
}
open class NewsletterSendMethodQueryResponse
{
/**
* The send method id
*/
@ApiMember(Description="The send method id")
var Id:Int? = null
/**
* The send method name.
*/
@ApiMember(Description="The send method name.")
var Name:String? = null
/**
* The send method description.
*/
@ApiMember(Description="The send method description.")
var Description:String? = null
}
open class NewsletterEmailTemplatesQueryResponse
{
/**
* The email template id
*/
@ApiMember(Description="The email template id")
var Id:Int? = null
/**
* The email template name.
*/
@ApiMember(Description="The email template name.")
var Name:String? = null
/**
* The email template description.
*/
@ApiMember(Description="The email template description.")
var Description:String? = null
/**
* The email template html content.
*/
@ApiMember(Description="The email template html content.")
var Body:String? = null
}
Kotlin CreateNewsletterTemplate 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.
POST /newsletter/templates HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
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
}
}