Platform API

AddConnectionsInRole

Connect two contacts in the specified roles

The following routes are available for this service:
All Verbs	/api/connections/{ContactId}/role/{RoleId}

import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
class ConnectContactsInRolesResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

    ConnectContactsInRolesResponse({this.ResponseStatus});
    ConnectContactsInRolesResponse.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() => "ConnectContactsInRolesResponse";
    TypeContext? context = _ctx;
}

class GuidLookup implements IConvertible
{
    String? LookupId;
    String? Value;

    GuidLookup({this.LookupId,this.Value});
    GuidLookup.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'LookupId': LookupId,
        'Value': Value
    };

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

/**
* Connect two contacts in the specified roles
*/
// @Api(Description="Connect two contacts in the specified roles")
class AddConnectionsInRole implements IConvertible
{
    /**
    * Create a connection from this contact to the specified list of contacts in the specified role.
    */
    // @ApiMember(DataType="Guid", Description="Create a connection from this contact to the specified list of contacts in the specified role.", IsRequired=true, Name="ContactId")
    String? ContactId;

    /**
    * List of contacts to add  to the role, including the type of contact
    */
    // @ApiMember(DataType="List<GuidLookup>", Description="List of contacts to add  to the role, including the type of contact", IsRequired=true, Name="ToContacts")
    List<GuidLookup>? ToContacts = [];

    /**
    * Create a connection between contacts in the specified role.
    */
    // @ApiMember(DataType="Guid", Description="Create a connection between contacts in the specified role.", IsRequired=true, Name="RoleId")
    String? RoleId;

    /**
    * Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance
    */
    // @ApiMember(DataType="boolean", Description="Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance", IsRequired=true, Name="SendConnectionEmails")
    bool? SendConnectionEmails;

    AddConnectionsInRole({this.ContactId,this.ToContacts,this.RoleId,this.SendConnectionEmails});
    AddConnectionsInRole.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactId = json['ContactId'];
        ToContacts = JsonConverters.fromJson(json['ToContacts'],'List<GuidLookup>',context!);
        RoleId = json['RoleId'];
        SendConnectionEmails = json['SendConnectionEmails'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId,
        'ToContacts': JsonConverters.toJson(ToContacts,'List<GuidLookup>',context!),
        'RoleId': RoleId,
        'SendConnectionEmails': SendConnectionEmails
    };

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'ConnectContactsInRolesResponse': TypeInfo(TypeOf.Class, create:() => ConnectContactsInRolesResponse()),
    'GuidLookup': TypeInfo(TypeOf.Class, create:() => GuidLookup()),
    'AddConnectionsInRole': TypeInfo(TypeOf.Class, create:() => AddConnectionsInRole()),
    'List<GuidLookup>': TypeInfo(TypeOf.Class, create:() => <GuidLookup>[]),
});

Dart AddConnectionsInRole DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/connections/{ContactId}/role/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","ToContacts":[{"LookupId":"00000000-0000-0000-0000-000000000000","Value":"00000000-0000-0000-0000-000000000000"}],"RoleId":"00000000-0000-0000-0000-000000000000","SendConnectionEmails":false}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}