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}

export enum SortOrder
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class PagedModel
{
    /** @description Page Number to retrieve */
    // @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    public PageNumber: number;

    /** @description Number of records to retrieve */
    // @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    public PageSize: number;

    /** @description Index of field to sort results by */
    // @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    public SortIndex: number;

    /** @description Sort Order - Ascending or Descending */
    // @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    public SortOrder: SortOrder;

    public constructor(init?: Partial<PagedModel>) { (Object as any).assign(this, init); }
}

export class RoleGroupRolesModel
{
    /** @description Role Id */
    // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    public RoleId: string;

    /** @description Role Name */
    // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    public RoleName: string;

    /** @description Role Group Id */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    public RoleGroupId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
    public RoleGroupName: string;

    /** @description Role Group Role Id */
    // @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
    public RoleGroupRoleId: string;

    /** @description 'A' (Active), 'I' (Inactive) */
    // @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    public RecordStatus: string;

    /** @description Owner Contact Id */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    public OwnerContactId: string;

    public constructor(init?: Partial<RoleGroupRolesModel>) { (Object as any).assign(this, init); }
}

export class RoleGroupModel
{
    /** @description Role Group Id */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    public RoleGroupId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
    public Name: string;

    /** @description Owner Contact Id */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    public OwnerContactId: string;

    /** @description Number of Roles */
    // @ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
    public NumberOfRoles: number;

    /** @description Roles belonging to the Role Group */
    // @ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
    public Roles: RoleGroupRolesModel[];

    /** @description 'A' (Active), 'I' (Inactive) */
    // @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    public RecordStatus: string;

    /** @description True if Licensee-owned, allowing editing, deleting, archiving */
    // @ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")
    public AllowEdit: boolean;

    public constructor(init?: Partial<RoleGroupModel>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of role groups")
export class GetContactRoleGroupsResponse
{
    public RoleGroups: RoleGroupModel[];
    public TotalRoleGroups: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetContactRoleGroupsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get role groups for the given criteria */
// @Api(Description="Get role groups for the given criteria")
export class GetContactRoleGroups extends PagedModel
{
    /** @description Get contact role groups for the specified licensee */
    // @ApiMember(DataType="Guid", Description="Get contact role groups for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
    public LicenseeId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="Name", ParameterType="query")
    public Name: string;

    /** @description Active/Archived filter */
    // @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
    public RecordStatus: string;

    public constructor(init?: Partial<GetContactRoleGroups>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>