Framework API

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

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/GetCommunicationData HTTP/1.1 
Host: gatewayframeworkapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"BinRowVersion":"AA==","BatchNumber":0,"BatchSize":0,"IgnoreValidation":true}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}