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}

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Creates or Updates a new connection between two objects with connection type as link to associated role.
    */
    @Api(Description="Creates or Updates a new connection between two objects with connection type as link to associated role.")
    public static class SaveObjectConnectionForRoles
    {
        /**
        * 'From' object ID in the connection.
        */
        @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromRoleId", ParameterType="query")
        public UUID FromRoleId = null;

        /**
        * 'To' object ID in the connection.
        */
        @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToRoleId", ParameterType="query")
        public UUID ToRoleId = null;
        
        public UUID getFromRoleId() { return FromRoleId; }
        public SaveObjectConnectionForRoles setFromRoleId(UUID value) { this.FromRoleId = value; return this; }
        public UUID getToRoleId() { return ToRoleId; }
        public SaveObjectConnectionForRoles setToRoleId(UUID value) { this.ToRoleId = value; return this; }
    }

    @ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")
    public static class SaveObjectConnectionForRolesResponse
    {
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SaveObjectConnectionForRolesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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

{"FromRoleId":"00000000-0000-0000-0000-000000000000","ToRoleId":"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"}}}