cityworks
    Preparing search index...

    Class CaseAdmin

    Index

    Case Templates

    addBusinessCaseTemplate getBusinessCaseTemplates updateBusinessCaseTemplate

    Departments & Divisions

    addDepartment addDivision getDepartments getDivisions

    Deposits

    getDeposits

    Disciplines

    getDisciplines

    Expirations

    addExpiration getExpirations

    Fees

    getFees

    Inspections

    addInspectionTimeBlock getInspectionTimeBlocks

    Notifications

    getNotificationCases getNotificationTypes

    NumberingGroups

    addNumberingGroup getNumberingGroups updateNumberingGroup

    Other

    searchDeposits searchFees

    People

    addPeopleRole addPerson getPeople getPeopleRoles

    TaskResults

    addTaskResultDetail addTaskResultFeeInsert deleteTaskResultFeeInsert deleteTaskResultFeeInsertByTaskId getTaskResultDetails getTaskResultFeeInsert updateTaskResultDetail updateTaskResultFeeInsert

    Types & SubTypes

    addCaseType addSubtype getCaseTypes getSubtypes searchCaseTypeIDs searchCaseTypeObjects updateCaseType updateSubtype

    Case Templates

    • Add Business Case Template

      Parameters

      • data: Object

        The Business Case Template options.

      Returns Promise<unknown>

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

    • Get Business Case Templates

      Returns Promise<unknown>

      Returns Promise that represents a collection of Business Case Templates

    • Update Business Case Template

      Parameters

      • busCaseId: number

        The Business Case ID to update

      • options: Object

      Returns Promise<unknown>

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

    Departments & Divisions

    • Add Department

      Parameters

      • departmentCode: string

        The SubTypeId

      • departmentName: string

        The SubTypeId

      • Optionaloptions: Object

        Other SubType options.

      Returns Promise<unknown>

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

    • Add Division

      Parameters

      • departmentId: number
      • divisionName: string
      • Optionaloptions: Object

      Returns Promise<unknown>

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

    • Get Departments

      Returns Promise<unknown>

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

    • Get all Divisions

      Returns Promise<unknown>

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

    Deposits

    • Get all Deposits

      Returns Promise<unknown>

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

    Disciplines

    • Get all Disciplines

      Returns Promise<unknown>

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

    Expirations

    • Add an Expiration type

      Parameters

      • Optionaloptions: Object

        Must specify OrgId and ExpirationDescType attributes. See: /{subdirectory}/apidocs/#/service-info/Pll/ExpirationType

      Returns Promise<unknown>

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

    • Get all Expirations

      Returns Promise<unknown>

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

    Fees

    • Get all Fees

      Returns Promise<unknown>

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

    Inspections

    • Add Inspection Time Block

      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)

      • OptionalinspTimeBlocksDetails: Object

        See: /{subdirectory}/apidocs/#/data-type-info;dataType=InspTimeBlocksDetailItem

      Returns Promise<unknown>

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

    • Get all Inspection Time Blocks

      Returns Promise<unknown>

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

    Notifications

    • Get all NotificationCases

      Returns Promise<unknown>

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

    • Get all Notification Types

      Returns Promise<unknown>

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

    NumberingGroups

    • Add Numbering Group

      Parameters

      • options: Object

        attributes or update

      Returns Promise<unknown>

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

    • Get all Numbering Groups

      Returns Promise<unknown>

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

    • Update Numbering Group

      Parameters

      • numberingGroupId: number

        ID of NumberGroup to update

      • Optionaloptions: Object

        updates attributes

      Returns Promise<unknown>

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

    Other

    • Search Deposits. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

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

        The parameter(s) to search by (AccountCode, DepositCode, DepositDesc, DepositId, DepositTypeId).

      Returns Promise<unknown>

      Returns Promise that represents an Array of FeeSetupIDs

    • Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

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

        The parameter(s) to search by (AccountCode, FeeCode, FeeDesc, FeeSetupId, FeeTypeId).

      Returns Promise<unknown>

      Returns Promise that represents an Array of FeeSetupIDs

    People

    • Add People Role

      Parameters

      • roleCode: string
      • options: Object

        attributes for new person. See: /{subdirectory}/apidocs/#/service-info/Pll/PeopleRole

      Returns Promise<unknown>

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

    • Add Person

      Parameters

      • name: string

        Name of person

      • options: Object

        attributes for new person

      Returns Promise<unknown>

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

    • Get all People

      Returns Promise<unknown>

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

    • Get all PeopleRoles

      Returns Promise<unknown>

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

    TaskResults

    • Add TaskResultDetail

      Parameters

      • options: Object

        attributes for new TaskResultDetail. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultDetail

      Returns Promise<unknown>

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

    • Add TaskResultFeeInsert

      Parameters

      • options: Object

        attributes for new TaskResultFeeInsert. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultFeeInsert

      Returns Promise<unknown>

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

    • Delete TaskResultFeeInsert

      Parameters

      • taskResultFeeInsertId: number

        ID for TaskResultFeeInsert to be deleted.

      Returns Promise<unknown>

      Returns Promise that represents the ID Number of the deleted TaskResultFeeInsertItem.

    • Delete TaskResultFeeInsert(s) by Task ID

      Parameters

      • taskId: number

        ID for Task parent of TaskResultFeeInsert(s) to be deleted.

      Returns Promise<unknown>

      Returns Promise that represents the ID Number of the Task parent of the deleted TaskResultFeeInsertItem(s).

    • Get all TaskResultDetails

      Returns Promise<unknown>

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

    • Get all TaskResultFeeInsert

      Returns Promise<unknown>

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

    • Update TaskResultDetail

      Parameters

      • resultDetailId: number

        Result Detail ID

      • options: Object

        attributes for new person. See: /{subdirectory}/apidocs/#/service-info/Pll/TaskResultDetail

      Returns Promise<unknown>

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

    • Update TaskResultFeeInsert

      Parameters

      • taskResultFeeInsertId: number

        ID for TaskResultFeeInsert to be updated.

      • taskId: number

        Updated TaskID

      • taskResultId: number

        Updated TaskResultId

      • OptionalfeeSetupId: number

        Fee setup ID update for TaskResultFeeInsert

      Returns Promise<unknown>

      Returns Promise that represents the ID Number of the updated TaskResultFeeInsertItem.

    Types & SubTypes

    • Add 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>

      Returns Promise that represents an object describing the added case type

    • Add SubType

      Parameters

      • subTypeName: string

        The SubTypeId

      • subTypeDescription: string

        The SubTypeId

      • Optionaloptions: Object

        Other SubType options.

      Returns Promise<unknown>

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

    • Get Case Types

      Returns Promise<unknown>

      Returns Promise that represents a collection of CaseTypeItems

    • Get SubTypes

      Returns Promise<unknown>

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

    • Search for CaseTypes. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

      • filters: Object

        The parameter(s) to search by (CaseType, CaseTypeDesc, CaseTypeId)

      Returns Promise<unknown>

      Returns Promise that represents an Array of CaseTypeIDs

    • Search for CaseTypes. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

      • filters: Object

        The parameter(s) to search by (CaseType, CaseTypeDesc, CaseTypeId)

      Returns Promise<unknown>

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

    • Update Case Type

      Parameters

      • caseTypeId: number

        The case Type ID

      • Optionaloptions: Object

        The other options for the Case Type

      Returns Promise<unknown>

      Returns Promise that represents an object describing the updated case type

    • Update SubType

      Parameters

      • subTypeId: number

        The SubTypeId

      • Optionaloptions: Object

        The case Object ID

      Returns Promise<unknown>

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

    Settings

    Member Visibility

    On This Page

    Case Templates
    Departments & Divisions
    Deposits
    Disciplines
    Expirations
    Fees
    Inspections
    Notifications
    NumberingGroups
    Other
    People
    TaskResults
    Types & SubTypes