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}
import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Returns the object connection Id created/modified and success of the save.")
class SaveObjectConnectionForRolesResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

    SaveObjectConnectionForRolesResponse({this.ResponseStatus});
    SaveObjectConnectionForRolesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SaveObjectConnectionForRolesResponse";
    TypeContext? context = _ctx;
}

/**
* 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.")
class SaveObjectConnectionForRoles implements IConvertible
{
    /**
    * 'From' object ID in the connection.
    */
    // @ApiMember(DataType="Guid", Description="'From' object ID in the connection.", IsRequired=true, Name="FromRoleId", ParameterType="query")
    String? FromRoleId;

    /**
    * 'To' object ID in the connection.
    */
    // @ApiMember(DataType="Guid", Description="'To' object ID in the connection.", IsRequired=true, Name="ToRoleId", ParameterType="query")
    String? ToRoleId;

    SaveObjectConnectionForRoles({this.FromRoleId,this.ToRoleId});
    SaveObjectConnectionForRoles.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FromRoleId = json['FromRoleId'];
        ToRoleId = json['ToRoleId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FromRoleId': FromRoleId,
        'ToRoleId': ToRoleId
    };

    getTypeName() => "SaveObjectConnectionForRoles";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'SaveObjectConnectionForRolesResponse': TypeInfo(TypeOf.Class, create:() => SaveObjectConnectionForRolesResponse()),
    'SaveObjectConnectionForRoles': TypeInfo(TypeOf.Class, create:() => SaveObjectConnectionForRoles()),
});

Dart SaveObjectConnectionForRoles DTOs

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

HTTP + JSV

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