| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/log | Search the newsletter log for any messages | Search the newsletter log for any messages. |
|---|
// @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 NewsletterLogQueryResponse
{
/** @description The message log id */
// @ApiMember(Description="The message log id")
public Id: number;
/** @description The message receiver. Either a email or a mobile phone number. */
// @ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
public Receiver: string;
/** @description Nessage Title. */
// @ApiMember(Description="Nessage Title.")
public MessageTitle: string;
/** @description Nessage Body. */
// @ApiMember(Description="Nessage Body.")
public MessageBody: string;
/** @description When message was created. */
// @ApiMember(Description="When message was created.")
public Created: string;
/** @description When the message will be sent. */
// @ApiMember(Description="When the message will be sent.")
public ToSendDate: string;
/** @description When the message was sent. */
// @ApiMember(Description="When the message was sent.")
public SentDate?: string;
/** @description If Message is sent */
// @ApiMember(Description="If Message is sent")
public Sent: boolean;
/** @description Number of retries to send the message */
// @ApiMember(Description="Number of retries to send the message")
public MessageRetries: number;
/** @description Send Method. 1 = Email, 2 = SMS */
// @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
public SendMethodId: number;
public constructor(init?: Partial<NewsletterLogQueryResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class NewsletterLog extends BaseModel implements IMessageLog
{
public NewslettersId?: number;
// @Required()
public SenderName: string;
public ModifiedDate?: string;
public CorrelationId?: string;
// @Required()
public CompanyId: string;
public Id: number;
// @Required()
public SendMethodId: number;
// @Required()
public Receiver: string;
// @Required()
public Sender: string;
public MessageTitle: string;
// @Required()
public MessageBody: string;
// @Required()
public Sent: boolean;
// @Required()
public ToSendDate: string;
public SentDate?: string;
public MessageCount?: number;
public SMSStatus?: number;
// @Required()
public MessageRetries: number;
public CreatedBy: string;
// @Required()
public Created: string;
public StorageUrl: string;
public constructor(init?: Partial<NewsletterLog>) { super(init); (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class NewsletterLogQuery extends QueryDb<NewsletterLog, NewsletterLogQueryResponse> 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.", ParameterType="path")
public CompanyId?: string;
/** @description If you want to search on sent messages */
// @ApiMember(DataType="boolean", Description="If you want to search on sent messages", ParameterType="query")
public Sent?: boolean;
/** @description Message Id */
// @ApiMember(DataType="int", Description="Message Id", ParameterType="query")
public Id?: number;
/** @description If you want to search on a messages for a specific receiver */
// @ApiMember(DataType="string", Description="If you want to search on a messages for a specific receiver", ParameterType="query")
public Receiver: string;
/** @description If you want to search on a messages created a specific date */
// @ApiMember(DataType="datetime", Description="If you want to search on a messages created a specific date", ParameterType="query")
public Created?: string;
/** @description If you want to search on a messages sent a specific date */
// @ApiMember(DataType="datetime", Description="If you want to search on a messages sent a specific date", ParameterType="query")
public SentDate?: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<NewsletterLogQuery>) { 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 NewsletterLogQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /newsletter/log HTTP/1.1 Host: api.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Receiver":"String","MessageTitle":"String","MessageBody":"String","SentDate":"0001-01-01T00:00:00","Sent":false,"MessageRetries":0,"SendMethodId":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}