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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"ContactRoleGroupId":"00000000-0000-0000-0000-000000000000"}

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

{"ContactRoleGroup":{"RoleGroupId":"00000000-0000-0000-0000-000000000000","Name":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000","NumberOfRoles":0,"Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String","RoleGroupId":"00000000-0000-0000-0000-000000000000","RoleGroupName":"String","RoleGroupRoleId":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","OwnerContactId":"00000000-0000-0000-0000-000000000000"}],"RecordStatus":"String","AllowEdit":false},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}