Framework API

<back to all web services

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

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

<GetRmsUIData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FrameworkApi.Models">
  <BinRowVersion>AA==</BinRowVersion>
  <SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
</GetRmsUIData>

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

<GetRmsUIDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FrameworkApi.Models">
  <BinRowVersion>AA==</BinRowVersion>
  <FrameworkData>String</FrameworkData>
  <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>
</GetRmsUIDataResponse>