"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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/GetCommunicationData HTTP/1.1
Host: gatewayframeworkapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetCommunicationData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FrameworkApi.Models">
<BatchNumber>0</BatchNumber>
<BatchSize>0</BatchSize>
<BinRowVersion>AA==</BinRowVersion>
<SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
</GetCommunicationData>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetCommunicationDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FrameworkApi.Models">
<BinRowVersion>AA==</BinRowVersion>
<Communications>String</Communications>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetCommunicationDataResponse>