Platform API

<back to all web services

GetUOMCodeList

Get a list of UOM codes (Unit of Measure)

import 'package:servicestack/servicestack.dart';

class UOMModel implements IConvertible
{
    String? Code;
    String? Name;
    String? Description;
    String? Symbol;

    UOMModel({this.Code,this.Name,this.Description,this.Symbol});
    UOMModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Code = json['Code'];
        Name = json['Name'];
        Description = json['Description'];
        Symbol = json['Symbol'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Code': Code,
        'Name': Name,
        'Description': Description,
        'Symbol': Symbol
    };

    getTypeName() => "UOMModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="List of UOM codes (Unit of Measure)")
class GetUOMCodeListResponse implements IConvertible
{
    List<UOMModel>? UOMCodes;
    ResponseStatus? ResponseStatus;

    GetUOMCodeListResponse({this.UOMCodes,this.ResponseStatus});
    GetUOMCodeListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UOMCodes = JsonConverters.fromJson(json['UOMCodes'],'List<UOMModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UOMCodes': JsonConverters.toJson(UOMCodes,'List<UOMModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetUOMCodeListResponse";
    TypeContext? context = _ctx;
}

/**
* Get a list of UOM codes (Unit of Measure)
*/
// @Api(Description="Get a list of UOM codes (Unit of Measure)")
class GetUOMCodeList implements IConvertible
{
    /**
    * 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")
    String? ApplianceId;

    GetUOMCodeList({this.ApplianceId});
    GetUOMCodeList.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApplianceId = json['ApplianceId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApplianceId': ApplianceId
    };

    getTypeName() => "GetUOMCodeList";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'UOMModel': TypeInfo(TypeOf.Class, create:() => UOMModel()),
    'GetUOMCodeListResponse': TypeInfo(TypeOf.Class, create:() => GetUOMCodeListResponse()),
    'List<UOMModel>': TypeInfo(TypeOf.Class, create:() => <UOMModel>[]),
    'GetUOMCodeList': TypeInfo(TypeOf.Class, create:() => GetUOMCodeList()),
});

Dart GetUOMCodeList DTOs

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>