Platform API

<back to all web services

PublicConnectionRequestStatusUpdate

Validate the status of the connection request and accept the request anonymously (without logging in)

The following routes are available for this service:
All Verbs/api/public/connectionrequests/{ConnectionRequestId}/accept
<?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 ConnectionRequestStatusUpdateResponse 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 Validate the status of the connection request and accept the request anonymously (without logging in) */
// @Api(Description="Validate the status of the connection request and accept the request anonymously (without logging in)")
class PublicConnectionRequestStatusUpdate implements IPublicServiceModel, JsonSerializable
{
    public function __construct(
        /** @description Connection request to be updated */
        // @ApiMember(Description="Connection request to be updated", IsRequired=true, Name="ConnectionRequestId")
        /** @var string */
        public string $ConnectionRequestId='',

        /** @description Appliance to create a public session and retrieve settings for */
        // @ApiMember(Description="Appliance to create a public session and retrieve settings for", Name="ApplianceId")
        /** @var string */
        public string $ApplianceId='',

        /** @var string|null */
        public ?string $SubdomainName=null
    ) {
    }

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

PHP PublicConnectionRequestStatusUpdate DTOs

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

HTTP + CSV

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

POST /api/public/connectionrequests/{ConnectionRequestId}/accept HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ConnectionRequestId":"00000000-0000-0000-0000-000000000000","ApplianceId":"00000000-0000-0000-0000-000000000000","SubdomainName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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