Platform API

<back to all web services

ConnectionStatusUpdate

Update the status of the specified connection

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

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>