Platform API

<back to all web services

AddConnectionsInRole

Connect two contacts in the specified roles

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

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

export class GuidLookup
{
    public LookupId: string;
    public Value: string;

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

/** @description Connect two contacts in the specified roles */
// @Api(Description="Connect two contacts in the specified roles")
export class AddConnectionsInRole
{
    /** @description 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")
    public ContactId: string;

    /** @description 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")
    public ToContacts: GuidLookup[] = [];

    /** @description 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")
    public RoleId: string;

    /** @description 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")
    public SendConnectionEmails: boolean;

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

TypeScript AddConnectionsInRole DTOs

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

<AddConnectionsInRole 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>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
  <SendConnectionEmails>false</SendConnectionEmails>
  <ToContacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:GuidLookup>
      <d2p1:LookupId>00000000-0000-0000-0000-000000000000</d2p1:LookupId>
      <d2p1:Value>00000000-0000-0000-0000-000000000000</d2p1:Value>
    </d2p1:GuidLookup>
  </ToContacts>
</AddConnectionsInRole>

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>