Platform API

<back to all web services

SaveObjectConnectionForRoles

Creates or Updates a new connection between two objects with connection type as link to associated role.

Requires Authentication
The following routes are available for this service:
POST/api/roles/{FromRoleId}/associatedroles/safetystaff/{ToRoleId}
POST/api/roles/{FromRoleId}/associatedroles/organisation/{ToRoleId}
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>
        '''Creates or Updates a new connection between two objects with connection type as link to associated role.
        '''</Summary>
        <Api(Description:="Creates or Updates a new connection between two objects with connection type as link to associated role.")>
        Public Partial Class SaveObjectConnectionForRoles
            '''<Summary>
            ''''From' object ID in the connection.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="'From' object ID in the connection.", IsRequired:=true, Name:="FromRoleId", ParameterType:="query")>
            Public Overridable Property FromRoleId As Guid

            '''<Summary>
            ''''To' object ID in the connection.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="'To' object ID in the connection.", IsRequired:=true, Name:="ToRoleId", ParameterType:="query")>
            Public Overridable Property ToRoleId As Guid
        End Class

        <ApiResponse(Description:="Returns the object connection Id created/modified and success of the save.")>
        Public Partial Class SaveObjectConnectionForRolesResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET SaveObjectConnectionForRoles DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/roles/{FromRoleId}/associatedroles/safetystaff/{ToRoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FromRoleId":"00000000-0000-0000-0000-000000000000","ToRoleId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}