Class CaseAdmin

Hierarchy

CaseAdmin

Index

Case Templates Methods

addBusinessCaseTemplate

addBusinessCaseTemplate(data: Object): Promise<unknown>
Add Business Case Template

Returns
Returns Promise that represents an object describing the created case template. See: /{subdirectory}/apidocs/#/data-type-info;dataType=BusinessCaseItem
Parameters
- data: Object
  
  The Business Case Template options.
Returns Promise<unknown>
- Defined in case_admin.ts:24

getBusinessCaseTemplates

getBusinessCaseTemplates(): Promise<unknown>
Get Business Case Templates

Returns
Returns Promise that represents a collection of Business Case Templates

Returns Promise<unknown>
- Defined in case_admin.ts:62

updateBusinessCaseTemplate

updateBusinessCaseTemplate(busCaseId: number, options: Object): Promise<unknown>
Update Business Case Template

Returns
Returns Promise that represents an object describing the updated case template. See: /{subdirectory}/apidocs/#/data-type-info;dataType=BusinessCaseItem
Parameters
- busCaseId: number
  
  The Business Case ID to update
- options: Object
Returns Promise<unknown>
- Defined in case_admin.ts:42

Departments & Divisions Methods

addDepartment

addDepartment(departmentCode: string, departmentName: string, options?: Object): Promise<unknown>
Add Department

Returns
Returns Promise that represents an object describing the added DepartmentItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem
Parameters
- departmentCode: string
  
  The SubTypeId
- departmentName: string
  
  The SubTypeId
- Optional options: Object
  
  Other SubType options.
Returns Promise<unknown>
- Defined in case_admin.ts:379

addDivision

addDivision(departmentId: number, divisionName: string, options?: Object): Promise<unknown>
Add Division

Returns
Returns Promise that represents an object describing the newly-added DivisionItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DivisionItem
Parameters
- departmentId: number
- divisionName: string
- Optional options: Object
Returns Promise<unknown>
- Defined in case_admin.ts:417

getDepartments

getDepartments(): Promise<unknown>
Get Departments

Returns
Returns Promise that represents a collection of SubTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem

Returns Promise<unknown>
- Defined in case_admin.ts:400

getDivisions

getDivisions(): Promise<unknown>
Get all Divisions

Returns
Returns Promise that represents a collection of DivisionItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DivisionItem

Returns Promise<unknown>
- Defined in case_admin.ts:438

Deposits Methods

getDeposits

getDeposits(): Promise<unknown>
Get all Deposits

Returns
Returns Promise that represents a collection of DepositItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepositItemBase

Returns Promise<unknown>
- Defined in case_admin.ts:322

Disciplines Methods

getDisciplines

getDisciplines(): Promise<unknown>
Get all Disciplines

Returns
Returns Promise that represents a collection of DisciplineItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DisciplineItem

Returns Promise<unknown>
- Defined in case_admin.ts:359

Expirations Methods

addExpiration

addExpiration(options?: Object): Promise<unknown>
Add an Expiration type

Returns
Returns Promise that represents an object describing the newly-added ExpirationTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=ExpirationTypeItem
Parameters
- Optional options: Object
  
  Must specify OrgId and ExpirationDescType attributes. See: /{subdirectory}/apidocs/#/service-info/Pll/ExpirationType
Returns Promise<unknown>
- Defined in case_admin.ts:302

getExpirations

getExpirations(): Promise<unknown>
Get all Expirations

Returns
Returns Promise that represents a collection of ExpirationTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=ExpirationTypeItem

Returns Promise<unknown>
- Defined in case_admin.ts:284

Fees Methods

getFees

getFees(): Promise<unknown>
Get all Fees

Returns
Returns Promise that represents an object describing the added DepartmentItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=DepartmentItem

Returns Promise<unknown>
- Defined in case_admin.ts:247

Inspections Methods

addInspectionTimeBlock

addInspectionTimeBlock(labelText: string, startTime: string, endTime: string, inspTimeBlocksDetails?: Object): Promise<unknown>
Add Inspection Time Block

Returns
Returns Promise that represents an object describing the newly-added InspectionTimeBlocksItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspectionTimeBlocksItem
Parameters
- labelText: string
  
  Label for the time block
- startTime: string
  
  Start time in 24 hour format (HH:mm)
- endTime: string
  
  End time in 24 hour format (HH:mm)
- Optional inspTimeBlocksDetails: Object
  
  See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspTimeBlocksDetailItem
Returns Promise<unknown>
- Defined in case_admin.ts:459

