Platform API

<back to all web services

InsertObjectSubscription

Inseets a new object subscription record

Requires Authentication
The following routes are available for this service:
All Verbs/api/insertobjectsubscription
<?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};


class ObjectSubscription implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ObjectSubscriptionId=null,
        /** @var string */
        public string $ObjectId='',
        /** @var string */
        public string $SuiteDataSourceInstanceId='',
        /** @var string */
        public string $RmsTableContextId='',
        /** @var string|null */
        public ?string $AlternateKey=null,
        /** @var string|null */
        public ?string $SuiteDataSourceName=null,
        /** @var DateTime */
        public DateTime $CreatedAt=new DateTime(),
        /** @var DateTime|null */
        public ?DateTime $LastModified=null,
        /** @var string|null */
        public ?string $RecordStatus=null,
        /** @var string */
        public string $SuiteInstanceId='',
        /** @var string|null */
        public ?string $SuiteInstanceName=null,
        /** @var string */
        public string $ContactIdLicensee='',
        /** @var string|null */
        public ?string $SubscriptionUpdateResultId=null,
        /** @var string|null */
        public ?string $SubscriptionUpdateResult=null,
        /** @var bool|null */
        public ?bool $IsExport=null,
        /** @var DateTime|null */
        public ?DateTime $ProcessedAt=null,
        /** @var DateTime|null */
        public ?DateTime $AcknowledgedAt=null,
        /** @var int */
        public int $Failures=0,
        /** @var string|null */
        public ?string $Result=null,
        /** @var string|null */
        public ?string $ObjectHash=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ObjectSubscriptionId'])) $this->ObjectSubscriptionId = $o['ObjectSubscriptionId'];
        if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
        if (isset($o['SuiteDataSourceInstanceId'])) $this->SuiteDataSourceInstanceId = $o['SuiteDataSourceInstanceId'];
        if (isset($o['RmsTableContextId'])) $this->RmsTableContextId = $o['RmsTableContextId'];
        if (isset($o['AlternateKey'])) $this->AlternateKey = $o['AlternateKey'];
        if (isset($o['SuiteDataSourceName'])) $this->SuiteDataSourceName = $o['SuiteDataSourceName'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['LastModified'])) $this->LastModified = JsonConverters::from('DateTime', $o['LastModified']);
        if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
        if (isset($o['SuiteInstanceId'])) $this->SuiteInstanceId = $o['SuiteInstanceId'];
        if (isset($o['SuiteInstanceName'])) $this->SuiteInstanceName = $o['SuiteInstanceName'];
        if (isset($o['ContactIdLicensee'])) $this->ContactIdLicensee = $o['ContactIdLicensee'];
        if (isset($o['SubscriptionUpdateResultId'])) $this->SubscriptionUpdateResultId = $o['SubscriptionUpdateResultId'];
        if (isset($o['SubscriptionUpdateResult'])) $this->SubscriptionUpdateResult = $o['SubscriptionUpdateResult'];
        if (isset($o['IsExport'])) $this->IsExport = $o['IsExport'];
        if (isset($o['ProcessedAt'])) $this->ProcessedAt = JsonConverters::from('DateTime', $o['ProcessedAt']);
        if (isset($o['AcknowledgedAt'])) $this->AcknowledgedAt = JsonConverters::from('DateTime', $o['AcknowledgedAt']);
        if (isset($o['Failures'])) $this->Failures = $o['Failures'];
        if (isset($o['Result'])) $this->Result = $o['Result'];
        if (isset($o['ObjectHash'])) $this->ObjectHash = $o['ObjectHash'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ObjectSubscriptionId)) $o['ObjectSubscriptionId'] = $this->ObjectSubscriptionId;
        if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
        if (isset($this->SuiteDataSourceInstanceId)) $o['SuiteDataSourceInstanceId'] = $this->SuiteDataSourceInstanceId;
        if (isset($this->RmsTableContextId)) $o['RmsTableContextId'] = $this->RmsTableContextId;
        if (isset($this->AlternateKey)) $o['AlternateKey'] = $this->AlternateKey;
        if (isset($this->SuiteDataSourceName)) $o['SuiteDataSourceName'] = $this->SuiteDataSourceName;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->LastModified)) $o['LastModified'] = JsonConverters::to('DateTime', $this->LastModified);
        if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
        if (isset($this->SuiteInstanceId)) $o['SuiteInstanceId'] = $this->SuiteInstanceId;
        if (isset($this->SuiteInstanceName)) $o['SuiteInstanceName'] = $this->SuiteInstanceName;
        if (isset($this->ContactIdLicensee)) $o['ContactIdLicensee'] = $this->ContactIdLicensee;
        if (isset($this->SubscriptionUpdateResultId)) $o['SubscriptionUpdateResultId'] = $this->SubscriptionUpdateResultId;
        if (isset($this->SubscriptionUpdateResult)) $o['SubscriptionUpdateResult'] = $this->SubscriptionUpdateResult;
        if (isset($this->IsExport)) $o['IsExport'] = $this->IsExport;
        if (isset($this->ProcessedAt)) $o['ProcessedAt'] = JsonConverters::to('DateTime', $this->ProcessedAt);
        if (isset($this->AcknowledgedAt)) $o['AcknowledgedAt'] = JsonConverters::to('DateTime', $this->AcknowledgedAt);
        if (isset($this->Failures)) $o['Failures'] = $this->Failures;
        if (isset($this->Result)) $o['Result'] = $this->Result;
        if (isset($this->ObjectHash)) $o['ObjectHash'] = $this->ObjectHash;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Inseets a new object subscription record */
