Platform API

IsConnectedInRole

Return true/false if a contact is connected to a licensee in a specific role.

The following routes are available for this service:
All Verbs	/api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId}


// @ApiResponse(Description="Returns whether or not a contact with a specific role is connected to a licensee.")
export class IsConnectedInRoleResponse
{
    /** @description True or false depending on if the contact is connected to the licensee in the role. */
    // @ApiMember(DataType="bool", Description="True or false depending on if the contact is connected to the licensee in the role.", Name="IsConnected")
    public IsConnected: boolean;

    public ResponseStatus: ResponseStatus;

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

/** @description Return true/false if a contact is connected to a licensee in a specific role. */
// @Api(Description="Return true/false if a contact is connected to a licensee in a specific role.")
export class IsConnectedInRole
{
    /** @description Contact Id of the contact to determine if they have the role with the licensee. */
    // @ApiMember(DataType="Guid", Description="Contact Id of the contact to determine if they have the role with the licensee.", IsRequired=true, Name="ContactId")
    public ContactId: string;

    /** @description Role to check for. */
    // @ApiMember(DataType="Guid", Description="Role to check for.", IsRequired=true, Name="RoleId")
    public RoleId: string;

    /** @description Licensee Contact Id we are checking if we're connected to. */
    // @ApiMember(DataType="Guid", Description="Licensee Contact Id we are checking if we're connected to.", IsRequired=true, Name="LicenseeId")
    public LicenseeId: string;

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

TypeScript IsConnectedInRole 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/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<IsConnectedInRole 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>
  <LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
</IsConnectedInRole>

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

<IsConnectedInRoleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <IsConnected>false</IsConnected>
  <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>
</IsConnectedInRoleResponse>