Platform API

<back to all web services

GetContactRoleGroups

Get role groups for the given criteria

Requires Authentication
The following routes are available for this service:
All Verbs/api/contactrolegroups/{LicenseeId}
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="List of role groups")>]
    [<AllowNullLiteral>]
    type GetContactRoleGroupsResponse() = 
        member val RoleGroups:ResizeArray<RoleGroupModel> = null with get,set
        member val TotalRoleGroups:Int32 = new Int32() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    type SortOrder =
        | Ascending = 0
        | Descending = 1

    [<AllowNullLiteral>]
    type PagedModel() = 
        ///<summary>
        ///Page Number to retrieve
        ///</summary>
        [<ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")>]
        member val PageNumber:Int32 = new Int32() with get,set

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

        ///<summary>
        ///Index of field to sort results by
        ///</summary>
        [<ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")>]
        member val SortIndex:Int32 = new Int32() with get,set

        ///<summary>
        ///Sort Order - Ascending or Descending
        ///</summary>
        [<ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")>]
        member val SortOrder:SortOrder = new SortOrder() with get,set

    ///<summary>
    ///Get role groups for the given criteria
    ///</summary>
    [<Api(Description="Get role groups for the given criteria")>]
    [<AllowNullLiteral>]
    type GetContactRoleGroups() = 
        inherit PagedModel()
        ///<summary>
        ///Get contact role groups for the specified licensee
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Get contact role groups for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")>]
        member val LicenseeId:Guid = new Guid() with get,set

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

        ///<summary>
        ///Active/Archived filter
        ///</summary>
        [<ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")>]
        member val RecordStatus:String = null with get,set

F# GetContactRoleGroups 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/contactrolegroups/{LicenseeId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetContactRoleGroups xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <PageNumber xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageNumber>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</PageSize>
  <SortIndex xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">0</SortIndex>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">Ascending</SortOrder>
  <LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
  <Name>String</Name>
  <RecordStatus>String</RecordStatus>
</GetContactRoleGroups>

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

<GetContactRoleGroupsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <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>
  <RoleGroups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
    <d2p1:RoleGroupModel>
      <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>
    </d2p1:RoleGroupModel>
  </RoleGroups>
  <TotalRoleGroups>0</TotalRoleGroups>
</GetContactRoleGroupsResponse>