Platform API

GetContactRoleGroupDetails

Get details of the specified contact role group

The following routes are available for this service:
All Verbs	/api/contactrolegroup/{ContactRoleGroupId}

**GetContactRoleGroupDetails** Parameters:
Name	Parameter	Data Type	Required	Description
ContactRoleGroupId	query	Guid	Yes	The Contact Role Group Guid. Records retrieved will belong to this role group.

**GetContactRoleGroupDetailsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ContactRoleGroup	form	RoleGroupModel	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/contactrolegroup/{ContactRoleGroupId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

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

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