Platform API

GetContactRoleGroups

Get role groups for the given criteria

The following routes are available for this service:
All Verbs	/api/contactrolegroups/{LicenseeId}

"use strict";
/** @typedef {'Ascending'|'Descending'} */
export var SortOrder;
(function (SortOrder) {
    SortOrder["Ascending"] = "Ascending"
    SortOrder["Descending"] = "Descending"
})(SortOrder || (SortOrder = {}));
export class PagedModel {
    /** @param {{PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Page Number to retrieve */
    PageNumber;
    /**
     * @type {number}
     * @description Number of records to retrieve */
    PageSize;
    /**
     * @type {number}
     * @description Index of field to sort results by */
    SortIndex;
    /**
     * @type {SortOrder}
     * @description Sort Order - Ascending or Descending */
    SortOrder;
}
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 GetContactRoleGroupsResponse {
    /** @param {{RoleGroups?:RoleGroupModel[],TotalRoleGroups?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RoleGroupModel[]} */
    RoleGroups;
    /** @type {number} */
    TotalRoleGroups;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetContactRoleGroups extends PagedModel {
    /** @param {{LicenseeId?:string,Name?:string,RecordStatus?:string,PageNumber?:number,PageSize?:number,SortIndex?:number,SortOrder?:SortOrder}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Get contact role groups for the specified licensee */
    LicenseeId;
    /**
     * @type {string}
     * @description Role Group Name */
    Name;
    /**
     * @type {string}
     * @description Active/Archived filter */
    RecordStatus;
}

JavaScript GetContactRoleGroups DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	RecordStatus: String,
	PageNumber: 0,
	PageSize: 0,
	SortIndex: 0,
	SortOrder: Ascending
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	RoleGroups: 
	[
		{
			Name: String,
			NumberOfRoles: 0,
			Roles: 
			[
				{
					RoleName: String,
					RoleGroupName: String,
					RecordStatus: String
				}
			],
			RecordStatus: String,
			AllowEdit: False
		}
	],
	TotalRoleGroups: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}