| All Verbs | /api/contactrolegroup/{ContactRoleGroupId} |
|---|
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="Details of the specified contact role group")
export class GetContactRoleGroupDetailsResponse
{
public ContactRoleGroup: RoleGroupModel;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetContactRoleGroupDetailsResponse>) { (Object as any).assign(this, init); }
}
/** @description Get details of the specified contact role group */
// @Api(Description="Get details of the specified contact role group")
export class GetContactRoleGroupDetails
{
/** @description The Contact Role Group Guid. Records retrieved will belong to this role group. */
// @ApiMember(DataType="Guid", Description="The Contact Role Group Guid. Records retrieved will belong to this role group.", IsRequired=true, Name="ContactRoleGroupId", ParameterType="query")
public ContactRoleGroupId: string;
public constructor(init?: Partial<GetContactRoleGroupDetails>) { (Object as any).assign(this, init); }
}
TypeScript 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
}
}
}