Platform API

GetObjectConnections

Get object connections for the specified object and connection method.

The following routes are available for this service:
GET	/api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId}
GET	/api/objects/{RmsTableCtxIdConnectionMethod}/connectionsTo/{ToObjectId}

<?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 ObjectConnectionModel implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ObjectConnectionId='',
        /** @var string */
        public string $ObjectIdFrom='',
        /** @var string|null */
        public ?string $ObjectFromReference=null,
        /** @var string|null */
        public ?string $ObjectToReference=null,
        /** @var string */
        public string $ObjectIdTo='',
        /** @var string */
        public string $ConnectionMethodId='',
        /** @var string|null */
        public ?string $ObjectFromName=null,
        /** @var string|null */
        public ?string $ObjectToName=null,
        /** @var string|null */
        public ?string $RecordStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ObjectConnectionId'])) $this->ObjectConnectionId = $o['ObjectConnectionId'];
        if (isset($o['ObjectIdFrom'])) $this->ObjectIdFrom = $o['ObjectIdFrom'];
        if (isset($o['ObjectFromReference'])) $this->ObjectFromReference = $o['ObjectFromReference'];
        if (isset($o['ObjectToReference'])) $this->ObjectToReference = $o['ObjectToReference'];
        if (isset($o['ObjectIdTo'])) $this->ObjectIdTo = $o['ObjectIdTo'];
        if (isset($o['ConnectionMethodId'])) $this->ConnectionMethodId = $o['ConnectionMethodId'];
        if (isset($o['ObjectFromName'])) $this->ObjectFromName = $o['ObjectFromName'];
        if (isset($o['ObjectToName'])) $this->ObjectToName = $o['ObjectToName'];
        if (isset($o['RecordStatus'])) $this->RecordStatus = $o['RecordStatus'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ObjectConnectionId)) $o['ObjectConnectionId'] = $this->ObjectConnectionId;
        if (isset($this->ObjectIdFrom)) $o['ObjectIdFrom'] = $this->ObjectIdFrom;
        if (isset($this->ObjectFromReference)) $o['ObjectFromReference'] = $this->ObjectFromReference;
        if (isset($this->ObjectToReference)) $o['ObjectToReference'] = $this->ObjectToReference;
        if (isset($this->ObjectIdTo)) $o['ObjectIdTo'] = $this->ObjectIdTo;
        if (isset($this->ConnectionMethodId)) $o['ConnectionMethodId'] = $this->ConnectionMethodId;
        if (isset($this->ObjectFromName)) $o['ObjectFromName'] = $this->ObjectFromName;
        if (isset($this->ObjectToName)) $o['ObjectToName'] = $this->ObjectToName;
        if (isset($this->RecordStatus)) $o['RecordStatus'] = $this->RecordStatus;
        return empty($o) ? new class(){} : $o;
    }
}

// @ApiResponse(Description="Returns the connections for the specified object.")
class GetObjectConnectionsResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<ObjectConnectionModel>|null */
        public ?array $ObjectConnections=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

/** @description Get object connections for the specified object and connection method. */
// @Api(Description="Get object connections for the specified object and connection method.")
class GetObjectConnections implements JsonSerializable
{
    public function __construct(
        /** @description 'From' object ID in the connection. */
        // @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromObjectId", ParameterType="query")
        /** @var string */
        public string $FromObjectId='',

        /** @description 'To' object ID in the connection. */
        // @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToObjectId", ParameterType="query")
        /** @var string */
        public string $ToObjectId='',

        /** @description Guid representing the Connection Method to use to connect the objects with. */
        // @ApiMember(DataType="Guid", Description="Guid representing the Connection Method to use to connect the objects with.", IsRequired=true, Name="RmsTableCtxIdConnectionMethod", ParameterType="query")
        /** @var string */
        public string $RmsTableCtxIdConnectionMethod='',

        /** @description Status of object Connections to retrieve, if not specified active connections are retrieved by default. */
        // @ApiMember(DataType="string", Description="Status of object Connections to retrieve, if not specified active connections are retrieved by default.", Name="RecordStatus", ParameterType="query")
        /** @var string|null */
        public ?string $RecordStatus=null
    ) {
    }

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

PHP GetObjectConnections 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.

GET /api/objects/{RmsTableCtxIdConnectionMethod}/connectionsFrom/{FromObjectId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml

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

<GetObjectConnectionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ObjectConnections xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:ObjectConnectionModel>
      <d2p1:ConnectionMethodId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionMethodId>
      <d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
      <d2p1:ObjectFromName>String</d2p1:ObjectFromName>
      <d2p1:ObjectFromReference>String</d2p1:ObjectFromReference>
      <d2p1:ObjectIdFrom>00000000-0000-0000-0000-000000000000</d2p1:ObjectIdFrom>
      <d2p1:ObjectIdTo>00000000-0000-0000-0000-000000000000</d2p1:ObjectIdTo>
      <d2p1:ObjectToName>String</d2p1:ObjectToName>
      <d2p1:ObjectToReference>String</d2p1:ObjectToReference>
      <d2p1:RecordStatus>String</d2p1:RecordStatus>
    </d2p1:ObjectConnectionModel>
  </ObjectConnections>
  <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>
</GetObjectConnectionsResponse>