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.*


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

    /**
    * Id of the contact linked to the connection
    */
    @ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")
    open var ContactId:UUID? = 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")
    open var ContactTypeId:UUID? = null

    /**
    * Role Id linked to the connection request
    */
    @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
    open var RoleId:UUID? = null
}

open class ConnectionStatusUpdateResponse
{
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin ConnectionStatusUpdate DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<ConnectionStatusUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ConnectionId>00000000-0000-0000-0000-000000000000</ConnectionId>
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <ContactTypeId>00000000-0000-0000-0000-000000000000</ContactTypeId>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
</ConnectionStatusUpdate>

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

<ConnectionStatusUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ConnectionStatusUpdateResponse>