| All Verbs | /api/contactgroup/{ContactGroupId} |
|---|
| 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? |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactGroup | form | ContactGroupModel | No | |
| ResponseStatus | form | ResponseStatus | No |
| 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 |
| 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. |
| 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)? |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"ContactGroupId":"00000000-0000-0000-0000-000000000000","ContactGroupRoleId":"00000000-0000-0000-0000-000000000000","IncludeProjects":false}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}