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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

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 virtual Guid FromRoleId { 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")]
        public virtual Guid ToRoleId { get; set; }
    }

    [ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")]
    public partial class SaveObjectConnectionForRolesResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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"}}}