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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GetUOMCodeList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
</GetUOMCodeList>

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

<GetUOMCodeListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <UOMCodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:UOMModel>
      <d2p1:Code>String</d2p1:Code>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Symbol>String</d2p1:Symbol>
    </d2p1:UOMModel>
  </UOMCodes>
</GetUOMCodeListResponse>