| All Verbs | /api/connections/is-connected/{ContactId}/to/{LicenseeId}/role/{RoleId} |
|---|
"use strict";
export class IsConnectedInRoleResponse {
/** @param {{IsConnected?:boolean,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {boolean}
* @description True or false depending on if the contact is connected to the licensee in the role. */
IsConnected;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class IsConnectedInRole {
/** @param {{ContactId?:string,RoleId?:string,LicenseeId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Contact Id of the contact to determine if they have the role with the licensee. */
ContactId;
/**
* @type {string}
* @description Role to check for. */
RoleId;
/**
* @type {string}
* @description Licensee Contact Id we are checking if we're connected to. */
LicenseeId;
}
JavaScript IsConnectedInRole DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}