| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ContactRoleGroup:
{
Name: String,
NumberOfRoles: 0,
Roles:
[
{
RoleName: String,
RoleGroupName: String,
RecordStatus: String
}
],
RecordStatus: String,
AllowEdit: False
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}