Platform API

<back to all web services

IsConnectedInRole

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

Requires Authentication
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 .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/is-connected/{ContactId}/to/{LicenseeId}/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","RoleId":"00000000-0000-0000-0000-000000000000","LicenseeId":"00000000-0000-0000-0000-000000000000"}

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

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