Platform API

UpdateContactRoleGroup

Update contact role group

The following routes are available for this service:
PUT	/api/contactrolegroups

**UpdateContactRoleGroup** Parameters:
Name	Parameter	Data Type	Required	Description
RoleGroupId	query	Guid	Yes	Guid of the Contact Role Group to be updated.
Name	query	string	Yes	Contact role group name to be updated
Roles	body	List<ListItemModel>	No

**ListItemModel** Parameters:
Name	Parameter	Data Type	Required
ListItemId	form	Guid	No
Name	form	string	No
Description	form	string	No
ShortName	form	string	No
IsDefault	form	bool	No
Order	form	int	No
ListItemTrafficLightId	form	Guid	No
PrimaryListItemImageId	form	Guid	No
PrimaryListItemImageUrl	form	string	No
PrimaryImageThumbnailUrl	form	string	No
OwnerContactId	form	Guid	No
RecordStatus	form	string	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.

PUT /api/contactrolegroups HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Roles: 
	[
		{
			Name: String,
			Description: String,
			ShortName: String,
			IsDefault: False,
			Order: 0,
			PrimaryListItemImageUrl: String,
			PrimaryImageThumbnailUrl: String,
			RecordStatus: String
		}
	]
}

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

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