Platform API

<back to all web services

ConnectionRequestStatusUpdate

Validate the status of the connection request and accept the request

Requires Authentication
The following routes are available for this service:
All Verbs/api/connectionrequests/{ConnectionRequestId}/accept
All Verbs/api/connectionrequests/{ConnectionRequestId}/ignore
All Verbs/api/connectionrequests/{ConnectionRequestId}/decline
All Verbs/api/connectionrequests/{ConnectionRequestId}/cancel

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 */
// @Api(Description="Validate the status of the connection request and accept the request")
export class ConnectionRequestStatusUpdate
{
    /** @description Connection request to be updated */
    // @ApiMember(Description="Connection request to be updated", IsRequired=true, Name="ConnectionRequestId")
    public ConnectionRequestId: string;

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

    /** @description Role Id linked to the connection request */
    // @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
    public RoleId: string;

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

TypeScript ConnectionRequestStatusUpdate 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/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","ContactId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000"}
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"}}}