getInspectionTimeBlocks

getInspectionTimeBlocks(): Promise<unknown>
Get all Inspection Time Blocks

Returns
Returns Promise that represents a collection of InspectionTimeBlocksItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspectionTimeBlocksItem

Returns Promise<unknown>
- Defined in case_admin.ts:483

Notifications Methods

getNotificationCases

getNotificationCases(): Promise<unknown>
Get all NotificationCases

Returns
Returns Promise that represents a collection of NotificationCaseItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NotificationCaseItem

Returns Promise<unknown>
- Defined in case_admin.ts:500

getNotificationTypes

getNotificationTypes(): Promise<unknown>
Get all Notification Types

Returns
Returns Promise that represents a collection of NotificationCaseItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NotificationTypeItem

Returns Promise<unknown>
- Defined in case_admin.ts:517

NumberingGroups Methods

addNumberingGroup

addNumberingGroup(options: Object): Promise<unknown>
Add Numbering Group

Returns
Returns Promise that represents an object describing the newly-added NumberingGroupItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
Parameters
- options: Object
  
  attributes or update
Returns Promise<unknown>
- Defined in case_admin.ts:535

getNumberingGroups

getNumberingGroups(): Promise<unknown>
Get all Numbering Groups

Returns
Returns Promise that represents a collection of NumberingGroupItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem

Returns Promise<unknown>
- Defined in case_admin.ts:574

updateNumberingGroup

updateNumberingGroup(numberingGroupId: number, options?: Object): Promise<unknown>
Update Numbering Group

Returns
Returns Promise that represents an object describing the newly-added HolidaysItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
Parameters
- numberingGroupId: number
  
  ID of NumberGroup to update
- Optional options: Object
  
  updates attributes
Returns Promise<unknown>
- Defined in case_admin.ts:554

Other Methods

searchDeposits

searchDeposits(filters: {
    AccountCode?: string;
    DepositCode?: string;
    DepositDesc?: string;
    DepositId?: number;
    DepositTypeId?: number;
}): Promise<unknown>
Search Deposits. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

Returns
Returns Promise that represents an Array of FeeSetupIDs
Parameters
- filters: {
      AccountCode?: string;
      DepositCode?: string;
      DepositDesc?: string;
      DepositId?: number;
      DepositTypeId?: number;
  }
  
  The parameter(s) to search by (AccountCode, DepositCode, DepositDesc, DepositId, DepositTypeId).
  - Optional AccountCode?: string
  - Optional DepositCode?: string
  - Optional DepositDesc?: string
  - Optional DepositId?: number
  - Optional DepositTypeId?: number
Returns Promise<unknown>
- Defined in case_admin.ts:339

searchFees

searchFees(filters: {
    AccountCode?: string;
    FeeCode?: string;
    FeeDesc?: string;
    FeeSetupId?: number;
    FeeTypeId?: number;
}): Promise<unknown>
Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

Returns
Returns Promise that represents an Array of FeeSetupIDs
Parameters
- filters: {
      AccountCode?: string;
      FeeCode?: string;
      FeeDesc?: string;
      FeeSetupId?: number;
      FeeTypeId?: number;
  }
  
  The parameter(s) to search by (AccountCode, FeeCode, FeeDesc, FeeSetupId, FeeTypeId).
  - Optional AccountCode?: string
  - Optional FeeCode?: string
  - Optional FeeDesc?: string
  - Optional FeeSetupId?: number
  - Optional FeeTypeId?: number
Returns Promise<unknown>
- Defined in case_admin.ts:264

People Methods

addPeopleRole

addPeopleRole(roleCode: string, options: Object): Promise<unknown>
Add People Role

Returns
Returns Promise that represents an object describing the newly-added PeopleRoleItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem
Parameters
- roleCode: string
- options: Object
  
  attributes for new person. See: /{subdirectory}/apidocs/#/service-info/Pll/PeopleRole
Returns Promise<unknown>
- Defined in case_admin.ts:632

addPerson

addPerson(name: string, options: Object): Promise<unknown>
Add Person

Returns
Returns Promise that represents an object describing the newly-added NumberingGroupItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=NumberingGroupItem
Parameters
- name: string
  
  Name of person
- options: Object
  
  attributes for new person
Returns Promise<unknown>
- Defined in case_admin.ts:593

getPeople

getPeople(): Promise<unknown>
Get all People

Returns
Returns Promise that represents a collection of PeopleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleItem

Returns Promise<unknown>
- Defined in case_admin.ts:613

