Platform API

SearchContactsForRole

Search contacts by Name or Email Address, by Role Groups, or by Roles

The following routes are available for this service:
All Verbs	/api/searchcontactsforroles

**SearchContactsForRole** Parameters:
Name	Parameter	Data Type	Required	Description
SearchBy	query	Guid	Yes	Search type: by Name or Email Address, by Role Groups, or by Roles
Roles	query	List<Guid>	No	Roles that contacts are connected to.
RoleGroups	query	List<Guid>	No	Role Groups that contacts are connected to.
SearchText	query	string	No	For Search by Name or Email Address, filters contact results by this text value.
ExcludeRole	query	Guid	No	Excludes contacts already connected to this role.
ContactTypes	query	List<Guid>	No	Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.
IncludeDetails	query	Bool	No	Determines whether the contact details (Email, mobile number etc.) to be returned.

**SearchContactsForRoleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Contacts	form	List<ContactSummaryModel>	No
ResponseStatus	form	ResponseStatus	No

**ContactSummaryModel** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	form	Guid	No	Contact linked to the profile
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
MobileNumber	form	string	No	Mobile Number of the contact linked to the profile
PhoneNumber	form	string	No	Primary Phone Number of the contact linked to the profile
ContactTypeId	form	string	No	Type of contact (person, organisation etc.) linked to the profile
ProfilePhotoUrl	form	string	No	Profile photo of contact linked to the profile
ProfilePhotoThumbnailUrl	form	string	No	Thumbnail photo 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
TimezoneName	query	string	No	Timezone Name
PrimaryAddress	query	string	No	The primary address of the contact
IsRemovedContact	form	bool	No	Have all connections to the contact been removed?

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/searchcontactsforroles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Roles: 
	[
		00000000-0000-0000-0000-000000000000
	],
	RoleGroups: 
	[
		00000000-0000-0000-0000-000000000000
	],
	SearchText: String,
	ContactTypes: 
	[
		00000000-0000-0000-0000-000000000000
	],
	IncludeDetails: False
}

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

{
	Contacts: 
	[
		{
			ContactFullName: String,
			EmailAddress: String,
			MobileNumber: String,
			PhoneNumber: String,
			ProfilePhotoUrl: String,
			ProfilePhotoThumbnailUrl: String,
			Description: String,
			EmploymentIndustry: String,
			EmploymentRole: String,
			EmploymentGeographicArea: String,
			TimezoneName: String,
			PrimaryAddress: String,
			IsRemovedContact: False
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}