Framework API

GetRmsUIData

Retrieves Updated RMS and UI data to be saved to Framework

namespace FrameworkApi.Models

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Eros RMS and UI Data for synching to Framework")>]
    [<AllowNullLiteral>]
    type GetRmsUIDataResponse() = 
        ///<summary>
        ///Bin Row Version of the last update
        ///</summary>
        [<ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")>]
        member val BinRowVersion:Byte[] = null with get,set

        ///<summary>
        ///XML string containing the Framework Data
        ///</summary>
        [<ApiMember(DataType="string", Description="XML string containing the Framework Data", Name="FrameworkData")>]
        member val FrameworkData:String = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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")>]
    [<AllowNullLiteral>]
    type GetRmsUIData() = 
        ///<summary>
        ///Bin Row Version of the last update
        ///</summary>
        [<ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")>]
        member val BinRowVersion:Byte[] = null with 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")>]
        member val SuiteDataSourceInstanceId:Guid = new Guid() with get,set

        member val IgnoreValidation:Boolean = new Boolean() with get,set

F# GetRmsUIData DTOs

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

HTTP + JSV

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

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

{
	BinRowVersion: AA==,
	IgnoreValidation: True
}

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