Framework API

<back to all web services

GetCommunicationData

Retrieves communications from the Communication database to be saved to Framework

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

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

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

    ResponseStatus? ResponseStatus;

    GetCommunicationDataResponse({this.BinRowVersion,this.Communications,this.ResponseStatus});
    GetCommunicationDataResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BinRowVersion = JsonConverters.fromJson(json['BinRowVersion'],'Uint8List',context!);
        Communications = json['Communications'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BinRowVersion': JsonConverters.toJson(BinRowVersion,'Uint8List',context!),
        'Communications': Communications,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetCommunicationDataResponse";
    TypeContext? context = _ctx;
}

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

    /**
    * 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")
    String? SuiteDataSourceInstanceId;

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

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

    bool? IgnoreValidation;

    GetCommunicationData({this.BinRowVersion,this.SuiteDataSourceInstanceId,this.BatchNumber,this.BatchSize,this.IgnoreValidation});
    GetCommunicationData.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BinRowVersion = JsonConverters.fromJson(json['BinRowVersion'],'Uint8List',context!);
        SuiteDataSourceInstanceId = json['SuiteDataSourceInstanceId'];
        BatchNumber = json['BatchNumber'];
        BatchSize = json['BatchSize'];
        IgnoreValidation = json['IgnoreValidation'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BinRowVersion': JsonConverters.toJson(BinRowVersion,'Uint8List',context!),
        'SuiteDataSourceInstanceId': SuiteDataSourceInstanceId,
        'BatchNumber': BatchNumber,
        'BatchSize': BatchSize,
        'IgnoreValidation': IgnoreValidation
    };

    getTypeName() => "GetCommunicationData";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'gatewayframeworkapi.pstpf.com.au', types: <String, TypeInfo> {
    'GetCommunicationDataResponse': TypeInfo(TypeOf.Class, create:() => GetCommunicationDataResponse()),
    'Uint8List': TypeInfo(TypeOf.Class, create:() => Uint8List(0)),
    'GetCommunicationData': TypeInfo(TypeOf.Class, create:() => GetCommunicationData()),
});

Dart 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>