Platform API

SaveObjectConnectionForRoles

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

The following routes are available for this service:
POST	/api/roles/{FromRoleId}/associatedroles/safetystaff/{ToRoleId}
POST	/api/roles/{FromRoleId}/associatedroles/organisation/{ToRoleId}

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

    [<ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")>]
    [<AllowNullLiteral>]
    type SaveObjectConnectionForRolesResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<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.")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val FromRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///'To' object ID in the connection.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToRoleId", ParameterType="query")>]
        member val ToRoleId:Guid = new Guid() with get,set

F# SaveObjectConnectionForRoles 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/roles/{FromRoleId}/associatedroles/safetystaff/{ToRoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveObjectConnectionForRoles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <FromRoleId>00000000-0000-0000-0000-000000000000</FromRoleId>
  <ToRoleId>00000000-0000-0000-0000-000000000000</ToRoleId>
</SaveObjectConnectionForRoles>

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

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