Platform API

<back to all web services

GetDimensionsAndValues

Get a list of dimensions and their values (active) for a licensee, as well as any standard dimensions.

Requires Authentication
The following routes are available for this service:
GET/api/dimensions/includevalues

export class DimensionValueModel
{
    /** @description Id of the dimension value. */
    // @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    public DimensionValueId: string;

    /** @description Dimension Id this value is for. */
    // @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    public DimensionId: string;

    /** @description Name of the dimension value. */
    // @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    public Name: string;

    /** @description Description of the dimension value. */
    // @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    public Description: string;

    /** @description Short Name for the dimension value. */
    // @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    public ShortName: string;

    /** @description Id of the colour associated. */
    // @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    public TrafficLightId: string;

    /** @description Colour associated with the dimension value. */
    // @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    public TrafficLightColour: string;

    /** @description Id that links this dimension value to an object. */
    // @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    public ObjectConnectionId: string;

    /** @description Owner Id of the dimension value. */
    // @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    public OwnerContactId: string;

    /** @description Record status of the dimension value. */
    // @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    public RecordStatus: string;

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

export class DimensionModel
{
    /** @description Id of the Dimension itself. */
    // @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
    public DimensionId: string;

    /** @description Dimension name. */
    // @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
    public Name: string;

    /** @description Dimension description. */
    // @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
    public Description: string;

    /** @description Dimension shortened name. */
    // @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
    public ShortName: string;

    /** @description True if the values for the dimension should have colours associated with them. */
    // @ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")
    public HasTrafficLightForValues: boolean;

    /** @description  */
    // @ApiMember(DataType="bool", Description="", Name="HasImage")
    public HasImage: boolean;

    /** @description Owner Id of the dimension. */
    // @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
    public OwnerContactId: string;

    /** @description Record status of the dimension. */
    // @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
    public RecordStatus: string;

    /** @description Dimension values for this dimension. */
    // @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
    public DimensionValues: DimensionValueModel[];

    /** @description Id that links this dimension to an object. */
    // @ApiMember(Description="Id that links this dimension to an object.")
    public ObjectConnectionId: string;

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

// @ApiResponse(Description="A list of dimensions")
export class GetDimensionsListResponse
{
    /** @description List of dimensions. */
    // @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
    public Dimensions: DimensionModel[];

    public ResponseStatus: ResponseStatus;

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

/** @description Get a list of dimensions and their values (active) for a licensee, as well as any standard dimensions. */
// @Api(Description="Get a list of dimensions and their values (active) for a licensee, as well as any standard dimensions.")
export class GetDimensionsAndValues
{
    /** @description Licensee Id to retrieve dimensions for. */
    // @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")
    public LicenseeId: string;

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

TypeScript GetDimensionsAndValues DTOs

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

HTTP + OTHER

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

GET /api/dimensions/includevalues HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}