Platform API

<back to all web services

ConnectionStatusUpdate

Update the status of the specified connection

Requires Authentication
The following routes are available for this service:
All Verbs/api/connections/{ConnectionId}/cancel
All Verbs/api/connections/{ConnectionId}/remove
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Update the status of the specified connection
        '''</Summary>
        <Api(Description:="Update the status of the specified connection")>
        Public Partial Class ConnectionStatusUpdate
            '''<Summary>
            '''Connection to be updated
            '''</Summary>
            <ApiMember(Description:="Connection to be updated", IsRequired:=true, Name:="ConnectionId")>
            Public Overridable Property ConnectionId As Guid

            '''<Summary>
            '''Id of the contact linked to the connection
            '''</Summary>
            <ApiMember(Description:="Id of the contact linked to the connection", IsRequired:=true, Name:="ContactId")>
            Public Overridable Property ContactId As Guid

            '''<Summary>
            '''Type of contact being connected with. For e.g. Real Person, Virtual Person etc.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Type of contact being connected with. For e.g. Real Person, Virtual Person etc.", IsRequired:=true, Name:="ContactTypeId")>
            Public Overridable Property ContactTypeId As Guid

            '''<Summary>
            '''Role Id linked to the connection request
            '''</Summary>
            <ApiMember(Description:="Role Id linked to the connection request", IsRequired:=true, Name:="RoleId")>
            Public Overridable Property RoleId As Guid
        End Class

        Public Partial Class ConnectionStatusUpdateResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET ConnectionStatusUpdate 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/connections/{ConnectionId}/cancel HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
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: 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"}}}