Platform API

GenerateReferenceNumber

Generate a unique reference number for the object.

The following routes are available for this service:
GET	/api/object/reference

import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Returns the generated unique reference number for the specified object")
class GenerateReferenceNumberResponse implements IConvertible
{
    String? Reference;
    ResponseStatus? ResponseStatus;

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

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

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

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

/**
* Generate a unique reference number for the object.
*/
// @Api(Description="Generate a unique reference number for the object.")
class GenerateReferenceNumber implements IConvertible
{
    /**
    * Appliance to generate object reference for.
    */
    // @ApiMember(DataType="Guid", Description="Appliance to generate object reference for.", IsRequired=true, Name="ApplianceId")
    String? ApplianceId;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'GenerateReferenceNumberResponse': TypeInfo(TypeOf.Class, create:() => GenerateReferenceNumberResponse()),
    'GenerateReferenceNumber': TypeInfo(TypeOf.Class, create:() => GenerateReferenceNumber()),
});

Dart GenerateReferenceNumber 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.

GET /api/object/reference HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Reference":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}