getPeopleRoles

getPeopleRoles(): Promise<unknown>
Get all PeopleRoles

Returns
Returns Promise that represents a collection of PeopleRoleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem

Returns Promise<unknown>
- Defined in case_admin.ts:652

TaskResults Methods

addTaskResultDetail

addTaskResultDetail(options: Object): Promise<unknown>
Add TaskResultDetail

Returns
Returns Promise that represents an object describing the newly-added TaskResultDetailItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultDetailItem
Parameters
- options: Object
  
  attributes for new TaskResultDetail. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultDetail
Returns Promise<unknown>
- Defined in case_admin.ts:670

addTaskResultFeeInsert

addTaskResultFeeInsert(options: Object): Promise<unknown>
Add TaskResultFeeInsert

Returns
Returns Promise that represents an object describing the newly-added TaskResultFeeInsertItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultFeeInsertItem
Parameters
- options: Object
  
  attributes for new TaskResultFeeInsert. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultFeeInsert
Returns Promise<unknown>
- Defined in case_admin.ts:727

deleteTaskResultFeeInsert

deleteTaskResultFeeInsert(taskResultFeeInsertId: number): Promise<unknown>
Delete TaskResultFeeInsert

Returns
Returns Promise that represents the ID Number of the deleted TaskResultFeeInsertItem.
Parameters
- taskResultFeeInsertId: number
  
  ID for TaskResultFeeInsert to be deleted.
Returns Promise<unknown>
- Defined in case_admin.ts:745

deleteTaskResultFeeInsertByTaskId

deleteTaskResultFeeInsertByTaskId(taskId: number): Promise<unknown>
Delete TaskResultFeeInsert(s) by Task ID

Returns
Returns Promise that represents the ID Number of the Task parent of the deleted TaskResultFeeInsertItem(s).
Parameters
- taskId: number
  
  ID for Task parent of TaskResultFeeInsert(s) to be deleted.
Returns Promise<unknown>
- Defined in case_admin.ts:765

getTaskResultDetails

getTaskResultDetails(): Promise<unknown>
Get all TaskResultDetails

Returns
Returns Promise that represents a collection of PeopleRoleItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=PeopleRoleItem

Returns Promise<unknown>
- Defined in case_admin.ts:709

getTaskResultFeeInsert

getTaskResultFeeInsert(): Promise<unknown>
Get all TaskResultFeeInsert

Returns
Returns Promise that represents a collection of TaskResultFeeInsertItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultFeeInsertItem

Returns Promise<unknown>
- Defined in case_admin.ts:813

updateTaskResultDetail

updateTaskResultDetail(resultDetailId: number, options: Object): Promise<unknown>
Update TaskResultDetail

Returns
Returns Promise that represents an object describing the newly-added TaskResultDetailItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=TaskResultDetailItem
Parameters
- resultDetailId: number
  
  Result Detail ID
- options: Object
  
  attributes for new person. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultDetail
Returns Promise<unknown>
- Defined in case_admin.ts:689

updateTaskResultFeeInsert

updateTaskResultFeeInsert(taskResultFeeInsertId: number, taskId: number, taskResultId: number, feeSetupId?: number): Promise<unknown>
Update TaskResultFeeInsert

Returns
Returns Promise that represents the ID Number of the updated TaskResultFeeInsertItem.
Parameters
- taskResultFeeInsertId: number
  
  ID for TaskResultFeeInsert to be updated.
- taskId: number
  
  Updated TaskID
- taskResultId: number
  
  Updated TaskResultId
- Optional feeSetupId: number
  
  Fee setup ID update for TaskResultFeeInsert
Returns Promise<unknown>
- Defined in case_admin.ts:788

Types & SubTypes Methods

addCaseType

addCaseType(caseTypeName: string, caseTypeDesciption: string, options: Object): Promise<unknown>
Add Case Type

Returns
Returns Promise that represents an object describing the added case type
Parameters
- caseTypeName: string
  
  The case type name
- caseTypeDesciption: string
  
  The case type description
- options: Object
  
  The other options for the Case Type
Returns Promise<unknown>
- Defined in case_admin.ts:82

addSubtype

addSubtype(subTypeName: string, subTypeDescription: string, options?: Object): Promise<unknown>
Add SubType

Returns
Returns Promise that represents an object describing the added SubTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
Parameters
- subTypeName: string
  
  The SubTypeId
- subTypeDescription: string
  
  The SubTypeId
- Optional options: Object
  
  Other SubType options.
Returns Promise<unknown>
- Defined in case_admin.ts:187

