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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Subtle.Canvara.WebAPIModel.Models;

namespace Eros.Subtle.Canvara.WebAPIModel.Models
{
    public partial class UOMModel
    {
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual string Symbol { get; set; }
    }

}

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 virtual Guid ApplianceId { get; set; }
    }

    [ApiResponse(Description="List of UOM codes (Unit of Measure)")]
    public partial class GetUOMCodeListResponse
    {
        public virtual List<UOMModel> UOMCodes { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetUOMCodeList DTOs

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

HTTP + OTHER

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

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