| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/templates | Get company newsletter templates | Get all company newsletter templates. |
|---|
// @DataContract
export class QueryBase
{
/** @description 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)
public Skip?: number;
/** @description 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)
public Take?: number;
/** @description 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)
public OrderBy: string;
/** @description 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)
public OrderByDesc: string;
/** @description 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)
public Include: string;
// @DataMember(Order=6)
public Fields: string;
// @DataMember(Order=7)
public Meta: { [index: string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<From, Into> extends QueryBase
{
public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}
export class NewsletterSendMethodQueryResponse
{
/** @description The send method id */
// @ApiMember(Description="The send method id")
public Id: number;
/** @description The send method name. */
// @ApiMember(Description="The send method name.")
public Name: string;
/** @description The send method description. */
// @ApiMember(Description="The send method description.")
public Description: string;
public constructor(init?: Partial<NewsletterSendMethodQueryResponse>) { (Object as any).assign(this, init); }
}
export class NewsletterEmailTemplatesQueryResponse
{
/** @description The email template id */
// @ApiMember(Description="The email template id")
public Id: number;
/** @description The email template name. */
// @ApiMember(Description="The email template name.")
public Name: string;
/** @description The email template description. */
// @ApiMember(Description="The email template description.")
public Description: string;
/** @description The email template html content. */
// @ApiMember(Description="The email template html content.")
public Body: string;
public constructor(init?: Partial<NewsletterEmailTemplatesQueryResponse>) { (Object as any).assign(this, init); }
}
export class NewsletterTemplatesQueryResponse
{
/** @description The newsletter template id */
// @ApiMember(Description="The newsletter template id")
public Id: number;
/** @description The newsletter template heading. */
// @ApiMember(Description="The newsletter template heading.")
public Heading: string;
/** @description The newsletter template body. */
// @ApiMember(Description="The newsletter template body.")
public Body: string;
/** @description The email template the newsletter uses. */
// @ApiMember(Description="The email template the newsletter uses.")
public EmailTemplateId?: number;
/** @description Send Method. 1 = Email, 2 = SMS */
// @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
public SendMethodId: number;
/** @description The newsletter template image url. */
// @ApiMember(Description="The newsletter template image url.")
public ImageUrl: string;
/** @description The newsletter created date. */
// @ApiMember(Description="The newsletter created date.")
public Created: string;
/** @description Send method information. */
// @ApiMember(Description="Send method information.")
public SendMethodInformation: NewsletterSendMethodQueryResponse;
/** @description Email template information. */
// @ApiMember(Description="Email template information.")
public EmailTemplateInformation: NewsletterEmailTemplatesQueryResponse;
public constructor(init?: Partial<NewsletterTemplatesQueryResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class SendMethod extends BaseModel
{
// @Required()
public Name: string;
// @Required()
public Description: string;
public ModifiedDate?: string;
public Id: number;
public constructor(init?: Partial<SendMethod>) { super(init); (Object as any).assign(this, init); }
}
export class EmailTemplate extends BaseModel
{
// @Required()
public Name: string;
// @Required()
public Description: string;
// @Required()
public Body: string;
// @Required()
public Type: number;
public ModifiedDate?: string;
public Id: number;
public constructor(init?: Partial<EmailTemplate>) { super(init); (Object as any).assign(this, init); }
}
export class NewsletterTemplate extends BaseModel
{
public SendMethod: SendMethod;
public EmailTemplate: EmailTemplate;
// @Required()
public CompanyId: string;
public Id: number;
// @Required()
public Heading: string;
// @Required()
public Body: string;
public ImageUrl: string;
// @Required()
public SendMethodId: number;
public EmailTemplateId?: number;
// @Required()
public Created: string;
public ModifiedDate?: string;
public constructor(init?: Partial<NewsletterTemplate>) { super(init); (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class NewsletterTemplatesQuery extends QueryDb<NewsletterTemplate, NewsletterTemplatesQueryResponse> implements ICompany
{
/** @description 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 CompanyId?: string;
/** @description The newsletter template id. */
// @ApiMember(Description="The newsletter template id.")
public Id?: number;
/** @description 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")
public IncludeSendMethodInformation: boolean;
/** @description If you want to include the email template information */
// @ApiMember(DataType="boolean", Description="If you want to include the email template information", ParameterType="query")
public IncludeEmailTemplateInformation: boolean;
public constructor(init?: Partial<NewsletterTemplatesQuery>) { super(init); (Object as any).assign(this, init); }
}
export class AccessKeyTypeResponse
{
public Id: number;
public KeyType: string;
public Description: string;
public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
// @DataMember(Order=1)
public Offset: number;
// @DataMember(Order=2)
public Total: number;
// @DataMember(Order=3)
public Results: AccessKeyTypeResponse[];
// @DataMember(Order=4)
public Meta: { [index: string]: string; };
// @DataMember(Order=5)
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}
TypeScript NewsletterTemplatesQuery 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.
GET /newsletter/templates HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}