Platform API

GetRolesForContact

Get roles for the specified contact

The following routes are available for this service:
All Verbs	/api/roles/{ContactId}
All Verbs	/api/resourceroles/available/{ContactId}
All Verbs	/api/resourceroles/licensee/{RoleListItemFilterId}
All Verbs	/api/resourceroles/licensee
All Verbs	/api/licenseeroles/{ContactId}

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


/**
* Get roles for the specified contact
*/
@Api(Description="Get roles for the specified contact")
open class GetRolesForContact
{
    /**
    * Get roles (custom and standard roles) for the specified contact
    */
    @ApiMember(Description="Get roles (custom and standard roles) for the specified contact", IsRequired=true, Name="ContactId")
    open var ContactId:UUID? = null

    /**
    * List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter}
    */
    @ApiMember(Description="List Item Filter to use on the roles. Applicable to route /resourceroles/licensee/{RoleListItemFilter}", IsRequired=true, Name="RoleListItemFilterId")
    open var RoleListItemFilterId:UUID? = null
}

@ApiResponse(Description="List of roles")
open class GetRolesResponse
{
    open var Roles:ArrayList<RoleModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

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

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

    /**
    * Is the role a licensee role?
    */
    @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
    open var IsLicenseeRole:Boolean? = null

    /**
    * Is manage contacts role?
    */
    @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
    open var IsManageContacts:Boolean? = null

    /**
    * Is the role a Platform role?
    */
    @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
    open var IsPlatformRole:Boolean? = null

    /**
    * Is the role a services role?
    */
    @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
    open var IsServiceRole:Boolean? = null

    /**
    * Is the role a customer role?
    */
    @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
    open var IsCustomerRole:Boolean? = null

    /**
    * Is the role a functional role?
    */
    @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
    open var IsFunctionalRole:Boolean? = null

    /**
    * Is the role an auto-accept role?
    */
    @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
    open var IsRequestAutoAccepted:Boolean? = null

    /**
    * Suite that the role belongs to
    */
    @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
    open var SuiteId:UUID? = null

    /**
    * Suite that the role belongs to
    */
    @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
    open var SuiteName:String? = null

    /**
    * 'A' (Active) or 'I' (Inactive)
    */
    @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
    open var RecordStatus:String? = null

    /**
    * Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
    */
    @ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")
    open var ObjectConnectionId:UUID? = null
}

Kotlin GetRolesForContact 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.

POST /api/roles/{ContactId} 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

{
	Roles: 
	[
		{
			RoleName: String,
			IsLicenseeRole: False,
			IsManageContacts: False,
			IsPlatformRole: False,
			IsServiceRole: False,
			IsCustomerRole: False,
			IsFunctionalRole: False,
			IsRequestAutoAccepted: False,
			SuiteName: String,
			RecordStatus: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}