| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BinRowVersion | query | byte[] | No | Bin Row Version of the last update |
| SuiteDataSourceInstanceId | query | Guid | No | Suite Data Source Instance Id to determine which licensees data to retrieve. |
| BatchNumber | query | int | No | Batch Call Number. |
| BatchSize | query | int | No | Number of records to retrieve per call. |
| IgnoreValidation | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BinRowVersion | form | byte[] | No | Bin Row Version of the last update |
| Communications | form | string | No | Communication Data string (compressed/zipped) |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/GetCommunicationData HTTP/1.1
Host: gatewayframeworkapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
BinRowVersion: AA==,
BatchNumber: 0,
BatchSize: 0,
IgnoreValidation: True
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
BinRowVersion: AA==,
Communications: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}