Platform API

GetPagedContactsInRole

The following routes are available for this service:
All Verbs	/api/contacts/paged/{RoleId}

**GetPagedContactsInRole** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	path	Guid	No	Get contacts connected to the current licensee in the specified role
ContactTypes	query	List<Guid>	No	Get contacts of the specified type
Statuses	query	List<Guid>	Yes	Contact statuses to search for, i.e. Real and/or Virtual
SearchText	query	string	No	Text to filter contacts on. searches for a contact with matches to the string.
IncludeDetails	query	bool?	No	If you want just bare-bones contact info set this to false, if not specified it defaults to true.

**PagedModel** Parameters:
Name	Parameter	Data Type	Required	Description
PageNumber	form	int	No	Page Number to retrieve
PageSize	form	int	No	Number of records to retrieve
SortIndex	form	int	No	Index of field to sort results by
SortOrder	form	int	No	Sort Order - Ascending or Descending

**SortOrder** Enum:
Ascending
Descending

**GetSlimContactsResponse** Parameters:
Name	Parameter	Data Type	Required
Contacts	form	List<ContactSummaryModel>	No
TotalContacts	form	int	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/contacts/paged/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ContactTypes: 
	[
		00000000-0000-0000-0000-000000000000
	],
	Statuses: 
	[
		00000000-0000-0000-0000-000000000000
	],
	SearchText: String,
	IncludeDetails: False,
	PageNumber: 0,
	PageSize: 0,
	SortIndex: 0,
	SortOrder: Ascending
}

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
		}
	],
	TotalContacts: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}