// @Api(Description="Inseets a new object subscription record")
class InsertObjectSubscription implements JsonSerializable
{
    public function __construct(
        /** @var ObjectSubscription|null */
        public ?ObjectSubscription $ObjectSubscription=null
    ) {
    }

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

class ObjectSubscriptionResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var string|null */
        public ?string $Message=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

PHP InsertObjectSubscription DTOs

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

HTTP + XML

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

POST /api/insertobjectsubscription HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<InsertObjectSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ObjectSubscription xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:AcknowledgedAt>0001-01-01T00:00:00</d2p1:AcknowledgedAt>
    <d2p1:AlternateKey>String</d2p1:AlternateKey>
    <d2p1:ContactIdLicensee>00000000-0000-0000-0000-000000000000</d2p1:ContactIdLicensee>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:Failures>0</d2p1:Failures>
    <d2p1:IsExport>false</d2p1:IsExport>
    <d2p1:LastModified>0001-01-01T00:00:00</d2p1:LastModified>
    <d2p1:ObjectHash>String</d2p1:ObjectHash>
    <d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
    <d2p1:ObjectSubscriptionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectSubscriptionId>
    <d2p1:ProcessedAt>0001-01-01T00:00:00</d2p1:ProcessedAt>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:Result>String</d2p1:Result>
    <d2p1:RmsTableContextId>00000000-0000-0000-0000-000000000000</d2p1:RmsTableContextId>
    <d2p1:SubscriptionUpdateResult>String</d2p1:SubscriptionUpdateResult>
    <d2p1:SubscriptionUpdateResultId>00000000-0000-0000-0000-000000000000</d2p1:SubscriptionUpdateResultId>
    <d2p1:SuiteDataSourceInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteDataSourceInstanceId>
    <d2p1:SuiteDataSourceName>String</d2p1:SuiteDataSourceName>
    <d2p1:SuiteInstanceId>00000000-0000-0000-0000-000000000000</d2p1:SuiteInstanceId>
    <d2p1:SuiteInstanceName>String</d2p1:SuiteInstanceName>
  </ObjectSubscription>
</InsertObjectSubscription>

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

<ObjectSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <Message>String</Message>
  <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>
  <Success>false</Success>
</ObjectSubscriptionResponse>