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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ConnectionStatusUpdateResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Update the status of the specified connection
    ///</summary>
    [<Api(Description="Update the status of the specified connection")>]
    [<AllowNullLiteral>]
    type ConnectionStatusUpdate() = 
        ///<summary>
        ///Connection to be updated
        ///</summary>
        [<ApiMember(Description="Connection to be updated", IsRequired=true, Name="ConnectionId")>]
        member val ConnectionId:Guid = new Guid() with get,set

        ///<summary>
        ///Id of the contact linked to the connection
        ///</summary>
        [<ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<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")>]
        member val ContactTypeId:Guid = new Guid() with get,set

        ///<summary>
        ///Role Id linked to the connection request
        ///</summary>
        [<ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")>]
        member val RoleId:Guid = new Guid() with get,set

F# ConnectionStatusUpdate DTOs

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

HTTP + JSV

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