Platform API

GetContactRoleGroupDetails

Get details of the specified contact role group

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

"use strict";
export class RoleGroupRolesModel {
    /** @param {{RoleId?:string,RoleName?:string,RoleGroupId?:string,RoleGroupName?:string,RoleGroupRoleId?:string,RecordStatus?:string,OwnerContactId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Role Id */
    RoleId;
    /**
     * @type {string}
     * @description Role Name */
    RoleName;
    /**
     * @type {string}
     * @description Role Group Id */
    RoleGroupId;
    /**
     * @type {string}
     * @description Role Group Name */
    RoleGroupName;
    /**
     * @type {string}
     * @description Role Group Role Id */
    RoleGroupRoleId;
    /**
     * @type {string}
     * @description 'A' (Active), 'I' (Inactive) */
    RecordStatus;
    /**
     * @type {string}
     * @description Owner Contact Id */
    OwnerContactId;
}
export class RoleGroupModel {
    /** @param {{RoleGroupId?:string,Name?:string,OwnerContactId?:string,NumberOfRoles?:number,Roles?:RoleGroupRolesModel[],RecordStatus?:string,AllowEdit?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Role Group Id */
    RoleGroupId;
    /**
     * @type {string}
     * @description Role Group Name */
    Name;
    /**
     * @type {string}
     * @description Owner Contact Id */
    OwnerContactId;
    /**
     * @type {number}
     * @description Number of Roles */
    NumberOfRoles;
    /**
     * @type {RoleGroupRolesModel[]}
     * @description Roles belonging to the Role Group */
    Roles;
    /**
     * @type {string}
     * @description 'A' (Active), 'I' (Inactive) */
    RecordStatus;
    /**
     * @type {boolean}
     * @description True if Licensee-owned, allowing editing, deleting, archiving */
    AllowEdit;
}
export class GetContactRoleGroupDetailsResponse {
    /** @param {{ContactRoleGroup?:RoleGroupModel,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RoleGroupModel} */
    ContactRoleGroup;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetContactRoleGroupDetails {
    /** @param {{ContactRoleGroupId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The Contact Role Group Guid. Records retrieved will belong to this role group. */
    ContactRoleGroupId;
}

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