Framework API

<back to all web services

GetRmsUIData

Retrieves Updated RMS and UI data to be saved to Framework

Requires Authentication
GetRmsUIData Parameters:
NameParameterData TypeRequiredDescription
BinRowVersionquerybyte[]NoBin Row Version of the last update
SuiteDataSourceInstanceIdqueryGuidNoSuite Data Source Instance Id to determine which licensees data to retrieve.
IgnoreValidationqueryboolNo
GetRmsUIDataResponse Parameters:
NameParameterData TypeRequiredDescription
BinRowVersionformbyte[]NoBin Row Version of the last update
FrameworkDataformstringNoXML string containing the Framework Data
ResponseStatusformResponseStatusNo

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

HTTP + OTHER

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

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

{"BinRowVersion":"AA==","IgnoreValidation":true}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}