Platform API

<back to all web services

GetContactRoleGroupDetails

Get details of the specified contact role group

Requires Authentication
The following routes are available for this service:
All Verbs/api/contactrolegroup/{ContactRoleGroupId}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RoleGroupRolesModel() = 
        ///<summary>
        ///Role Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")>]
        member val RoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Role Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Role Name", Name="RoleName")>]
        member val RoleName:String = null with get,set

        ///<summary>
        ///Role Group Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")>]
        member val RoleGroupId:Guid = new Guid() with get,set

        ///<summary>
        ///Role Group Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")>]
        member val RoleGroupName:String = null with get,set

        ///<summary>
        ///Role Group Role Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")>]
        member val RoleGroupRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///'A' (Active), 'I' (Inactive)
        ///</summary>
        [<ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")>]
        member val RecordStatus:String = null with get,set

        ///<summary>
        ///Owner Contact Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")>]
        member val OwnerContactId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type RoleGroupModel() = 
        ///<summary>
        ///Role Group Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")>]
        member val RoleGroupId:Guid = new Guid() with get,set

        ///<summary>
        ///Role Group Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Role Group Name", Name="Name")>]
        member val Name:String = null with get,set

        ///<summary>
        ///Owner Contact Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")>]
        member val OwnerContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Number of Roles
        ///</summary>
        [<ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")>]
        member val NumberOfRoles:Int32 = new Int32() with get,set

        ///<summary>
        ///Roles belonging to the Role Group
        ///</summary>
        [<ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")>]
        member val Roles:ResizeArray<RoleGroupRolesModel> = null with get,set

        ///<summary>
        ///'A' (Active), 'I' (Inactive)
        ///</summary>
        [<ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")>]
        member val RecordStatus:String = null with get,set

        ///<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")>]
        member val AllowEdit:Boolean = new Boolean() with get,set

    [<ApiResponse(Description="Details of the specified contact role group")>]
    [<AllowNullLiteral>]
    type GetContactRoleGroupDetailsResponse() = 
        member val ContactRoleGroup:RoleGroupModel = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get details of the specified contact role group
    ///</summary>
    [<Api(Description="Get details of the specified contact role group")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ContactRoleGroupId:Guid = new Guid() with get,set

F# 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>