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

export class ConnectionRequestStatusUpdateResponse
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ConnectionRequestStatusUpdateResponse>) { (Object as any).assign(this, init); }
}

/** @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)")
export class PublicConnectionRequestStatusUpdate implements IPublicServiceModel
{
    /** @description Connection request to be updated */
    // @ApiMember(Description="Connection request to be updated", IsRequired=true, Name="ConnectionRequestId")
    public ConnectionRequestId: string;

    /** @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")
    public ApplianceId: string;

    public SubdomainName: string;

    public constructor(init?: Partial<PublicConnectionRequestStatusUpdate>) { (Object as any).assign(this, init); }
}

TypeScript PublicConnectionRequestStatusUpdate DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

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