| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/templates | Get company newsletter templates | Get all company newsletter templates. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class NewsletterTemplatesQuery : QueryDb<NewsletterTemplate, NewsletterTemplatesQueryResponse>(), 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.")
override var CompanyId:UUID? = null
/**
* The newsletter template id.
*/
@ApiMember(Description="The newsletter template id.")
open var Id:Int? = null
/**
* If you want to include the message send method information
*/
@ApiMember(DataType="boolean", Description="If you want to include the message send method information", ParameterType="query")
open var IncludeSendMethodInformation:Boolean? = null
/**
* If you want to include the email template information
*/
@ApiMember(DataType="boolean", Description="If you want to include the email template information", ParameterType="query")
open var IncludeEmailTemplateInformation:Boolean? = null
}
open class QueryDb<From, Into> : QueryBase()
{
}
@DataContract
open class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
@DataMember(Order=1)
open var Skip:Int? = null
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
@DataMember(Order=2)
open var Take:Int? = null
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
@DataMember(Order=3)
open var OrderBy:String? = null
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
@DataMember(Order=4)
open var OrderByDesc:String? = null
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
@DataMember(Order=5)
open var Include:String? = null
@DataMember(Order=6)
open var Fields:String? = null
@DataMember(Order=7)
open var Meta:HashMap<String,String>? = null
}
open class NewsletterTemplate : BaseModel()
{
open var SendMethod:SendMethod? = null
open var EmailTemplate:EmailTemplate? = null
@Required()
open var CompanyId:UUID? = null
open var Id:Int? = null
@Required()
open var Heading:String? = null
@Required()
open var Body:String? = null
open var ImageUrl:String? = null
@Required()
open var SendMethodId:Int? = null
open var EmailTemplateId:Int? = null
@Required()
open var Created:Date? = null
open var ModifiedDate:Date? = null
}
open class BaseModel
{
}
open class SendMethod : BaseModel()
{
@Required()
open var Name:String? = null
@Required()
open var Description:String? = null
open var ModifiedDate:Date? = null
open var Id:Int? = null
}
open class EmailTemplate : BaseModel()
{
@Required()
open var Name:String? = null
@Required()
open var Description:String? = null
@Required()
open var Body:String? = null
@Required()
open var Type:Int? = null
open var ModifiedDate:Date? = null
open var Id:Int? = null
}
open class NewsletterTemplatesQueryResponse
{
/**
* The newsletter template id
*/
@ApiMember(Description="The newsletter template id")
open var Id:Int? = null
/**
* The newsletter template heading.
*/
@ApiMember(Description="The newsletter template heading.")
open var Heading:String? = null
/**
* The newsletter template body.
*/
@ApiMember(Description="The newsletter template body.")
open var Body:String? = null
/**
* The email template the newsletter uses.
*/
@ApiMember(Description="The email template the newsletter uses.")
open var EmailTemplateId:Int? = null
/**
* Send Method. 1 = Email, 2 = SMS
*/
@ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
open var SendMethodId:Int? = null
/**
* The newsletter template image url.
*/
@ApiMember(Description="The newsletter template image url.")
open var ImageUrl:String? = null
/**
* The newsletter created date.
*/
@ApiMember(Description="The newsletter created date.")
open var Created:Date? = null
/**
* Send method information.
*/
@ApiMember(Description="Send method information.")
open var SendMethodInformation:NewsletterSendMethodQueryResponse? = null
/**
* Email template information.
*/
@ApiMember(Description="Email template information.")
open var EmailTemplateInformation:NewsletterEmailTemplatesQueryResponse? = null
}
open class NewsletterSendMethodQueryResponse
{
/**
* The send method id
*/
@ApiMember(Description="The send method id")
open var Id:Int? = null
/**
* The send method name.
*/
@ApiMember(Description="The send method name.")
open var Name:String? = null
/**
* The send method description.
*/
@ApiMember(Description="The send method description.")
open var Description:String? = null
}
open class NewsletterEmailTemplatesQueryResponse
{
/**
* The email template id
*/
@ApiMember(Description="The email template id")
open var Id:Int? = null
/**
* The email template name.
*/
@ApiMember(Description="The email template name.")
open var Name:String? = null
/**
* The email template description.
*/
@ApiMember(Description="The email template description.")
open var Description:String? = null
/**
* The email template html content.
*/
@ApiMember(Description="The email template html content.")
open var Body:String? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var Offset:Int? = null
@DataMember(Order=2)
open var Total:Int? = null
@DataMember(Order=3)
open var Results:ArrayList<AccessKeyTypeResponse>? = null
@DataMember(Order=4)
open var Meta:HashMap<String,String>? = null
@DataMember(Order=5)
open var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
open var Id:Int? = null
open var KeyType:String? = null
open var Description:String? = null
}
Kotlin NewsletterTemplatesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /newsletter/templates HTTP/1.1 Host: api.bookmore.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"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"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}