"use strict";
export class GetCommunicationDataResponse {
/** @param {{BinRowVersion?:string,Communications?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Bin Row Version of the last update */
BinRowVersion;
/**
* @type {string}
* @description Communication Data string (compressed/zipped) */
Communications;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetCommunicationData {
/** @param {{BinRowVersion?:string,SuiteDataSourceInstanceId?:string,BatchNumber?:number,BatchSize?:number,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 {number}
* @description Batch Call Number. */
BatchNumber;
/**
* @type {number}
* @description Number of records to retrieve per call. */
BatchSize;
/** @type {boolean} */
IgnoreValidation;
}
JavaScript GetCommunicationData DTOs
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
}
}
}