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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<SaveObjectConnectionForRoles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <FromRoleId>00000000-0000-0000-0000-000000000000</FromRoleId>
  <ToRoleId>00000000-0000-0000-0000-000000000000</ToRoleId>
</SaveObjectConnectionForRoles>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SaveObjectConnectionForRolesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SaveObjectConnectionForRolesResponse>