Framework API

GetRmsUIData

Retrieves Updated RMS and UI data to be saved to Framework

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

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

        /**
        * 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")
        public UUID SuiteDataSourceInstanceId = null;

        public Boolean IgnoreValidation = null;
        
        public byte[] getBinRowVersion() { return BinRowVersion; }
        public GetRmsUIData setBinRowVersion(byte[] value) { this.BinRowVersion = value; return this; }
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public GetRmsUIData setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public Boolean isIgnoreValidation() { return IgnoreValidation; }
        public GetRmsUIData setIgnoreValidation(Boolean value) { this.IgnoreValidation = value; return this; }
    }

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

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

        public ResponseStatus ResponseStatus = null;
        
        public byte[] getBinRowVersion() { return BinRowVersion; }
        public GetRmsUIDataResponse setBinRowVersion(byte[] value) { this.BinRowVersion = value; return this; }
        public String getFrameworkData() { return FrameworkData; }
        public GetRmsUIDataResponse setFrameworkData(String value) { this.FrameworkData = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetRmsUIDataResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java GetRmsUIData 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 /csv/reply/GetRmsUIData HTTP/1.1 
Host: gatewayframeworkapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}