Platform API

<back to all web services

GetUOMCodeList

Get a list of UOM codes (Unit of Measure)

Requires Authentication
The following routes are available for this service:
All Verbs/api/unitofmeasures/
All Verbs/api/unitofmeasures/{ApplianceId}
"use strict";
export class UOMModel {
    /** @param {{Code?:string,Name?:string,Description?:string,Symbol?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    Symbol;
}
export class GetUOMCodeListResponse {
    /** @param {{UOMCodes?:UOMModel[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {UOMModel[]} */
    UOMCodes;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetUOMCodeList {
    /** @param {{ApplianceId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ApplianceId to narrow the UOM Code list down to relevant ones for the appliance. */
    ApplianceId;
}

JavaScript GetUOMCodeList DTOs

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

HTTP + CSV

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

POST /api/unitofmeasures/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ApplianceId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UOMCodes":[{"Code":"String","Name":"String","Description":"String","Symbol":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}