Platform Subscription API

<back to all web services

GetLastSuccessfulCollectionDate

Get the last collection date for a successfully imported integrations import

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @ApiResponse(Description="A datetime value which was the last collection date for a successfully processed import.")
class GetLastSuccessfulCollectionDateResponse implements JsonSerializable
{
    public function __construct(
        /** @var DateTime|null */
        public ?DateTime $LastSuccessfulCollectionDate=null,
        /** @var ByteArray|null */
        public ?ByteArray $LastSuccessfulRowVersion=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['LastSuccessfulCollectionDate'])) $this->LastSuccessfulCollectionDate = JsonConverters::from('DateTime', $o['LastSuccessfulCollectionDate']);
        if (isset($o['LastSuccessfulRowVersion'])) $this->LastSuccessfulRowVersion = JsonConverters::from('ByteArray', $o['LastSuccessfulRowVersion']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->LastSuccessfulCollectionDate)) $o['LastSuccessfulCollectionDate'] = JsonConverters::to('DateTime', $this->LastSuccessfulCollectionDate);
        if (isset($this->LastSuccessfulRowVersion)) $o['LastSuccessfulRowVersion'] = JsonConverters::to('ByteArray', $this->LastSuccessfulRowVersion);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Get the last collection date for a successfully imported integrations import */
// @Api(Description="Get the last collection date for a successfully imported integrations import")
class GetLastSuccessfulCollectionDate implements JsonSerializable
{
    public function __construct(
        /** @description Guid representing the external systems datasource information. */
        // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", Name="SuiteDataSourceInstanceId", ParameterType="query")
        /** @var string */
        public string $SuiteDataSourceInstanceId='',

        /** @description Import data type. */
        // @ApiMember(DataType="Guid", Description="Import data type.", Name="ImportTypeId", ParameterType="query")
        /** @var string */
        public string $ImportTypeId=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['SuiteDataSourceInstanceId'])) $this->SuiteDataSourceInstanceId = $o['SuiteDataSourceInstanceId'];
        if (isset($o['ImportTypeId'])) $this->ImportTypeId = $o['ImportTypeId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->SuiteDataSourceInstanceId)) $o['SuiteDataSourceInstanceId'] = $this->SuiteDataSourceInstanceId;
        if (isset($this->ImportTypeId)) $o['ImportTypeId'] = $this->ImportTypeId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetLastSuccessfulCollectionDate DTOs

POST /api/imports/lastsuccessfulcollectiondate HTTP/1.1 
Host: production-eros-platform-apisubscription.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetLastSuccessfulCollectionDate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <ImportTypeId>00000000-0000-0000-0000-000000000000</ImportTypeId>
  <SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</SuiteDataSourceInstanceId>
</GetLastSuccessfulCollectionDate>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetLastSuccessfulCollectionDateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModelSubscription">
  <LastSuccessfulCollectionDate>0001-01-01T00:00:00</LastSuccessfulCollectionDate>
  <LastSuccessfulRowVersion>AA==</LastSuccessfulRowVersion>
  <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>
</GetLastSuccessfulCollectionDateResponse>