Platform API

<back to all web services

GetTimezones

Get a list of timezones

The following routes are available for this service:
All Verbs/api/timezones
"use strict";
export class DataListItemModel {
    /** @param {{ListItemId?:string,Name?:string,ShortName?:string,PrimaryImagePath?:string,RecordStatus?:string,Order?:number,OwnerContactId?:string,ExtraValues?:Object[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Guid of the list item PKID. */
    ListItemId;
    /**
     * @type {string}
     * @description Name of the list item. */
    Name;
    /**
     * @type {string}
     * @description Short Version Name of the list item. */
    ShortName;
    /**
     * @type {string}
     * @description The primary image url */
    PrimaryImagePath;
    /**
     * @type {string}
     * @description Record Status of the List Item (A=Active, I=Inactive, D=Deleted). */
    RecordStatus;
    /**
     * @type {number}
     * @description The order (if any) of this item in the list. */
    Order;
    /**
     * @type {string}
     * @description The owner of this item. */
    OwnerContactId;
    /** @type {Object[]} */
    ExtraValues;
}
export class DataListModel {
    /** @param {{ListId?:string,Name?:string,OwnerContactId?:string,DataListItems?:DataListItemModel[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Guid of the List PKID. */
    ListId;
    /**
     * @type {string}
     * @description Name of the list. */
    Name;
    /**
     * @type {string}
     * @description The owner of this item. */
    OwnerContactId;
    /**
     * @type {DataListItemModel[]}
     * @description List Items in the list. */
    DataListItems;
}
export class GetTimezonesResponse {
    /** @param {{Timezones?:DataListModel,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DataListModel} */
    Timezones;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetTimezones {
    constructor(init) { Object.assign(this, init) }
}

JavaScript GetTimezones 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/timezones 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

{"Timezones":{"ListId":"00000000-0000-0000-0000-000000000000","Name":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","DataListItems":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","ShortName":"String","PrimaryImagePath":"String","RecordStatus":"String","Order":0,"OwnerContactId":"00000000-0000-0000-0000-000000000000","ExtraValues":[{}]}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}