| All Verbs | /api/contactgroup/{ContactGroupId} |
|---|
"use strict";
export class UserProfileSummaryModel {
/** @param {{UserProfileId?:string,UserId?:string,ContactId?:string,UserName?:string,ProfileName?:string,ContactFullName?:string,EmailAddress?:string,EmailSignature?:string,MobileNumber?:string,PhoneNumber?:string,ContactTypeId?:string,ContactTypeName?:string,FirstName?:string,Surname?:string,Title?:string,LegalName?:string,TradingName?:string,Abn?:string,Acn?:string,Arbn?:string,GstRegistered?:boolean,ESL?:boolean,Language?:string,InterpreterRequired?:boolean,LicenseeNotes?:string,ProfilePhotoUrl?:string,ProfilePhotoThumbnailUrl?:string,ProfileImageId?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,Timezone?:string,TimezoneName?:string,PrimaryAddress?:string,IsActiveContact?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description User Profile Id */
UserProfileId;
/**
* @type {string}
* @description User linked to the profile */
UserId;
/**
* @type {string}
* @description Contact linked to the profile */
ContactId;
/**
* @type {string}
* @description User linked to the profile */
UserName;
/**
* @type {string}
* @description User Profile Name */
ProfileName;
/**
* @type {string}
* @description Full name of the contact linked to the profile */
ContactFullName;
/**
* @type {string}
* @description Email Address of the contact linked to the profile */
EmailAddress;
/**
* @type {string}
* @description Email signature of the contact linked to the profile */
EmailSignature;
/**
* @type {string}
* @description Mobile number of the contact linked to the profile */
MobileNumber;
/**
* @type {string}
* @description Phone number of the contact linked to the profile */
PhoneNumber;
/**
* @type {string}
* @description Type of contact (person, organisation etc.) linked to the profile */
ContactTypeId;
/**
* @type {string}
* @description Type of contact (person, organisation etc.) linked to the profile */
ContactTypeName;
/**
* @type {string}
* @description First name of the contact linked to the profile */
FirstName;
/**
* @type {string}
* @description Surname of the contact linked to the profile */
Surname;
/**
* @type {string}
* @description Title of contact linked to the profile */
Title;
/**
* @type {string}
* @description Legal name of contact linked to the profile */
LegalName;
/**
* @type {string}
* @description Trading name of contact linked to the profile */
TradingName;
/**
* @type {string}
* @description Australian Business Number */
Abn;
/**
* @type {string}
* @description Australian Company Number */
Acn;
/**
* @type {string}
* @description Australian Registered Body Number */
Arbn;
/**
* @type {boolean}
* @description Indicates if the Contact is registered for GST. */
GstRegistered;
/**
* @type {boolean}
* @description True if english is a secondary language for the contact. */
ESL;
/**
* @type {string}
* @description Language that is the primary language for the contact. */
Language;
/**
* @type {boolean}
* @description True if an interpreter is required. */
InterpreterRequired;
/**
* @type {string}
* @description Licensee specific notes about the contact. */
LicenseeNotes;
/**
* @type {string}
* @description Profile photo of contact linked to the profile */
ProfilePhotoUrl;
/**
* @type {string}
* @description Thumbnail photo of contact linked to the profile */
ProfilePhotoThumbnailUrl;
/**
* @type {string}
* @description Profile photo id of contact linked to the profile */
ProfileImageId;
/**
* @type {string}
* @description Profile description */
Description;
/**
* @type {string}
* @description Employment Industry */
EmploymentIndustry;
/**
* @type {string}
* @description Employment Role */
EmploymentRole;
/**
* @type {string}
* @description Areas of Work */
EmploymentGeographicArea;
/**
* @type {string}
* @description The contacts timezone. */
Timezone;
/**
* @type {string}
* @description Timezone Name */
TimezoneName;
/**
* @type {string}
* @description The primary address of the contact */
PrimaryAddress;
/**
* @type {boolean}
* @description Is this an active contact? Or an inactive contact (deleted account)? */
IsActiveContact;
}
export class RoleModel {
/** @param {{RoleId?:string,RoleName?:string,IsLicenseeRole?:boolean,IsManageContacts?:boolean,IsPlatformRole?:boolean,IsServiceRole?:boolean,IsCustomerRole?:boolean,IsFunctionalRole?:boolean,IsRequestAutoAccepted?:boolean,SuiteId?:string,SuiteName?:string,RecordStatus?:string,ObjectConnectionId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Role Id */
RoleId;
/**
* @type {string}
* @description Role Name */
RoleName;
/**
* @type {boolean}
* @description Is the role a licensee role? */
IsLicenseeRole;
/**
* @type {boolean}
* @description Is manage contacts role? */
IsManageContacts;
/**
* @type {boolean}
* @description Is the role a Platform role? */
IsPlatformRole;
/**
* @type {boolean}
* @description Is the role a services role? */
IsServiceRole;
/**
* @type {boolean}
* @description Is the role a customer role? */
IsCustomerRole;
/**
* @type {boolean}
* @description Is the role a functional role? */
IsFunctionalRole;
/**
* @type {boolean}
* @description Is the role an auto-accept role? */
IsRequestAutoAccepted;
/**
* @type {string}
* @description Suite that the role belongs to */
SuiteId;
/**
* @type {string}
* @description Suite that the role belongs to */
SuiteName;
/**
* @type {string}
* @description 'A' (Active) or 'I' (Inactive) */
RecordStatus;
/**
* @type {string}
* @description Object Connection Id, which is populated when the roles are returned based on those that are connected to an object. */
ObjectConnectionId;
}
export class ContactGroupConnectionModel extends UserProfileSummaryModel {
/** @param {{ContactGroupId?:string,ContactGroupConnectionId?:string,ConnectionRoleId?:string,Index?:number,ContactRoles?:RoleModel[],UserProfileId?:string,UserId?:string,ContactId?:string,UserName?:string,ProfileName?:string,ContactFullName?:string,EmailAddress?:string,EmailSignature?:string,MobileNumber?:string,PhoneNumber?:string,ContactTypeId?:string,ContactTypeName?:string,FirstName?:string,Surname?:string,Title?:string,LegalName?:string,TradingName?:string,Abn?:string,Acn?:string,Arbn?:string,GstRegistered?:boolean,ESL?:boolean,Language?:string,InterpreterRequired?:boolean,LicenseeNotes?:string,ProfilePhotoUrl?:string,ProfilePhotoThumbnailUrl?:string,ProfileImageId?:string,Description?:string,EmploymentIndustry?:string,EmploymentRole?:string,EmploymentGeographicArea?:string,Timezone?:string,TimezoneName?:string,PrimaryAddress?:string,IsActiveContact?:boolean}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Contact Group Id */
ContactGroupId;
/**
* @type {string}
* @description Connection id of the contact in the group */
ContactGroupConnectionId;
/**
* @type {string}
* @description The Id of the Role this contact is connected to the group with. */
ConnectionRoleId;
/**
* @type {number}
* @description Order of contacts within a group, the primary contact will have an index of 1. */
Index;
/**
* @type {RoleModel[]}
* @description List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc. */
ContactRoles;
}
export class CustomerProjectModel {
/** @param {{ProjectId?:string,Name?:string,ProjectAddress?:string,ManagerContactId?:string,ManagerContactName?:string,ManagerProfilePhotoUrl?:string,ManagerProfilePhotoThumbnailUrl?:string,SupervisorContactId?:string,SupervisorContactName?:string,SupervisorProfilePhotoUrl?:string,SupervisorProfilePhotoThumbnailUrl?:string,CustomerServiceContactId?:string,CustomerServiceContactName?:string,CustomerServiceProfilePhotoUrl?:string,CustomerServiceProfilePhotoThumbnail?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ProjectId;
/** @type {string} */
Name;
/** @type {string} */
ProjectAddress;
/** @type {?string} */
ManagerContactId;
/** @type {string} */
ManagerContactName;
/** @type {string} */
ManagerProfilePhotoUrl;
/** @type {string} */
ManagerProfilePhotoThumbnailUrl;
/** @type {?string} */
SupervisorContactId;
/** @type {string} */
SupervisorContactName;
/** @type {string} */
SupervisorProfilePhotoUrl;
/** @type {string} */
SupervisorProfilePhotoThumbnailUrl;
/** @type {?string} */
CustomerServiceContactId;
/** @type {string} */
CustomerServiceContactName;
/** @type {string} */
CustomerServiceProfilePhotoUrl;
/** @type {string} */
CustomerServiceProfilePhotoThumbnail;
}
export class ContactGroupModel {
/** @param {{ContactGroupId?:string,Name?:string,Reference?:string,GroupRoleId?:string,PrimaryContactName?:string,PrimaryContactId?:string,PrimaryContactPhotoUrl?:string,PrimaryContactThumbnailUrl?:string,NumberOfContacts?:number,RecordStatus?:string,Contacts?:ContactGroupConnectionModel[],Projects?:CustomerProjectModel[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Contact Group Id */
ContactGroupId;
/**
* @type {string}
* @description Contact Group Name */
Name;
/**
* @type {string}
* @description Contact Group Reference */
Reference;
/**
* @type {string}
* @description Group Role Id for e.g. Customer */
GroupRoleId;
/**
* @type {string}
* @description Primary contact in the group */
PrimaryContactName;
/**
* @type {string}
* @description Contact Id of the primary contact in the group */
PrimaryContactId;
/**
* @type {string}
* @description Profile photo url of the primary contact in the group */
PrimaryContactPhotoUrl;
/**
* @type {string}
* @description Profile photo thumbnail url of the primary contact in the group */
PrimaryContactThumbnailUrl;
/**
* @type {number}
* @description Number of contacts in the group */
NumberOfContacts;
/**
* @type {string}
* @description Record Status of contact group */
RecordStatus;
/**
* @type {ContactGroupConnectionModel[]}
* @description Details of contact in the contact group */
Contacts;
/**
* @type {CustomerProjectModel[]}
* @description Details of projects for the contact group */
Projects;
}
export class GetContactGroupResponse {
/** @param {{ContactGroup?:ContactGroupModel,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ContactGroupModel} */
ContactGroup;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetContactGroup {
/** @param {{ContactGroupId?:string,ContactGroupRoleId?:string,IncludeProjects?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Get details of the specified contact group including details of contacts in the group */
ContactGroupId;
/**
* @type {string}
* @description The type of ContactGroup to get. */
ContactGroupRoleId;
/**
* @type {boolean}
* @description Include projects linked to the contact group? */
IncludeProjects;
}
JavaScript GetContactGroup DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contactgroup/{ContactGroupId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ContactGroupId":"00000000-0000-0000-0000-000000000000","ContactGroupRoleId":"00000000-0000-0000-0000-000000000000","IncludeProjects":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ContactGroup":{"ContactGroupId":"00000000-0000-0000-0000-000000000000","Name":"String","Reference":"String","GroupRoleId":"00000000-0000-0000-0000-000000000000","PrimaryContactName":"String","PrimaryContactId":"00000000-0000-0000-0000-000000000000","PrimaryContactPhotoUrl":"String","PrimaryContactThumbnailUrl":"String","NumberOfContacts":0,"RecordStatus":"String","Contacts":[{"ContactGroupId":"00000000-0000-0000-0000-000000000000","ContactGroupConnectionId":"00000000-0000-0000-0000-000000000000","ConnectionRoleId":"00000000-0000-0000-0000-000000000000","Index":0,"ContactRoles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","IsLicenseeRole":false,"IsManageContacts":false,"IsPlatformRole":false,"IsServiceRole":false,"IsCustomerRole":false,"IsFunctionalRole":false,"IsRequestAutoAccepted":false,"SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","RecordStatus":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000"}],"UserProfileId":"00000000-0000-0000-0000-000000000000","UserId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","UserName":"String","ProfileName":"String","ContactFullName":"String","EmailAddress":"String","EmailSignature":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ContactTypeName":"String","FirstName":"String","Surname":"String","Title":"String","LegalName":"String","TradingName":"String","Abn":"String","Acn":"String","Arbn":"String","GstRegistered":false,"ESL":false,"Language":"String","InterpreterRequired":false,"LicenseeNotes":"String","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","ProfileImageId":"00000000-0000-0000-0000-000000000000","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","Timezone":"00000000-0000-0000-0000-000000000000","TimezoneName":"String","PrimaryAddress":"String","IsActiveContact":false}],"Projects":[{"ProjectId":"00000000-0000-0000-0000-000000000000","Name":"String","ProjectAddress":"String","ManagerContactId":"00000000000000000000000000000000","ManagerContactName":"String","ManagerProfilePhotoUrl":"String","ManagerProfilePhotoThumbnailUrl":"String","SupervisorContactId":"00000000000000000000000000000000","SupervisorContactName":"String","SupervisorProfilePhotoUrl":"String","SupervisorProfilePhotoThumbnailUrl":"String","CustomerServiceContactId":"00000000000000000000000000000000","CustomerServiceContactName":"String","CustomerServiceProfilePhotoUrl":"String","CustomerServiceProfilePhotoThumbnail":"String"}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}