Platform API

UpdateRoleWithSharing

Updates a Role record, and updates Sharing.

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Updates a Role record, and updates Sharing.
*/
@Api(Description="Updates a Role record, and updates Sharing.")
open class UpdateRoleWithSharing
{
    /**
    * Details of the Contact Role to be Updated.
    */
    @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Updated.", IsRequired=true, Name="RoleDetails", ParameterType="query")
    open var RoleDetails:RoleDetailsModel? = null

    /**
    * 
    */
    @ApiMember(DataType="FormCollection", Description="", Name="Form", ParameterType="query")
    open var Form:FormCollection? = null

    /**
    * List of Object Share details.
    */
    @ApiMember(DataType="List<ObjectShareModel>", Description="List of Object Share details.", Name="ShareList", ParameterType="query")
    open var ShareList:ArrayList<ObjectShareModel>? = null
}

open class RoleDetailsModel
{
    /**
    * Role Id
    */
    @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    open var RoleId:UUID? = null

    /**
    * Role Name
    */
    @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    open var RoleName:String? = null

    /**
    * Role Connection Definition Id
    */
    @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
    open var RoleConnectionDefinitionId:UUID? = null

    /**
    * Contact Types the Role applies to
    */
    @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
    open var ContactTypes:ArrayList<UUID>? = null

    /**
    * Does the role require contacts to accept it?
    */
    @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
    open var RequireContactsToAccept:Boolean? = null

    /**
    * Filters linked to the custom role.
    */
    @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
    open var ListItemFilters:ArrayList<ListItemFilterModel>? = null
}

open class ListItemFilterModel
{
    open var ListItemFilterId:UUID? = null
    open var FilterName:String? = null
    open var ListId:UUID? = null
    open var ListItemId:UUID? = null
    open var ListItemIsInFilter:Boolean? = null
}

open class ObjectShareModel
{
    open var ObjectShareId:UUID? = null
    open var ObjectId:UUID? = null
    open var ObjectName:String? = null
    open var Name:String? = null
    open var Description:String? = null
    open var Reference:String? = null
    open var ContactId:UUID? = null
    open var ContactName:String? = null
    open var ContactType:String? = null
    open var ContactImageUrlPrimary:String? = null
    open var ContactImageUrlPrimaryThmbnail:String? = null
    open var ShareStatusId:UUID? = null
    open var ShareStatusName:String? = null
}

Kotlin UpdateRoleWithSharing DTOs

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