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}

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Subtle.Canvara.WebAPIModel.Models

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.Models

        Public Partial Class UOMModel
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property Symbol As String
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get a list of UOM codes (Unit of Measure)
        '''</Summary>
        <Api(Description:="Get a list of UOM codes (Unit of Measure)")>
        Public Partial Class GetUOMCodeList
            '''<Summary>
            '''ApplianceId to narrow the UOM Code list down to relevant ones for the appliance.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="ApplianceId to narrow the UOM Code list down to relevant ones for the appliance.", Name:="ApplianceId", ParameterType:="query")>
            Public Overridable Property ApplianceId As Guid
        End Class

        <ApiResponse(Description:="List of UOM codes (Unit of Measure)")>
        Public Partial Class GetUOMCodeListResponse
            Public Overridable Property UOMCodes As List(Of UOMModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetUOMCodeList DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

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