Platform API

GetContactRoleGroupDetails

Get details of the specified contact role group

The following routes are available for this service:
All Verbs	/api/contactrolegroup/{ContactRoleGroupId}

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

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

HTTP + XML

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

POST /api/contactrolegroup/{ContactRoleGroupId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetContactRoleGroupDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactRoleGroupId>00000000-0000-0000-0000-000000000000</ContactRoleGroupId>
</GetContactRoleGroupDetails>

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

<GetContactRoleGroupDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactRoleGroup xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:AllowEdit>false</d2p1:AllowEdit>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:NumberOfRoles>0</d2p1:NumberOfRoles>
    <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
    <d2p1:RecordStatus>String</d2p1:RecordStatus>
    <d2p1:RoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupId>
    <d2p1:Roles>
      <d2p1:RoleGroupRolesModel>
        <d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
        <d2p1:RecordStatus>String</d2p1:RecordStatus>
        <d2p1:RoleGroupId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupId>
        <d2p1:RoleGroupName>String</d2p1:RoleGroupName>
        <d2p1:RoleGroupRoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleGroupRoleId>
        <d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
        <d2p1:RoleName>String</d2p1:RoleName>
      </d2p1:RoleGroupRolesModel>
    </d2p1:Roles>
  </ContactRoleGroup>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetContactRoleGroupDetailsResponse>