| All Verbs | /api/contactgroups | ||
|---|---|---|---|
| All Verbs | /api/contactgroups/{ContactId} |
"use strict";
/** @typedef {'Ascending'|'Descending'} */
export var SortOrder;
(function (SortOrder) {
SortOrder["Ascending"] = "Ascending"
SortOrder["Descending"] = "Descending"
})(SortOrder || (SortOrder = {}));
export class PagedModel {
/** @param {{PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Page Number to retrieve */
PageNumber;
/**
* @type {number}
* @description Number of records to retrieve */
PageSize;
/**
* @type {number}
* @description Index of field to sort results by */
SortIndex;
/**
* @type {SortOrder}
* @description Sort Order - Ascending or Descending */
SortOrder;
}
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 GetContactGroupsResponse {
/** @param {{ContactGroups?:ContactGroupModel[],TotalGroups?:number,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ContactGroupModel[]} */
ContactGroups;
/**
* @type {number}
* @description Count of total groups. */
TotalGroups;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetContactGroups extends PagedModel {
/** @param {{ContactId?:string,SearchText?:string,ContactGroupRoleId?:string,IncludeActive?:boolean,IncludeArchived?:boolean,PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Get contactGroups for the specified contact */
ContactId;
/**
* @type {string}
* @description Specific search text to search for i.e. Contact Name, Employment Details etc. */
SearchText;
/**
* @type {string}
* @description Set the Contact Group Role Id to only retrieve groups of that type. If ContactId is not set this is mandatory. */
ContactGroupRoleId;
/**
* @type {boolean}
* @description Include active contact groups */
IncludeActive;
/**
* @type {boolean}
* @description Include archived contact groups */
IncludeArchived;
}
JavaScript GetContactGroups DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contactgroups HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<PageNumber xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageNumber>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageSize>
<SortIndex xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</SortIndex>
<SortOrder xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">Ascending</SortOrder>
<ContactGroupRoleId>00000000-0000-0000-0000-000000000000</ContactGroupRoleId>
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<IncludeActive>false</IncludeActive>
<IncludeArchived>false</IncludeArchived>
<SearchText>String</SearchText>
</GetContactGroups>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:ContactGroupModel>
<d2p1:ContactGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupId>
<d2p1:Contacts>
<d2p1:ContactGroupConnectionModel>
<d2p1:Abn>String</d2p1:Abn>
<d2p1:Acn>String</d2p1:Acn>
<d2p1:Arbn>String</d2p1:Arbn>
<d2p1:ContactFullName>String</d2p1:ContactFullName>
<d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
<d2p1:ContactTypeId>00000000-0000-0000-0000-000000000000</d2p1:ContactTypeId>
<d2p1:ContactTypeName>String</d2p1:ContactTypeName>
<d2p1:Description>String</d2p1:Description>
<d2p1:ESL>false</d2p1:ESL>
<d2p1:EmailAddress>String</d2p1:EmailAddress>
<d2p1:EmailSignature>String</d2p1:EmailSignature>
<d2p1:EmploymentGeographicArea>String</d2p1:EmploymentGeographicArea>
<d2p1:EmploymentIndustry>String</d2p1:EmploymentIndustry>
<d2p1:EmploymentRole>String</d2p1:EmploymentRole>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:GstRegistered>false</d2p1:GstRegistered>
<d2p1:InterpreterRequired>false</d2p1:InterpreterRequired>
<d2p1:IsActiveContact>false</d2p1:IsActiveContact>
<d2p1:Language>String</d2p1:Language>
<d2p1:LegalName>String</d2p1:LegalName>
<d2p1:LicenseeNotes>String</d2p1:LicenseeNotes>
<d2p1:MobileNumber>String</d2p1:MobileNumber>
<d2p1:PhoneNumber>String</d2p1:PhoneNumber>
<d2p1:PrimaryAddress>String</d2p1:PrimaryAddress>
<d2p1:ProfileImageId>00000000-0000-0000-0000-000000000000</d2p1:ProfileImageId>
<d2p1:ProfileName>String</d2p1:ProfileName>
<d2p1:ProfilePhotoThumbnailUrl>String</d2p1:ProfilePhotoThumbnailUrl>
<d2p1:ProfilePhotoUrl>String</d2p1:ProfilePhotoUrl>
<d2p1:Surname>String</d2p1:Surname>
<d2p1:Timezone>00000000-0000-0000-0000-000000000000</d2p1:Timezone>
<d2p1:TimezoneName>String</d2p1:TimezoneName>
<d2p1:Title>String</d2p1:Title>
<d2p1:TradingName>String</d2p1:TradingName>
<d2p1:UserId>00000000-0000-0000-0000-000000000000</d2p1:UserId>
<d2p1:UserName>String</d2p1:UserName>
<d2p1:UserProfileId>00000000-0000-0000-0000-000000000000</d2p1:UserProfileId>
<d2p1:ConnectionRoleId>00000000-0000-0000-0000-000000000000</d2p1:ConnectionRoleId>
<d2p1:ContactGroupConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupConnectionId>
<d2p1:ContactGroupId>00000000-0000-0000-0000-000000000000</d2p1:ContactGroupId>
<d2p1:ContactRoles>
<d2p1:RoleModel>
<d2p1:IsCustomerRole>false</d2p1:IsCustomerRole>
<d2p1:IsFunctionalRole>false</d2p1:IsFunctionalRole>
<d2p1:IsLicenseeRole>false</d2p1:IsLicenseeRole>
<d2p1:IsManageContacts>false</d2p1:IsManageContacts>
<d2p1:IsPlatformRole>false</d2p1:IsPlatformRole>
<d2p1:IsRequestAutoAccepted>false</d2p1:IsRequestAutoAccepted>
<d2p1:IsServiceRole>false</d2p1:IsServiceRole>
<d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
<d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
<d2p1:SuiteName>String</d2p1:SuiteName>
</d2p1:RoleModel>
</d2p1:ContactRoles>
<d2p1:Index>0</d2p1:Index>
</d2p1:ContactGroupConnectionModel>
</d2p1:Contacts>
<d2p1:GroupRoleId>00000000-0000-0000-0000-000000000000</d2p1:GroupRoleId>
<d2p1:Name>String</d2p1:Name>
<d2p1:NumberOfContacts>0</d2p1:NumberOfContacts>
<d2p1:PrimaryContactId>00000000-0000-0000-0000-000000000000</d2p1:PrimaryContactId>
<d2p1:PrimaryContactName>String</d2p1:PrimaryContactName>
<d2p1:PrimaryContactPhotoUrl>String</d2p1:PrimaryContactPhotoUrl>
<d2p1:PrimaryContactThumbnailUrl>String</d2p1:PrimaryContactThumbnailUrl>
<d2p1:Projects>
<d2p1:CustomerProjectModel>
<d2p1:CustomerServiceContactId>00000000-0000-0000-0000-000000000000</d2p1:CustomerServiceContactId>
<d2p1:CustomerServiceContactName>String</d2p1:CustomerServiceContactName>
<d2p1:CustomerServiceProfilePhotoThumbnail>String</d2p1:CustomerServiceProfilePhotoThumbnail>
<d2p1:CustomerServiceProfilePhotoUrl>String</d2p1:CustomerServiceProfilePhotoUrl>
<d2p1:ManagerContactId>00000000-0000-0000-0000-000000000000</d2p1:ManagerContactId>
<d2p1:ManagerContactName>String</d2p1:ManagerContactName>
<d2p1:ManagerProfilePhotoThumbnailUrl>String</d2p1:ManagerProfilePhotoThumbnailUrl>
<d2p1:ManagerProfilePhotoUrl>String</d2p1:ManagerProfilePhotoUrl>
<d2p1:Name>String</d2p1:Name>
<d2p1:ProjectAddress>String</d2p1:ProjectAddress>
<d2p1:ProjectId>00000000-0000-0000-0000-000000000000</d2p1:ProjectId>
<d2p1:SupervisorContactId>00000000-0000-0000-0000-000000000000</d2p1:SupervisorContactId>
<d2p1:SupervisorContactName>String</d2p1:SupervisorContactName>
<d2p1:SupervisorProfilePhotoThumbnailUrl>String</d2p1:SupervisorProfilePhotoThumbnailUrl>
<d2p1:SupervisorProfilePhotoUrl>String</d2p1:SupervisorProfilePhotoUrl>
</d2p1:CustomerProjectModel>
</d2p1:Projects>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:Reference>String</d2p1:Reference>
</d2p1:ContactGroupModel>
</ContactGroups>
<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>
<TotalGroups>0</TotalGroups>
</GetContactGroupsResponse>