getCaseTypes

getCaseTypes(): Promise<unknown>
Get Case Types

Returns
Returns Promise that represents a collection of CaseTypeItems

Returns Promise<unknown>
- Defined in case_admin.ts:125

getSubtypes

getSubtypes(): Promise<unknown>
Get SubTypes

Returns
Returns Promise that represents a collection of SubTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem

Returns Promise<unknown>
- Defined in case_admin.ts:230

searchCaseTypeIDs

searchCaseTypeIDs(filters: Object): Promise<unknown>
Search for CaseTypes. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

Returns
Returns Promise that represents an Array of CaseTypeIDs
Parameters
- filters: Object
  
  The parameter(s) to search by (CaseType, CaseTypeDesc, CaseTypeId)
Returns Promise<unknown>
- Defined in case_admin.ts:143

searchCaseTypeObjects

searchCaseTypeObjects(filters: Object): Promise<unknown>
Search for CaseTypes. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

Returns
Returns Promise that represents a collection of CaseTypeItems. See: /{subdirectory}/apidocs/#/data-type-info;dataType=CaseTypeItem
Parameters
- filters: Object
  
  The parameter(s) to search by (CaseType, CaseTypeDesc, CaseTypeId)
Returns Promise<unknown>
- Defined in case_admin.ts:164

updateCaseType

updateCaseType(caseTypeId: number, options?: Object): Promise<unknown>
Update Case Type

Returns
Returns Promise that represents an object describing the updated case type
Parameters
- caseTypeId: number
  
  The case Type ID
- Optional options: Object
  
  The other options for the Case Type
Returns Promise<unknown>
- Defined in case_admin.ts:105

updateSubtype

updateSubtype(subTypeId: number, options?: Object): Promise<unknown>
Update SubType

Returns
Returns Promise that represents an object describing the updated SubTypeItem. See: /{subdirectory}/apidocs/#/data-type-info;dataType=SubTypeItem
Parameters
- subTypeId: number
  
  The SubTypeId
- Optional options: Object
  
  The case Object ID
Returns Promise<unknown>
- Defined in case_admin.ts:210

Class CaseAdmin

Hierarchy

Index

Methods - Case Templates

Methods - Departments & Divisions

Methods - Deposits

Methods - Disciplines

Methods - Expirations

Methods - Fees

Methods - Inspections

Methods - Notifications

Methods - NumberingGroups

Methods - Other

Methods - People

Methods - TaskResults

Methods - Types & SubTypes

Case Templates Methods

addBusinessCaseTemplate

Returns

Parameters

data: Object

Returns Promise<unknown>

getBusinessCaseTemplates

Returns

Returns Promise<unknown>

updateBusinessCaseTemplate

Returns

Parameters

busCaseId: number

options: Object

Returns Promise<unknown>

Departments & Divisions Methods

addDepartment

Returns

Parameters

departmentCode: string

departmentName: string

Optional options: Object

Returns Promise<unknown>

addDivision

Returns

Parameters

departmentId: number

divisionName: string

Optional options: Object

Returns Promise<unknown>

getDepartments

Returns

Returns Promise<unknown>

getDivisions

Returns

Returns Promise<unknown>

Deposits Methods

getDeposits

Returns

Returns Promise<unknown>

Disciplines Methods

getDisciplines

Returns

Returns Promise<unknown>

Expirations Methods

addExpiration

Returns

Parameters

Optional options: Object

Returns Promise<unknown>

getExpirations

Returns

Returns Promise<unknown>

Fees Methods

getFees

Returns

Returns Promise<unknown>

Inspections Methods

addInspectionTimeBlock

Returns

Parameters

labelText: string

startTime: string

endTime: string

`Optional` options: Object

`Optional` options: Object

`Optional` options: Object

`Optional` inspTimeBlocksDetails: Object

`Optional` options: Object

filters: {
AccountCode?: string;
DepositCode?: string;
DepositDesc?: string;
DepositId?: number;
DepositTypeId?: number;
}

`Optional` AccountCode?: string

`Optional` DepositCode?: string

`Optional` DepositDesc?: string

`Optional` DepositId?: number

`Optional` DepositTypeId?: number

filters: {
AccountCode?: string;
FeeCode?: string;
FeeDesc?: string;
FeeSetupId?: number;
FeeTypeId?: number;
}

`Optional` AccountCode?: string

`Optional` FeeCode?: string

`Optional` FeeDesc?: string

`Optional` FeeSetupId?: number

`Optional` FeeTypeId?: number