Platform API

GetContactGroup

Get details of the specified contact group

The following routes are available for this service:
All Verbs	/api/contactgroup/{ContactGroupId}

**GetContactGroup** Parameters:
Name	Parameter	Data Type	Required	Description
ContactGroupId	path	Guid	No	Get details of the specified contact group including details of contacts in the group
ContactGroupRoleId	query	Guid	No	The type of ContactGroup to get.
IncludeProjects	query	bool	No	Include projects linked to the contact group?

**GetContactGroupResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ContactGroup	form	ContactGroupModel	No
ResponseStatus	form	ResponseStatus	No

**ContactGroupModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactGroupId	form	Guid	No	Contact Group Id
Name	form	string	No	Contact Group Name
Reference	form	string	No	Contact Group Reference
GroupRoleId	form	Guid	No	Group Role Id for e.g. Customer
PrimaryContactName	form	string	No	Primary contact in the group
PrimaryContactId	form	Guid	No	Contact Id of the primary contact in the group
PrimaryContactPhotoUrl	form	string	No	Profile photo url of the primary contact in the group
PrimaryContactThumbnailUrl	form	string	No	Profile photo thumbnail url of the primary contact in the group
NumberOfContacts	form	int	No	Number of contacts in the group
RecordStatus	form	string	No	Record Status of contact group
Contacts	form	List	No	Details of contact in the contact group
Projects	form	List	No	Details of projects for the contact group

**ContactGroupConnectionModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactGroupId	form	Guid	No	Contact Group Id
ContactGroupConnectionId	form	string	No	Connection id of the contact in the group
ConnectionRoleId	form	string	No	The Id of the Role this contact is connected to the group with.
Index	form	int	No	Order of contacts within a group, the primary contact will have an index of 1.
ContactRoles	form	string	No	List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.

**UserProfileSummaryModel** Parameters:
Name	Parameter	Data Type	Required	Description
UserProfileId	form	Guid	No	User Profile Id
UserId	form	Guid	No	User linked to the profile
ContactId	form	Guid	No	Contact linked to the profile
UserName	form	string	No	User linked to the profile
ProfileName	form	string	No	User Profile Name
ContactFullName	form	string	No	Full name of the contact linked to the profile
EmailAddress	form	string	No	Email Address of the contact linked to the profile
EmailSignature	form	string	No	Email signature of the contact linked to the profile
MobileNumber	form	string	No	Mobile number of the contact linked to the profile
PhoneNumber	form	string	No	Phone number of the contact linked to the profile
ContactTypeId	form	string	No	Type of contact (person, organisation etc.) linked to the profile
ContactTypeName	form	string	No	Type of contact (person, organisation etc.) linked to the profile
FirstName	form	string	No	First name of the contact linked to the profile
Surname	form	string	No	Surname of the contact linked to the profile
Title	form	string	No	Title of contact linked to the profile
LegalName	form	string	No	Legal name of contact linked to the profile
TradingName	form	string	No	Trading name of contact linked to the profile
Abn	query	string	No	Australian Business Number
Acn	query	string	No	Australian Company Number
Arbn	query	string	No	Australian Registered Body Number
GstRegistered	query	bool	No	Indicates if the Contact is registered for GST.
ESL	query	bool	No	True if english is a secondary language for the contact.
Language	query	string	No	Language that is the primary language for the contact.
InterpreterRequired	query	bool	No	True if an interpreter is required.
LicenseeNotes	query	string	No	Licensee specific notes about the contact.
ProfilePhotoUrl	form	string	No	Profile photo of contact linked to the profile
ProfilePhotoThumbnailUrl	form	string	No	Thumbnail photo of contact linked to the profile
ProfileImageId	form	Guid	No	Profile photo id of contact linked to the profile
Description	form	string	No	Profile description
EmploymentIndustry	form	string	No	Employment Industry
EmploymentRole	form	string	No	Employment Role
EmploymentGeographicArea	form	string	No	Areas of Work
Timezone	query	Guid	No	The contacts timezone.
TimezoneName	query	string	No	Timezone Name
PrimaryAddress	query	string	No	The primary address of the contact
IsActiveContact	form	bool	No	Is this an active contact? Or an inactive contact (deleted account)?

**RoleModel** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	form	Guid	Yes	Role Id
RoleName	form	string	No	Role Name
IsLicenseeRole	form	bool	No	Is the role a licensee role?
IsManageContacts	form	bool	No	Is manage contacts role?
IsPlatformRole	form	bool	No	Is the role a Platform role?
IsServiceRole	form	bool	No	Is the role a services role?
IsCustomerRole	form	bool	No	Is the role a customer role?
IsFunctionalRole	form	bool	No	Is the role a functional role?
IsRequestAutoAccepted	form	bool	No	Is the role an auto-accept role?
SuiteId	form	Guid	No	Suite that the role belongs to
SuiteName	form	string	No	Suite that the role belongs to
RecordStatus	form	string	No	'A' (Active) or 'I' (Inactive)
ObjectConnectionId	form	Guid	No	Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.

**CustomerProjectModel** Parameters:
Name	Parameter	Data Type	Required
ProjectId	form	Guid	No
Name	form	string	No
ProjectAddress	form	string	No
ManagerContactId	form	Guid?	No
ManagerContactName	form	string	No
ManagerProfilePhotoUrl	form	string	No
ManagerProfilePhotoThumbnailUrl	form	string	No
SupervisorContactId	form	Guid?	No
SupervisorContactName	form	string	No
SupervisorProfilePhotoUrl	form	string	No
SupervisorProfilePhotoThumbnailUrl	form	string	No
CustomerServiceContactId	form	Guid?	No
CustomerServiceContactName	form	string	No
CustomerServiceProfilePhotoUrl	form	string	No
CustomerServiceProfilePhotoThumbnail	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetContactGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactGroupId>00000000-0000-0000-0000-000000000000</ContactGroupId>
  <ContactGroupRoleId>00000000-0000-0000-0000-000000000000</ContactGroupRoleId>
  <IncludeProjects>false</IncludeProjects>
</GetContactGroup>

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

<GetContactGroupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactGroup xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <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>
  </ContactGroup>
  <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>
</GetContactGroupResponse>