Platform API

SaveObjectConnection

Creates or Updates a new connection between two objects.

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

<?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="Returns the object connection Id created/modified and success of the save.")
class SaveObjectConnectionResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ObjectConnectionId='',
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

/** @description Creates or Updates a new connection between two objects. */
// @Api(Description="Creates or Updates a new connection between two objects.")
class SaveObjectConnection 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=''
    ) {
    }

    /** @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'];
    }
    
    /** @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;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SaveObjectConnection 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/objects/{FromObjectId}/{ToObjectId}/{RmsTableCtxIdConnectionMethod} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveObjectConnection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <FromObjectId>00000000-0000-0000-0000-000000000000</FromObjectId>
  <RmsTableCtxIdConnectionMethod>00000000-0000-0000-0000-000000000000</RmsTableCtxIdConnectionMethod>
  <ToObjectId>00000000-0000-0000-0000-000000000000</ToObjectId>
</SaveObjectConnection>

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

<SaveObjectConnectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.ServiceModels">
  <ObjectConnectionId>00000000-0000-0000-0000-000000000000</ObjectConnectionId>
  <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>
</SaveObjectConnectionResponse>