Platform API

GetUOMCodeList

Get a list of UOM codes (Unit of Measure)

The following routes are available for this service:
All Verbs	/api/unitofmeasures/
All Verbs	/api/unitofmeasures/{ApplianceId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get a list of UOM codes (Unit of Measure)
*/
@Api(Description="Get a list of UOM codes (Unit of Measure)")
open class GetUOMCodeList
{
    /**
    * 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")
    open var ApplianceId:UUID? = null
}

@ApiResponse(Description="List of UOM codes (Unit of Measure)")
open class GetUOMCodeListResponse
{
    open var UOMCodes:ArrayList<UOMModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class UOMModel
{
    open var Code:String? = null
    open var Name:String? = null
    open var Description:String? = null
    open var Symbol:String? = null
}

Kotlin 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"}}}