Framework API

<back to all web services

GetRmsUIData

Retrieves Updated RMS and UI data to be saved to Framework

Requires Authentication 
"use strict";
export class GetRmsUIDataResponse {
    /** @param {{BinRowVersion?:string,FrameworkData?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Bin Row Version of the last update */
    BinRowVersion;
    /**
     * @type {string}
     * @description XML string containing the Framework Data */
    FrameworkData;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetRmsUIData {
    /** @param {{BinRowVersion?:string,SuiteDataSourceInstanceId?:string,IgnoreValidation?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Bin Row Version of the last update */
    BinRowVersion;
    /**
     * @type {string}
     * @description Suite Data Source Instance Id to determine which licensees data to retrieve. */
    SuiteDataSourceInstanceId;
    /** @type {boolean} */
    IgnoreValidation;
}

JavaScript 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"}}}