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}

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

    public constructor(init?: Partial<SaveObjectConnectionForRolesResponse>) { (Object as any).assign(this, init); }
}

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

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

    public constructor(init?: Partial<SaveObjectConnectionForRoles>) { (Object as any).assign(this, init); }
}

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