Framework API

GetRmsUIData

Retrieves Updated RMS and UI data to be saved to Framework

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @ApiResponse(Description="Eros RMS and UI Data for synching to Framework")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRmsUIDataResponse:
    # @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    bin_row_version: Optional[bytes] = None
    """
    Bin Row Version of the last update
    """


    # @ApiMember(DataType="string", Description="XML string containing the Framework Data", Name="FrameworkData")
    framework_data: Optional[str] = None
    """
    XML string containing the Framework Data
    """


    response_status: Optional[ResponseStatus] = None


# @Api(Description="Retrieves Updated RMS and UI data to be saved to Framework")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRmsUIData(ISubscription):
    """
    Retrieves Updated RMS and UI data to be saved to Framework
    """

    # @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    bin_row_version: Optional[bytes] = None
    """
    Bin Row Version of the last update
    """


    # @ApiMember(DataType="Guid", Description="Suite Data Source Instance Id to determine which licensees data to retrieve.", Name="SuiteDataSourceInstanceId")
    suite_data_source_instance_id: Optional[str] = None
    """
    Suite Data Source Instance Id to determine which licensees data to retrieve.
    """


    ignore_validation: bool = False

Python 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
		}
	}
}