Platform API

<back to all web services

ConnectionStatusUpdate

Update the status of the specified connection

<?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 ConnectionStatusUpdateResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

/** @description Update the status of the specified connection */
// @Api(Description="Update the status of the specified connection")
class ConnectionStatusUpdate implements JsonSerializable
{
    public function __construct(
        /** @description Connection to be updated */
        // @ApiMember(Description="Connection to be updated", IsRequired=true, Name="ConnectionId")
        /** @var string */
        public string $ConnectionId='',

        /** @description Id of the contact linked to the connection */
        // @ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")
        /** @var string */
        public string $ContactId='',

        /** @description Type of contact being connected with. For e.g. Real Person, Virtual Person etc. */
        // @ApiMember(DataType="Guid", Description="Type of contact being connected with. For e.g. Real Person, Virtual Person etc.", IsRequired=true, Name="ContactTypeId")
        /** @var string */
        public string $ContactTypeId='',

        /** @description Role Id linked to the connection request */
        // @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
        /** @var string */
        public string $RoleId=''
    ) {
    }

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

PHP ConnectionStatusUpdate DTOs

POST /api/connections/{ConnectionId}/cancel HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}