Platform API

<back to all web services

ConnectionStatusUpdate

Update the status of the specified connection

import Foundation
import ServiceStack

/**
* Update the status of the specified connection
*/
// @Api(Description="Update the status of the specified connection")
public class ConnectionStatusUpdate : Codable
{
    /**
    * Connection to be updated
    */
    // @ApiMember(Description="Connection to be updated", IsRequired=true, Name="ConnectionId")
    public var connectionId:String

    /**
    * Id of the contact linked to the connection
    */
    // @ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")
    public var contactId:String

    /**
    * 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 var contactTypeId:String

    /**
    * Role Id linked to the connection request
    */
    // @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
    public var roleId:String

    required public init(){}
}

public class ConnectionStatusUpdateResponse : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift 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
		}
	}
}