Framework API

<back to all web services

GetRmsUIData

Retrieves Updated RMS and UI data to be saved to Framework

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using FrameworkApi.Models;

namespace FrameworkApi.Models
{
    ///<summary>
    ///Retrieves Updated RMS and UI data to be saved to Framework
    ///</summary>
    [Api(Description="Retrieves Updated RMS and UI data to be saved to Framework")]
    public partial class GetRmsUIData
        : ISubscription
    {
        ///<summary>
        ///Bin Row Version of the last update
        ///</summary>
        [ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")]
        public virtual byte[] BinRowVersion { get; set; }

        ///<summary>
        ///Suite Data Source Instance Id to determine which licensees data to retrieve.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Suite Data Source Instance Id to determine which licensees data to retrieve.", Name="SuiteDataSourceInstanceId")]
        public virtual Guid SuiteDataSourceInstanceId { get; set; }

        public virtual bool IgnoreValidation { get; set; }
    }

    [ApiResponse(Description="Eros RMS and UI Data for synching to Framework")]
    public partial class GetRmsUIDataResponse
    {
        ///<summary>
        ///Bin Row Version of the last update
        ///</summary>
        [ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")]
        public virtual byte[] BinRowVersion { get; set; }

        ///<summary>
        ///XML string containing the Framework Data
        ///</summary>
        [ApiMember(DataType="string", Description="XML string containing the Framework Data", Name="FrameworkData")]
        public virtual string FrameworkData { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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>