Platform API

UpdateRoleWithSharing

Updates a Role record, and updates Sharing.

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

**UpdateRoleWithSharing** Parameters:
Name	Parameter	Data Type	Required	Description
RoleDetails	query	RoleDetailsModel	Yes	Details of the Contact Role to be Updated.
Form	query	FormCollection	No
ShareList	query	List<ObjectShareModel>	No	List of Object Share details.

**RoleDetailsModel** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	form	Guid	No	Role Id
RoleName	form	string	No	Role Name
RoleConnectionDefinitionId	form	Guid	No	Role Connection Definition Id
ContactTypes	form	List	No	Contact Types the Role applies to
RequireContactsToAccept	form	bool	No	Does the role require contacts to accept it?
ListItemFilters	form	List	No	Filters linked to the custom role.

**ListItemFilterModel** Parameters:
Name	Parameter	Data Type	Required
ListItemFilterId	form	Guid	No
FilterName	form	string	No
ListId	form	Guid	No
ListItemId	form	Guid	No
ListItemIsInFilter	form	bool	No

**ObjectShareModel** Parameters:
Name	Parameter	Data Type	Required
ObjectShareId	form	Guid	No
ObjectId	form	Guid	No
ObjectName	form	string	No
Name	form	string	No
Description	form	string	No
Reference	form	string	No
ContactId	form	Guid	No
ContactName	form	string	No
ContactType	form	string	No
ContactImageUrlPrimary	form	string	No
ContactImageUrlPrimaryThmbnail	form	string	No
ShareStatusId	form	Guid	No
ShareStatusName	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/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RoleDetails: 
	{
		RoleName: String,
		ContactTypes: 
		[
			00000000-0000-0000-0000-000000000000
		],
		RequireContactsToAccept: False,
		ListItemFilters: 
		[
			{
				FilterName: String,
				ListItemIsInFilter: False
			}
		]
	},
	Form: [],
	ShareList: 
	[
		{
			ObjectName: String,
			Name: String,
			Description: String,
			Reference: String,
			ContactName: String,
			ContactType: String,
			ContactImageUrlPrimary: String,
			ContactImageUrlPrimaryThmbnail: String,
			ShareStatusName: 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
	}
}