Platform API

<back to all web services

GetContactRoleGroupDetails

Get details of the specified contact role group

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 RoleGroupModel
            '''<Summary>
            '''Role Group Id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Role Group Id", Name:="RoleGroupId")>
            Public Overridable Property RoleGroupId As Guid

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

            '''<Summary>
            '''Owner Contact Id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Owner Contact Id", Name:="OwnerContactId")>
            Public Overridable Property OwnerContactId As Guid

            '''<Summary>
            '''Number of Roles
            '''</Summary>
            <ApiMember(DataType:="int", Description:="Number of Roles", Name:="NumberOfRoles")>
            Public Overridable Property NumberOfRoles As Integer

            '''<Summary>
            '''Roles belonging to the Role Group
            '''</Summary>
            <ApiMember(DataType:="List", Description:="Roles belonging to the Role Group", Name:="Roles")>
            Public Overridable Property Roles As List(Of RoleGroupRolesModel)

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

            '''<Summary>
            '''True if Licensee-owned, allowing editing, deleting, archiving
            '''</Summary>
            <ApiMember(DataType:="bool", Description:="True if Licensee-owned, allowing editing, deleting, archiving", Name:="AllowEdit", ParameterType:="query")>
            Public Overridable Property AllowEdit As Boolean
        End Class

        Public Partial Class RoleGroupRolesModel
            '''<Summary>
            '''Role Id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Role Id", 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>
            '''Role Group Id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Role Group Id", Name:="RoleGroupId")>
            Public Overridable Property RoleGroupId As Guid

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

            '''<Summary>
            '''Role Group Role Id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Role Group Role Id", Name:="RoleGroupRoleId")>
            Public Overridable Property RoleGroupRoleId As Guid

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

            '''<Summary>
            '''Owner Contact Id
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Owner Contact Id", Name:="OwnerContactId")>
            Public Overridable Property OwnerContactId As Guid
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get details of the specified contact role group
        '''</Summary>
        <Api(Description:="Get details of the specified contact role group")>
        Public Partial Class GetContactRoleGroupDetails
            '''<Summary>
            '''The Contact Role Group Guid. Records retrieved will belong to this role group.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="The Contact Role Group Guid. Records retrieved will belong to this role group.", IsRequired:=true, Name:="ContactRoleGroupId", ParameterType:="query")>
            Public Overridable Property ContactRoleGroupId As Guid
        End Class

        <ApiResponse(Description:="Details of the specified contact role group")>
        Public Partial Class GetContactRoleGroupDetailsResponse
            Public Overridable Property ContactRoleGroup As RoleGroupModel
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetContactRoleGroupDetails DTOs

POST /api/contactrolegroup/{ContactRoleGroupId} 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

{
	ContactRoleGroup: 
	{
		Name: String,
		NumberOfRoles: 0,
		Roles: 
		[
			{
				RoleName: String,
				RoleGroupName: String,
				RecordStatus: String
			}
		],
		RecordStatus: String,
		AllowEdit: False
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}