Platform API

<back to all web services

ConnectContactsInRoles

Connect two contacts in the specified roles

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

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

    /**
    * Create a connection to this contact from the specified to contact in the specified roles.
    */
    // @ApiMember(DataType="Guid", Description="Create a connection to this contact from the specified to contact in the specified roles.", IsRequired=true, Name="ToContactId")
    String? ToContactId;

    /**
    * Type of contact being connected with. For e.g. Real Person, Virtual Person etc.
    */
    // @ApiMember(DataType="Guid", Description="Type of contact being connected with. For e.g. Real Person, Virtual Person etc.", IsRequired=true, Name="ContactTypeId")
    String? ContactTypeId;

    /**
    * List of roles to connect contacts in
    */
    // @ApiMember(DataType="List<Guid>", Description="List of roles to connect contacts in", IsRequired=true, Name="Roles")
    List<String>? Roles = [];

    /**
    * 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;

    ConnectContactsInRoles({this.ContactId,this.ToContactId,this.ContactTypeId,this.Roles,this.SendConnectionEmails});
    ConnectContactsInRoles.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId,
        'ToContactId': ToContactId,
        'ContactTypeId': ContactTypeId,
        'Roles': JsonConverters.toJson(Roles,'List<String>',context!),
        'SendConnectionEmails': SendConnectionEmails
    };

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

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

Dart ConnectContactsInRoles DTOs

POST /api/connections/{ContactId}/to/{ToContactId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ConnectContactsInRoles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <ContactTypeId>00000000-0000-0000-0000-000000000000</ContactTypeId>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Roles>
  <SendConnectionEmails>false</SendConnectionEmails>
  <ToContactId>00000000-0000-0000-0000-000000000000</ToContactId>
</ConnectContactsInRoles>

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

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