Platform API

GetContactRoleGroups

Get role groups for the given criteria

The following routes are available for this service:
All Verbs	/api/contactrolegroups/{LicenseeId}

**GetContactRoleGroups** Parameters:
Name	Parameter	Data Type	Required	Description
LicenseeId	query	Guid	Yes	Get contact role groups for the specified licensee
Name	query	string	No	Role Group Name
RecordStatus	query	string	No	Active/Archived filter

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

**GetContactRoleGroupsResponse** Parameters:
Name	Parameter	Data Type	Required
RoleGroups	form	List<RoleGroupModel>	No
TotalRoleGroups	form	int	No
ResponseStatus	form	ResponseStatus	No

**RoleGroupModel** Parameters:
Name	Parameter	Data Type	Required	Description
RoleGroupId	form	Guid	No	Role Group Id
Name	form	string	No	Role Group Name
OwnerContactId	form	Guid	No	Owner Contact Id
NumberOfRoles	form	int	No	Number of Roles
Roles	form	List	No	Roles belonging to the Role Group
RecordStatus	form	string	No	'A' (Active), 'I' (Inactive)
AllowEdit	query	bool	No	True if Licensee-owned, allowing editing, deleting, archiving

**RoleGroupRolesModel** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	form	Guid	No	Role Id
RoleName	form	string	No	Role Name
RoleGroupId	form	Guid	No	Role Group Id
RoleGroupName	form	string	No	Role Group Name
RoleGroupRoleId	form	Guid	No	Role Group Role Id
RecordStatus	form	string	No	'A' (Active), 'I' (Inactive)
OwnerContactId	form	Guid	No	Owner Contact Id

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

{
	Name: String,
	RecordStatus: String,
	PageNumber: 0,
	PageSize: 0,
	SortIndex: 0,
	SortOrder: Ascending
}

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

{
	RoleGroups: 
	[
		{
			Name: String,
			NumberOfRoles: 0,
			Roles: 
			[
				{
					RoleName: String,
					RoleGroupName: String,
					RecordStatus: String
				}
			],
			RecordStatus: String,
			AllowEdit: False
		}
	],
	TotalRoleGroups: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}