Framework API

<back to all web services

GetCommunicationData

Retrieves communications from the Communication database to be saved to Framework

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Retrieves communications from the Communication database to be saved to Framework
    */
    @Api(Description="Retrieves communications from the Communication database to be saved to Framework")
    public static class GetCommunicationData implements ISubscription
    {
        /**
        * Bin Row Version of the last update
        */
        @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
        public byte[] BinRowVersion = null;

        /**
        * Suite Data Source Instance Id to determine which licensees data to retrieve.
        */
        @ApiMember(DataType="Guid", Description="Suite Data Source Instance Id to determine which licensees data to retrieve.", Name="SuiteDataSourceInstanceId")
        public UUID SuiteDataSourceInstanceId = null;

        /**
        * Batch Call Number.
        */
        @ApiMember(DataType="int", Description="Batch Call Number.", Name="BatchNumber")
        public Integer BatchNumber = null;

        /**
        * Number of records to retrieve per call.
        */
        @ApiMember(DataType="int", Description="Number of records to retrieve per call.", Name="BatchSize")
        public Integer BatchSize = null;

        public Boolean IgnoreValidation = null;
        
        public byte[] getBinRowVersion() { return BinRowVersion; }
        public GetCommunicationData setBinRowVersion(byte[] value) { this.BinRowVersion = value; return this; }
        public UUID getSuiteDataSourceInstanceId() { return SuiteDataSourceInstanceId; }
        public GetCommunicationData setSuiteDataSourceInstanceId(UUID value) { this.SuiteDataSourceInstanceId = value; return this; }
        public Integer getBatchNumber() { return BatchNumber; }
        public GetCommunicationData setBatchNumber(Integer value) { this.BatchNumber = value; return this; }
        public Integer getBatchSize() { return BatchSize; }
        public GetCommunicationData setBatchSize(Integer value) { this.BatchSize = value; return this; }
        public Boolean isIgnoreValidation() { return IgnoreValidation; }
        public GetCommunicationData setIgnoreValidation(Boolean value) { this.IgnoreValidation = value; return this; }
    }

    @ApiResponse(Description="Communications Data for synching to Framework")
    public static class GetCommunicationDataResponse
    {
        /**
        * Bin Row Version of the last update
        */
        @ApiMember(DataType="byte[]", Description="Bin Row Version of the last update", Name="BinRowVersion")
        public byte[] BinRowVersion = null;

        /**
        * Communication Data string (compressed/zipped)
        */
        @ApiMember(DataType="string", Description="Communication Data string (compressed/zipped)", Name="Communications")
        public String Communications = null;

        public ResponseStatus ResponseStatus = null;
        
        public byte[] getBinRowVersion() { return BinRowVersion; }
        public GetCommunicationDataResponse setBinRowVersion(byte[] value) { this.BinRowVersion = value; return this; }
        public String getCommunications() { return Communications; }
        public GetCommunicationDataResponse setCommunications(String value) { this.Communications = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetCommunicationDataResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java GetCommunicationData DTOs

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>