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.

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveObjectConnectionForRolesResponse:
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Creates or Updates a new connection between two objects with connection type as link to associated role.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveObjectConnectionForRoles:
    """
    Creates or Updates a new connection between two objects with connection type as link to associated role.
    """

    # @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromRoleId", ParameterType="query")
    from_role_id: Optional[str] = None
    """
    'From' object ID in the connection.
    """


    # @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToRoleId", ParameterType="query")
    to_role_id: Optional[str] = None
    """
    'To' object ID in the connection.
    """

Python SaveObjectConnectionForRoles DTOs

POST /api/roles/{FromRoleId}/associatedroles/safetystaff/{ToRoleId} 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
		}
	}
}