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}
import Foundation
import ServiceStack

/**
* Get a list of UOM codes (Unit of Measure)
*/
// @Api(Description="Get a list of UOM codes (Unit of Measure)")
public class GetUOMCodeList : Codable
{
    /**
    * ApplianceId to narrow the UOM Code list down to relevant ones for the appliance.
    */
    // @ApiMember(DataType="Guid", Description="ApplianceId to narrow the UOM Code list down to relevant ones for the appliance.", Name="ApplianceId", ParameterType="query")
    public var applianceId:String

    required public init(){}
}

// @ApiResponse(Description="List of UOM codes (Unit of Measure)")
public class GetUOMCodeListResponse : Codable
{
    public var uomCodes:[UOMModel]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class UOMModel : Codable
{
    public var code:String
    public var name:String
    public var Description:String
    public var symbol:String

    required public init(){}
}


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

{"ApplianceId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}