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.*


/**
* Retrieves Updated RMS and UI data to be saved to Framework
*/
@Api(Description="Retrieves Updated RMS and UI data to be saved to Framework")
open class GetRmsUIData : ISubscription
{
    /**
    * Bin Row Version of the last update
    */
    @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
    open var BinRowVersion:ByteArray? = 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")
    override var SuiteDataSourceInstanceId:UUID? = null

    override var IgnoreValidation:Boolean? = null
}

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

    /**
    * XML string containing the Framework Data
    */
    @ApiMember(DataType="string", Description="XML string containing the Framework Data", Name="FrameworkData")
    open var FrameworkData:String? = null

    open var ResponseStatus:ResponseStatus? = null
}

Kotlin GetRmsUIData DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

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

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