Platform API

<back to all web services

GetAssociatedRolesForRole

Get associated roles for a specified role

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models

Namespace Global

    Namespace Eros.Saguna.Common.WebAPIModel.Models

        Public Partial Class RoleModel
            '''<Summary>
            '''Role Id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Role Id", IsRequired:=true, Name:="RoleId")>
            Public Overridable Property RoleId As Guid

            '''<Summary>
            '''Role Name
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Role Name", Name:="RoleName")>
            Public Overridable Property RoleName As String

            '''<Summary>
            '''Is the role a licensee role?
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="Is the role a licensee role?", Name:="IsLicensee")>
            Public Overridable Property IsLicenseeRole As Boolean

            '''<Summary>
            '''Is manage contacts role?
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="Is manage contacts role?", Name:="IsManageContacts")>
            Public Overridable Property IsManageContacts As Boolean

            '''<Summary>
            '''Is the role a Platform role?
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="Is the role a Platform role?", Name:="IsPlatformRole")>
            Public Overridable Property IsPlatformRole As Boolean

            '''<Summary>
            '''Is the role a services role?
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="Is the role a services role?", Name:="IsServiceRole")>
            Public Overridable Property IsServiceRole As Boolean

            '''<Summary>
            '''Is the role a customer role?
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="Is the role a customer role?", Name:="IsCustomerRole")>
            Public Overridable Property IsCustomerRole As Boolean

            '''<Summary>
            '''Is the role a functional role?
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="Is the role a functional role?", Name:="IsFunctionalRole")>
            Public Overridable Property IsFunctionalRole As Boolean

            '''<Summary>
            '''Is the role an auto-accept role?
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="Is the role an auto-accept role?", Name:="IsRequestAutoAccepted")>
            Public Overridable Property IsRequestAutoAccepted As Boolean

            '''<Summary>
            '''Suite that the role belongs to
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Suite that the role belongs to", Name:="SuiteId")>
            Public Overridable Property SuiteId As Guid

            '''<Summary>
            '''Suite that the role belongs to
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Suite that the role belongs to", Name:="SuiteName")>
            Public Overridable Property SuiteName As String

            '''<Summary>
            ''''A' (Active) or 'I' (Inactive)
            '''</Summary>
            <ApiMember(DataType:="string", Description:="'A' (Active) or 'I' (Inactive)", Name:="RecordStatus")>
            Public Overridable Property RecordStatus As String

            '''<Summary>
            '''Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
            '''</Summary>
            <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")>
            Public Overridable Property ObjectConnectionId As Guid
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get associated roles for a specified role
        '''</Summary>
        <Api(Description:="Get associated roles for a specified role")>
        Public Partial Class GetAssociatedRolesForRole
            '''<Summary>
            '''The  Role Guid. Records retrieved will belong to this role.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="The  Role Guid. Records retrieved will belong to this role.", IsRequired:=true, Name:="RoleId", ParameterType:="query")>
            Public Overridable Property RoleId As Guid
        End Class

        <ApiResponse(Description:="List of associated roles by contact type")>
        Public Partial Class GetAssociatedRolesForRoleResponse
            Public Overridable Property Roles As List(Of RoleModel)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetAssociatedRolesForRole DTOs

POST /api/roles/{RoleId}/associatedroles/safetystaff 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
		}
	}
}