Platform API

<back to all web services

GetDefaultTemplates

Get default notification templates

Requires Authentication
The following routes are available for this service:
All Verbs/api/defaulttemplates

export class CommunicationTemplateBodyModel
{
    public Body: string;
    public TemplateType: string;

    public constructor(init?: Partial<CommunicationTemplateBodyModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of default notification templates")
export class GetDefaultTemplatesResponse
{
    public Templates: CommunicationTemplateBodyModel[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetDefaultTemplatesResponse>) { (Object as any).assign(this, init); }
}

/** @description Get default notification templates */
// @Api(Description="Get default notification templates")
export class GetDefaultTemplates
{

    public constructor(init?: Partial<GetDefaultTemplates>) { (Object as any).assign(this, init); }
}

TypeScript GetDefaultTemplates DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/defaulttemplates HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Templates":[{"Body":"String","TemplateType":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}