Platform API

ConnectionStatusUpdate

Update the status of the specified connection

The following routes are available for this service:
All Verbs	/api/connections/{ConnectionId}/cancel
All Verbs	/api/connections/{ConnectionId}/remove

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Update the status of the specified connection
    */
    @Api(Description="Update the status of the specified connection")
    public static class ConnectionStatusUpdate
    {
        /**
        * Connection to be updated
        */
        @ApiMember(Description="Connection to be updated", IsRequired=true, Name="ConnectionId")
        public UUID ConnectionId = null;

        /**
        * Id of the contact linked to the connection
        */
        @ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")
        public UUID ContactId = null;

        /**
        * 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")
        public UUID ContactTypeId = null;

        /**
        * Role Id linked to the connection request
        */
        @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
        public UUID RoleId = null;
        
        public UUID getConnectionId() { return ConnectionId; }
        public ConnectionStatusUpdate setConnectionId(UUID value) { this.ConnectionId = value; return this; }
        public UUID getContactId() { return ContactId; }
        public ConnectionStatusUpdate setContactId(UUID value) { this.ContactId = value; return this; }
        public UUID getContactTypeId() { return ContactTypeId; }
        public ConnectionStatusUpdate setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
        public UUID getRoleId() { return RoleId; }
        public ConnectionStatusUpdate setRoleId(UUID value) { this.RoleId = value; return this; }
    }

    public static class ConnectionStatusUpdateResponse
    {
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ConnectionStatusUpdateResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java ConnectionStatusUpdate DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"ConnectionId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000"}

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

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