Framework API

GetRmsUIData

Retrieves Updated RMS and UI data to be saved to Framework

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @ApiResponse(Description="Eros RMS and UI Data for synching to Framework")
class GetRmsUIDataResponse implements IConvertible
{
    /**
    * Bin Row Version of the last update
    */
    // @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    Uint8List? BinRowVersion;

    /**
    * XML string containing the Framework Data
    */
    // @ApiMember(DataType="string", Description="XML string containing the Framework Data", Name="FrameworkData")
    String? FrameworkData;

    ResponseStatus? ResponseStatus;

    GetRmsUIDataResponse({this.BinRowVersion,this.FrameworkData,this.ResponseStatus});
    GetRmsUIDataResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

/**
* Retrieves Updated RMS and UI data to be saved to Framework
*/
// @Api(Description="Retrieves Updated RMS and UI data to be saved to Framework")
class GetRmsUIData implements ISubscription, IConvertible
{
    /**
    * Bin Row Version of the last update
    */
    // @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    Uint8List? BinRowVersion;

    /**
    * Suite Data Source Instance Id to determine which licensees data to retrieve.
    */
    // @ApiMember(DataType="Guid", Description="Suite Data Source Instance Id to determine which licensees data to retrieve.", Name="SuiteDataSourceInstanceId")
    String? SuiteDataSourceInstanceId;

    bool? IgnoreValidation;

    GetRmsUIData({this.BinRowVersion,this.SuiteDataSourceInstanceId,this.IgnoreValidation});
    GetRmsUIData.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'BinRowVersion': JsonConverters.toJson(BinRowVersion,'Uint8List',context!),
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'IgnoreValidation': IgnoreValidation
    };

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

TypeContext _ctx = TypeContext(library: 'gatewayframeworkapi.pstpf.com.au', types: <String, TypeInfo> {
    'GetRmsUIDataResponse': TypeInfo(TypeOf.Class, create:() => GetRmsUIDataResponse()),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
    'GetRmsUIData': TypeInfo(TypeOf.Class, create:() => GetRmsUIData()),
});

Dart GetRmsUIData DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetRmsUIData HTTP/1.1 
Host: gatewayframeworkapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"BinRowVersion":"AA==","IgnoreValidation":true}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BinRowVersion":"AA==","FrameworkData":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}