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 '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

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