Platform API

GetRolesForConnection

Get roles for the specified contact

The following routes are available for this service:
All Verbs	/api/roles/connection/{FromContactId}

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 GetRolesForConnection
{
    /**
    * Get roles available for connection from this contact
    */
    @ApiMember(Description="Get roles available for connection from this contact", IsRequired=true, Name="FromContactId")
    open var FromContactId:UUID? = null

    /**
    * Get roles available for connection to this contact
    */
    @ApiMember(Description="Get roles available for connection to this contact", Name="ContactId")
    open var ContactId:UUID? = null

    /**
    * Get roles available for connection for the specified contact type
    */
    @ApiMember(Description="Get roles available for connection for the specified contact type", IsRequired=true, Name="ContactTypeId")
    open var ContactTypeId:UUID? = null
}

@ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
open class GetRolesForConnectionResponse
{
    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 GetRolesForConnection DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/roles/connection/{FromContactId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FromContactId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000000000000000000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","IsLicenseeRole":false,"IsManageContacts":false,"IsPlatformRole":false,"IsServiceRole":false,"IsCustomerRole":false,"IsFunctionalRole":false,"IsRequestAutoAccepted":false,"SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","RecordStatus":"String","ObjectConnectionId":"00000000-0000-0000-0000-000000000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}