Platform API

<back to all web services

GetDimensionsList

Get a list of dimensions for a licensee, as well as any standard dimensions

Requires Authentication
The following routes are available for this service:
All Verbs/api/dimensions/
"use strict";
export class DimensionValueModel {
    /** @param {{DimensionValueId?:string,DimensionId?:string,Name?:string,Description?:string,ShortName?:string,TrafficLightId?:string,TrafficLightColour?:string,ObjectConnectionId?:string,OwnerContactId?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the dimension value. */
    DimensionValueId;
    /**
     * @type {string}
     * @description Dimension Id this value is for. */
    DimensionId;
    /**
     * @type {string}
     * @description Name of the dimension value. */
    Name;
    /**
     * @type {string}
     * @description Description of the dimension value. */
    Description;
    /**
     * @type {string}
     * @description Short Name for the dimension value. */
    ShortName;
    /**
     * @type {string}
     * @description Id of the colour associated. */
    TrafficLightId;
    /**
     * @type {string}
     * @description Colour associated with the dimension value. */
    TrafficLightColour;
    /**
     * @type {string}
     * @description Id that links this dimension value to an object. */
    ObjectConnectionId;
    /**
     * @type {string}
     * @description Owner Id of the dimension value. */
    OwnerContactId;
    /**
     * @type {string}
     * @description Record status of the dimension value. */
    RecordStatus;
}
export class DimensionModel {
    /** @param {{DimensionId?:string,Name?:string,Description?:string,ShortName?:string,HasTrafficLightForValues?:boolean,HasImage?:boolean,OwnerContactId?:string,RecordStatus?:string,DimensionValues?:DimensionValueModel[],ObjectConnectionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of the Dimension itself. */
    DimensionId;
    /**
     * @type {string}
     * @description Dimension name. */
    Name;
    /**
     * @type {string}
     * @description Dimension description. */
    Description;
    /**
     * @type {string}
     * @description Dimension shortened name. */
    ShortName;
    /**
     * @type {boolean}
     * @description True if the values for the dimension should have colours associated with them. */
    HasTrafficLightForValues;
    /** @type {boolean} */
    HasImage;
    /**
     * @type {string}
     * @description Owner Id of the dimension. */
    OwnerContactId;
    /**
     * @type {string}
     * @description Record status of the dimension. */
    RecordStatus;
    /**
     * @type {DimensionValueModel[]}
     * @description Dimension values for this dimension. */
    DimensionValues;
    /**
     * @type {string}
     * @description Id that links this dimension to an object. */
    ObjectConnectionId;
}
export class GetDimensionsListResponse {
    /** @param {{Dimensions?:DimensionModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {DimensionModel[]}
     * @description List of dimensions. */
    Dimensions;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetDimensionsList {
    /** @param {{LicenseeId?:string,RecordStatus?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Licensee Id to retrieve dimensions for. */
    LicenseeId;
    /**
     * @type {string}
     * @description RecordStatus of dimensions to retrieve. If not set 'A' active dimensions are retrieved. */
    RecordStatus;
}

JavaScript GetDimensionsList 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/dimensions/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"LicenseeId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}

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

{"Dimensions":[{"DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","HasTrafficLightForValues":false,"HasImage":false,"OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","DimensionValues":[{"DimensionValueId":"00000000-0000-0000-0000-000000000000","DimensionId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","ShortName":"String","TrafficLightId":"00000000-0000-0000-0000-000000000000","TrafficLightColour":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000","OwnerContactId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String"}],"ObjectConnectionId":"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"}}}