"use strict";
export class UserContactConnectionModel {
/** @param {{ContactRoleId?:string,ContactRoleName?:string,ContactListItemRoleId?:string,ContactRolePrimaryImageURL?:string,ContactRolePrimaryImageThumbnailURL?:string,ContactRolePrimaryImageId?:string,ConnectionContactId?:string,ConnectionContactName?:string,ConnectionContactRoleName?:string,ConnectionContactRoleId?:string,ConnectionContactListItemRoleId?:string,ContactTypeName?:string,ConnectionContactPhotoURL?:string,IsContactLicenseeRole?:boolean,IsConnectionLicenseeRole?:boolean,ConnectionStatusName?:string,ConnectionStatusId?:string,ConnectionId?:string,ConnectionRequestId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The Contact Role Id, that links the Contact to their role. */
ContactRoleId;
/**
* @type {string}
* @description The role name. */
ContactRoleName;
/**
* @type {string}
* @description The list item role Id. */
ContactListItemRoleId;
/**
* @type {string}
* @description The URL of the contact role's image icon. */
ContactRolePrimaryImageURL;
/**
* @type {string}
* @description The URL of the contact role's thumbnail image icon. */
ContactRolePrimaryImageThumbnailURL;
/**
* @type {string}
* @description The Guid of the contact role's media file containing the image icon details. */
ContactRolePrimaryImageId;
/**
* @type {string}
* @description The connected contacts Id. (licensee) */
ConnectionContactId;
/**
* @type {string}
* @description The connected contacts Full Name. */
ConnectionContactName;
/**
* @type {string}
* @description The connected contacts role. */
ConnectionContactRoleName;
/**
* @type {string}
* @description The connected contacts role Id. */
ConnectionContactRoleId;
/**
* @type {string}
* @description The connected contacts list item role Id. */
ConnectionContactListItemRoleId;
/**
* @type {string}
* @description The Contacts Type. */
ContactTypeName;
/**
* @type {string}
* @description The URL to the Connected Contacts Photo. */
ConnectionContactPhotoURL;
/**
* @type {boolean}
* @description . */
IsContactLicenseeRole;
/**
* @type {boolean}
* @description If the connection is as a licensee this is true. */
IsConnectionLicenseeRole;
/**
* @type {string}
* @description The status of the connection with the contact. */
ConnectionStatusName;
/**
* @type {string}
* @description The status Id of the connection with the contact. */
ConnectionStatusId;
/**
* @type {string}
* @description The ContactRoleConnectionId of an active connection with the contact. */
ConnectionId;
/**
* @type {string}
* @description The ContactRoleConnectionRequest of a pending connection with the contact. */
ConnectionRequestId;
}
export class ContactEmailAddress {
/** @param {{ContactId?:string,ContactName?:string,EmailAddress?:string,ContactPhotoURL?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The Contact Id of the contact. */
ContactId;
/**
* @type {string}
* @description The Contact Full Name */
ContactName;
/**
* @type {string}
* @description The Contact Email Address. */
EmailAddress;
/**
* @type {string}
* @description The Contact Photo URL */
ContactPhotoURL;
}
export class UserContacts {
/** @param {{ContactConnections?:UserContactConnectionModel[],EmailAddressBook?:ContactEmailAddress[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {UserContactConnectionModel[]}
* @description A list of contact connections assigned to the user. */
ContactConnections;
/**
* @type {ContactEmailAddress[]}
* @description A list of connected contacts and their email addresses. */
EmailAddressBook;
}
export class GetLicenseeConnectedContacts {
/** @param {{ContactId?:string,SuiteIds?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The user profiles Contact Guid. Contacts connected to the user will be filted by this profiles contact ID. */
ContactId;
/**
* @type {string[]}
* @description The suite id list. Gets contacts connected to the user filted by the suite IDs in this list.. */
SuiteIds;
}
JavaScript GetLicenseeConnectedContacts 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 /jsv/reply/GetLicenseeConnectedContacts HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SuiteIds:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ContactConnections:
[
{
ContactRoleName: String,
ContactRolePrimaryImageURL: String,
ContactRolePrimaryImageThumbnailURL: String,
ConnectionContactName: String,
ConnectionContactRoleName: String,
ContactTypeName: String,
ConnectionContactPhotoURL: String,
IsContactLicenseeRole: False,
IsConnectionLicenseeRole: False,
ConnectionStatusName: String
}
],
EmailAddressBook:
[
{
ContactName: String,
EmailAddress: String,
ContactPhotoURL: String
}
]
}