Platform API

AddContactGroup

Create new contact group

The following routes are available for this service:
POST	/api/contactgroups

**AddContactGroup** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerName	body	string	No	Contact group name to be created
NameTypeId	body	Guid	No
Contacts	body	List<ContactGroupConnectionModel>	No
RecordStatus	body	string	No

**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.

**AddContactGroupResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ContactGroupId	form	Guid	No
ResponseStatus	form	ResponseStatus	No

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CustomerName: String,
	Contacts: 
	[
		{
			Index: 0,
			ContactRoles: 
			[
				{
					RoleName: String,
					IsLicenseeRole: False,
					IsManageContacts: False,
					IsPlatformRole: False,
					IsServiceRole: False,
					IsCustomerRole: False,
					IsFunctionalRole: False,
					IsRequestAutoAccepted: False,
					SuiteName: String,
					RecordStatus: String
				}
			],
			UserName: String,
			ProfileName: String,
			ContactFullName: String,
			EmailAddress: String,
			EmailSignature: String,
			MobileNumber: String,
			PhoneNumber: String,
			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,
			Description: String,
			EmploymentIndustry: String,
			EmploymentRole: String,
			EmploymentGeographicArea: String,
			TimezoneName: String,
			PrimaryAddress: String,
			IsActiveContact: False
		}
	],
	RecordStatus: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}