Jump to

• Request
• Response

Get all cases

get

/fscmRestApi/resources/11.13.18.05/publicSectorListCases

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • JobFunctionCasesFinder: Finds the case that matches the specified search criteria.
    Finder Variables:
    • reviewerId; integer; The unique identifier of the code technician.
    • value; string; Finds the case that matches the specified search value.
  • JobFunctionFilterFinder: Finds the case that matches the specified search criteria.
    Finder Variables:
    • jobFunctionId; string; The job function identifier of the logged in user.
    • personId; integer; The unique identifier of the logged in user.
    • value; string; Finds the case that matches the specified search value.
  • PrimaryKey: Finds the case that matches the specified search criteria.
    Finder Variables:
    • CaseKey; integer; The unique identifier of the case.
  • TechnicianOpenCasesFinder: Finds the case that matches the specified search criteria.
    Finder Variables:
    • reviewerId; integer; Finds the case that matches the specified search value.
    • value; string; Finds the case that matches the specified search criteria.
  • UnassignedJobFunctionCasesRowFinder: Finds the case that matches the specified search criteria.
    Finder Variables:
    • reviewerId; integer; The unique identifier of the code technician.
    • value; string; Finds the case that matches the specified search value.
  • UnassignedTechnicianCasesFinder: Finds the case that matches the specified search criteria.
    Finder Variables:
    • value; string; Finds the case that matches the specified search value.
  • simpleSearchFinder: The unique identifier of the code technician.
    Finder Variables:
    • value; string; Finds the case that matches the specified search value.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccessCode; string; The access code to claim the case.
  • AgencyId; integer; The unique identifier of the agency of the case.
  • AppealDueDate; string; The appeal due date for the case.
  • AssignedCodeOfficerName; string; The name of the code officer assigned to the case.
  • AssignedCodeTechnicianName; string; The name of the code technician assigned to the case.
  • AssignedId; integer; The unique identifier of the code officer assigned to the case.
  • CaseId; string; The identifier of the case.
  • CaseKey; integer; The unique identifier of the case.
  • ChangeReason; string; The reason for change of the case status.
  • ClosedBy; string; The name of the user who closed the case.
  • ClosedDate; string; The date when the case was closed.
  • ClosedReason; string; The reason for closing the case.
  • ComplianceDueDate; string; The compliance date of the case.
  • CompliedOn; string; The date on which the case met all requirements for compliance.
  • CreatedBy; string; The name of the user who created the row.
  • CreationDate; string; The date and time when the row was created.
  • CriticalFlag; boolean; The switch to indicate that the case is critical.
  • DistrictDescription; string; The description of the district of the case.
  • DistrictId; string; The unique identifier of the district of the location of the case.
  • DistrictType; string; The type of the district of the location of the case.
  • DistrictTypeDescription; string; The description of the district type of the case.
  • EarlyComplyByDate; string; The earliest date among all the comply by dates that correspond to open code violations for the case.
  • FunctionalStatus; string; The user defined case status name that maps to a delivered system status.
  • IntakeKey; integer; The unique identifier of the intake.
  • IntakeSource; string; The source of the case intake.
  • InternalPriority; string; The internal priority of the case.
  • IsReopened; string; The switch to indicate that the case is reopened.
  • IssueDescription; string; The description of the issue.
  • IssueSubtype; string; The name of the issue subtype associated with the case.
  • IssueSubtypeCode; string; The unique identifier of the issue subtype of the case.
  • IssueSubtypeId; string; The unique identifier of the issue subtype of the case.
  • IssueType; string; The name of the issue type associated with the case.
  • IssueTypeId; string; The unique identifier of the issue type of the case.
  • LastComplyByDate; string; The latest date among all the comply by dates that correspond to open code violations for the case.
  • LastUpdateDate; string; The date and time when the row was last updated.
  • LastUpdatedBy; string; The name of the user who last updated the row.
  • Latitude; number; The latitude of the location of the case.
  • LayoutVersion; string; The version of the layout of the intake form for the case.
  • LocationDescription; string; The description of the location.
  • Longitude; number; The longitude of the location of the case.
  • MigratedDataFlag; string; The identifier for the migrated data.
  • ObsoleteFlag; boolean; The switch to indicate that the case is obsolete.
  • ParcelIdEntered; string; The unique identifier of the parcel retrieved from the map for the case.
  • Priority; string; The priority of the case.
  • ProcessInconsistent; string; The flag to indicate whether the workflow associated with the case is in an inconsistent state.
  • ProcessInstStatus; string; The process instance status of the workflow that is associated with the case.
  • ProcessInstanceId; string; The process instance identifier of the workflow associated with the case.
  • PropertyAddress1; string; The first line of the property address of the case.
  • PropertyAddress2; string; The second line of the property address of the case.
  • PropertyAddress3; string; The third line of the property address of the case.
  • PropertyAddress4; string; The fourth line of the property address of the case.
  • PropertyAddressId; integer; The unique identifier of the property address of the case.
  • PropertyCity; string; The city of the property address of the case.
  • PropertyCoordinateX; number; The x-coordinate of the property address of the case.
  • PropertyCoordinateY; number; The y-coordinate of the property address of the case.
  • PropertyCountry; string; The country of the property address of the case.
  • PropertyCounty; string; The county of the property address of the case.
  • PropertyParcelId; integer; The unique identifier of the property parcel of the case.
  • PropertyPostalCode; string; The postal code of the property address of the case.
  • PropertyPostalPlusFourcode; string; The postal plus code of the property address of the case.
  • PropertyProvince; string; The province of the property address of the case.
  • PropertyState; string; The state of the property address of the case.
  • ReferralCode; string; The unique identifier of the referral body of the case.
  • ReportedById; string; The unique identifier of the person who reported the case.
  • ReviewerId; integer; The unique identifier of the code technician assigned to the case.
  • SourceTrxId; string; The unique identifier of the source transaction that created the case.
  • Status; string; The status of the case.
  • StatusDescription; string; The description of the status of the case.
  • SubmitDate; string; The date when the case was submitted.
  • TotalFeeDue; number; The total fees due for the case.
  • TotalFees; number; The total fees for the case.
  • TotalPaid; number; The total paid fees for the case.
  • TotalPayableFees; number; The total payable fees for the case.
  • TotalPaymentInProcess; number; The total fees for the case for which payment is in progress.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorListCases

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorListCases-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Communications",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorListCases-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorListCases-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorListCases-item-response

Type: object

Show Source

• AccessCode: string
  Title: Access Number

  Read Only: true

  Maximum Length: 5

  The access code to claim the case.
• AdministerCaseStatusAccess: array Administer Case Status Permissions
  Title: Administer Case Status Permissions

  The administer case status access resource is used to determine whether the status of a case can be modified.
• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  The unique identifier of the agency of the case.
• AppealDueDate: string (date)
  Title: Appeal By

  Read Only: true

  The appeal due date for the case.
• AssignedCodeOfficerName: string
  Title: Code Officer Name

  Read Only: true

  Maximum Length: 240

  The name of the code officer assigned to the case.
• AssignedCodeTechnicianName: string
  Title: Code Technician Name

  Read Only: true

  Maximum Length: 240

  The name of the code technician assigned to the case.
• AssignedId: integer (int64)
  Title: Inspector Assigned

  Read Only: true

  The unique identifier of the code officer assigned to the case.
• CaseId: string
  Title: Case ID

  Read Only: true

  Maximum Length: 50

  The identifier of the case.
• CaseKey: integer
  Title: Case Key

  Read Only: true

  The unique identifier of the case.
• ChangeReason: string
  Title: Reason

  Read Only: true

  Maximum Length: 1000

  The reason for change of the case status.
• ClosedBy: string
  Title: Closed By

  Read Only: true

  Maximum Length: 64

  The name of the user who closed the case.
• ClosedDate: string (date-time)
  Title: Closed On

  Read Only: true

  The date when the case was closed.
• ClosedReason: string
  Title: Reason for Closing

  Read Only: true

  Maximum Length: 450

  The reason for closing the case.
• ComplianceDueDate: string (date)
  Title: Compliance Date

  Read Only: true

  The compliance date of the case.
• CompliedOn: string (date)
  Title: Complied On

  Read Only: true

  The date on which the case met all requirements for compliance.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• CriticalFlag: boolean
  Title: Critical

  Read Only: true

  Maximum Length: 1

  The switch to indicate that the case is critical.
• DistrictDescription: string
  Read Only: true

  Maximum Length: 255

  The description of the district of the case.
• DistrictId: string
  Title: District ID

  Read Only: true

  Maximum Length: 30

  The unique identifier of the district of the location of the case.
• DistrictType: string
  Title: District Type

  Read Only: true

  Maximum Length: 50

  The type of the district of the location of the case.
• DistrictTypeDescription: string
  Read Only: true

  Maximum Length: 255

  The description of the district type of the case.
• EarlyComplyByDate: string (date)
  Title: Earliest of Comply by Dates in Violations

  Read Only: true

  The earliest date among all the comply by dates that correspond to open code violations for the case.
• FunctionalStatus: string
  Title: Transaction Status

  Read Only: true

  Maximum Length: 15

  The user defined case status name that maps to a delivered system status.
• IntakeKey: integer (int64)
  Title: Intake Key

  Read Only: true

  The unique identifier of the intake.
• IntakeSource: string
  Title: Intake Source

  Read Only: true

  Maximum Length: 30

  The source of the case intake.
• InternalPriority: string
  Title: Internal Priority

  Read Only: true

  Maximum Length: 30

  The internal priority of the case.
• IsReopened: string
  Read Only: true

  Maximum Length: 5

  The switch to indicate that the case is reopened.
• IssueDescription: string
  Title: Issue Description

  Read Only: true

  Maximum Length: 1000

  The description of the issue.
• IssueSubtype: string
  Title: Issue Subtype

  Read Only: true

  Maximum Length: 100

  The name of the issue subtype associated with the case.
• IssueSubtypeCode: string
  Read Only: true

  Maximum Length: 40

  The unique identifier of the issue subtype of the case.
• IssueSubtypeId: string
  Title: Issue Subtype ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the issue subtype of the case.
• IssueType: string
  Title: Issue Type

  Read Only: true

  Maximum Length: 100

  The name of the issue type associated with the case.
• IssueTypeId: string
  Title: Issue Type ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the issue type of the case.
• LastComplyByDate: string (date)
  Title: Latest of Comply by Dates in Violations

  Read Only: true

  The latest date among all the comply by dates that correspond to open code violations for the case.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• Latitude: number
  Title: Latitude

  Read Only: true

  The latitude of the location of the case.
• LayoutVersion: string
  Read Only: true

  Maximum Length: 30

  The version of the layout of the intake form for the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDescription: string
  Title: Location Description

  Read Only: true

  Maximum Length: 1000

  The description of the location.
• Longitude: number
  Title: Longitude

  Read Only: true

  The longitude of the location of the case.
• MigratedDataFlag: string
  Title: Migrated Case

  Read Only: true

  Maximum Length: 3

  The identifier for the migrated data.
• ObsoleteFlag: boolean
  Title: Obsolete

  Read Only: true

  Maximum Length: 1

  The switch to indicate that the case is obsolete.
• ParcelIdEntered: string
  Read Only: true

  Maximum Length: 30

  The unique identifier of the parcel retrieved from the map for the case.
• Priority: string
  Title: Priority

  Read Only: true

  Maximum Length: 30

  The priority of the case.
• ProcessInconsistent: string
  Read Only: true

  Maximum Length: 10

  The flag to indicate whether the workflow associated with the case is in an inconsistent state.
• ProcessInstanceId: string
  Title: Workflow Process ID

  Read Only: true

  Maximum Length: 500

  The process instance identifier of the workflow associated with the case.
• ProcessInstStatus: string
  Title: Workflow Process Status

  Read Only: true

  Maximum Length: 15

  The process instance status of the workflow that is associated with the case.
• PropertyAddress1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the property address of the case.
• PropertyAddress2: string
  Title: Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the property address of the case.
• PropertyAddress3: string
  Title: Address Line 3

  Read Only: true

  Maximum Length: 240

  The third line of the property address of the case.
• PropertyAddress4: string
  Title: Address Line 4

  Read Only: true

  Maximum Length: 240

  The fourth line of the property address of the case.
• PropertyAddressId: integer (int64)
  Title: Property Address ID

  Read Only: true

  The unique identifier of the property address of the case.
• PropertyCity: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the property address of the case.
• PropertyCoordinateX: number
  Title: X Coordinate

  Read Only: true

  The x-coordinate of the property address of the case.
• PropertyCoordinateY: number
  Title: Y Coordinate

  Read Only: true

  The y-coordinate of the property address of the case.
• PropertyCountry: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country of the property address of the case.
• PropertyCounty: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county of the property address of the case.
• PropertyParcelId: integer (int64)
  Title: Parcel ID

  Read Only: true

  The unique identifier of the property parcel of the case.
• PropertyPostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code of the property address of the case.
• PropertyPostalPlusFourcode: string
  Title: Postal Plus 4 Code

  Read Only: true

  Maximum Length: 10

  The postal plus code of the property address of the case.
• PropertyProvince: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province of the property address of the case.
• PropertyState: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state of the property address of the case.
• ReferralCode: string
  Title: Referral Code

  Read Only: true

  Maximum Length: 100

  The unique identifier of the referral body of the case.
• ReportedById: string
  Title: Reported By

  Read Only: true

  Maximum Length: 64

  The unique identifier of the person who reported the case.
• ReviewerId: integer (int64)
  Title: Technician Assigned

  Read Only: true

  The unique identifier of the code technician assigned to the case.
• SourceTrxId: string
  Title: Source Transaction ID

  Read Only: true

  Maximum Length: 50

  The unique identifier of the source transaction that created the case.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 15

  The status of the case.
• StatusDescription: string
  Title: Case Status

  Read Only: true

  Maximum Length: 30

  The description of the status of the case.
• SubmitDate: string (date-time)
  Title: Submitted On

  Read Only: true

  The date when the case was submitted.
• TotalFeeDue: number
  Title: Total Due

  Read Only: true

  The total fees due for the case.
• TotalFees: number
  Title: Total Fees

  Read Only: true

  The total fees for the case.
• TotalPaid: number
  Title: Total Paid

  Read Only: true

  The total paid fees for the case.
• TotalPayableFees: number
  Title: Total Payable

  Read Only: true

  The total payable fees for the case.
• TotalPaymentInProcess: number
  Title: Total Payments in Process

  Read Only: true

  The total fees for the case for which payment is in progress.
• UpdateAccess: array Update Case Permissions
  Title: Update Case Permissions

  The update case access resource is used to determine whether a case can be modified.
• UpdateCaseStatusAccess: array Case Status Change Permissions
  Title: Case Status Change Permissions

  The update case status access resource is used to determine whether the status of a case can be modified.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "title":"Migrated Case",
            "maxLength":"3",
            "type":"string",
            "description":"The identifier for the migrated data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateCaseStatusAccess":{
            "title":"Case Status Change Permissions",
            "type":"array",
            "description":"The update case status access resource is used to determine whether the status of a case can be modified.",
            "items":{
                "$ref":"#/components/schemas/publicSectorListCases-UpdateCaseStatusAccess-item-response"
            },
            "x-cardinality":"1"
        },
        "PropertyParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The unique identifier of the property parcel of the case.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferralCode":{
            "title":"Referral Code",
            "maxLength":"100",
            "type":"string",
            "description":"The unique identifier of the referral body of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submitted On",
            "type":"string",
            "description":"The date when the case was submitted.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude of the location of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompliedOn":{
            "title":"Complied On",
            "type":"string",
            "description":"The date on which the case met all requirements for compliance.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LayoutVersion":{
            "maxLength":"30",
            "type":"string",
            "description":"The version of the layout of the intake form for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakeSource":{
            "title":"Intake Source",
            "maxLength":"30",
            "type":"string",
            "description":"The source of the case intake.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "title":"Issue Subtype ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedReason":{
            "title":"Reason for Closing",
            "maxLength":"450",
            "type":"string",
            "description":"The reason for closing the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeReason":{
            "title":"Reason",
            "maxLength":"1000",
            "type":"string",
            "description":"The reason for change of the case status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyProvince":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationDescription":{
            "title":"Location Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusDescription":{
            "title":"Case Status",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the status of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Total Paid",
            "type":"number",
            "description":"The total paid fees for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the parcel retrieved from the map for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DistrictDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the district of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "TotalPayableFees":{
            "title":"Total Payable",
            "type":"number",
            "description":"The total payable fees for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalStatus":{
            "title":"Transaction Status",
            "maxLength":"15",
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "CaseKey":{
            "title":"Case Key",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictType":{
            "title":"District Type",
            "maxLength":"50",
            "type":"string",
            "description":"The type of the district of the location of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The priority of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalPriority":{
            "title":"Internal Priority",
            "maxLength":"30",
            "type":"string",
            "description":"The internal priority of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessCode":{
            "title":"Access Number",
            "maxLength":"5",
            "type":"string",
            "description":"The access code to claim the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude of the location of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsReopened":{
            "maxLength":"5",
            "type":"string",
            "description":"The switch to indicate that the case is reopened.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyState":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstStatus":{
            "title":"Workflow Process Status",
            "maxLength":"15",
            "type":"string",
            "description":"The process instance status of the workflow that is associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTrxId":{
            "title":"Source Transaction ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the source transaction that created the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObsoleteFlag":{
            "title":"Obsolete",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch to indicate that the case is obsolete.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCity":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriticalFlag":{
            "title":"Critical",
            "maxLength":"1",
            "type":"boolean",
            "description":"The switch to indicate that the case is critical.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictTypeDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"The description of the district type of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdministerCaseStatusAccess":{
            "title":"Administer Case Status Permissions",
            "type":"array",
            "description":"The administer case status access resource is used to determine whether the status of a case can be modified.",
            "items":{
                "$ref":"#/components/schemas/publicSectorListCases-AdministerCaseStatusAccess-item-response"
            },
            "x-cardinality":"1"
        },
        "UpdateAccess":{
            "title":"Update Case Permissions",
            "type":"array",
            "description":"The update case access resource is used to determine whether a case can be modified.",
            "items":{
                "$ref":"#/components/schemas/publicSectorListCases-UpdateAccess-item-response"
            },
            "x-cardinality":"1"
        },
        "AssignedCodeTechnicianName":{
            "title":"Code Technician Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the code technician assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakeKey":{
            "title":"Intake Key",
            "type":"integer",
            "description":"The unique identifier of the intake.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency of the case.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ComplianceDueDate":{
            "title":"Compliance Date",
            "type":"string",
            "description":"The compliance date of the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedId":{
            "title":"Inspector Assigned",
            "type":"integer",
            "description":"The unique identifier of the code officer assigned to the case.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyAddressId":{
            "title":"Property Address ID",
            "type":"integer",
            "description":"The unique identifier of the property address of the case.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyPostalPlusFourcode":{
            "title":"Postal Plus 4 Code",
            "maxLength":"10",
            "type":"string",
            "description":"The postal plus code of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeCode":{
            "maxLength":"40",
            "type":"string",
            "description":"The unique identifier of the issue subtype of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFeeDue":{
            "title":"Total Due",
            "type":"number",
            "description":"The total fees due for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarlyComplyByDate":{
            "title":"Earliest of Comply by Dates in Violations",
            "type":"string",
            "description":"The earliest date among all the comply by dates that correspond to open code violations for the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInconsistent":{
            "maxLength":"10",
            "type":"string",
            "description":"The flag to indicate whether the workflow associated with the case is in an inconsistent state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "title":"Issue Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppealDueDate":{
            "title":"Appeal By",
            "type":"string",
            "description":"The appeal due date for the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictId":{
            "title":"District ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the district of the location of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueType":{
            "title":"Issue Type",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the issue type associated with the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "title":"Issue Subtype",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the issue subtype associated with the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportedById":{
            "title":"Reported By",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the person who reported the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "IssueTypeId":{
            "title":"Issue Type ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue type of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaymentInProcess":{
            "title":"Total Payments in Process",
            "type":"number",
            "description":"The total fees for the case for which payment is in progress.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Total Fees",
            "type":"number",
            "description":"The total fees for the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerId":{
            "title":"Technician Assigned",
            "type":"integer",
            "description":"The unique identifier of the code technician assigned to the case.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyCoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-coordinate of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "title":"Closed On",
            "type":"string",
            "description":"The date when the case was closed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeOfficerName":{
            "title":"Code Officer Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the code officer assigned to the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "title":"Workflow Process ID",
            "maxLength":"500",
            "type":"string",
            "description":"The process instance identifier of the workflow associated with the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-coordinate of the property address of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedBy":{
            "title":"Closed By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who closed the case.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "LastComplyByDate":{
            "title":"Latest of Comply by Dates in Violations",
            "type":"string",
            "description":"The latest date among all the comply by dates that correspond to open code violations for the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Administer Case Status Permissions

Type: array

Title: Administer Case Status Permissions

The administer case status access resource is used to determine whether the status of a case can be modified.

Show Source

• Array of: object publicSectorListCases-AdministerCaseStatusAccess-item-response

{
    "title":"Administer Case Status Permissions",
    "type":"array",
    "description":"The administer case status access resource is used to determine whether the status of a case can be modified.",
    "items":{
        "$ref":"#/components/schemas/publicSectorListCases-AdministerCaseStatusAccess-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Update Case Permissions

Type: array

Title: Update Case Permissions

The update case access resource is used to determine whether a case can be modified.

Show Source

• Array of: object publicSectorListCases-UpdateAccess-item-response

{
    "title":"Update Case Permissions",
    "type":"array",
    "description":"The update case access resource is used to determine whether a case can be modified.",
    "items":{
        "$ref":"#/components/schemas/publicSectorListCases-UpdateAccess-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Case Status Change Permissions

Type: array

Title: Case Status Change Permissions

The update case status access resource is used to determine whether the status of a case can be modified.

Show Source

• Array of: object publicSectorListCases-UpdateCaseStatusAccess-item-response

{
    "title":"Case Status Change Permissions",
    "type":"array",
    "description":"The update case status access resource is used to determine whether the status of a case can be modified.",
    "items":{
        "$ref":"#/components/schemas/publicSectorListCases-UpdateCaseStatusAccess-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : publicSectorListCases-AdministerCaseStatusAccess-item-response

Type: object

Show Source

• CaseKey: integer (int64)
  Read Only: true

  The unique identifier of the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorListCases-UpdateAccess-item-response

Type: object

Show Source

• CaseKey: integer (int64)
  Read Only: true

  The unique identifier of the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorListCases-UpdateCaseStatusAccess-item-response

Type: object

Show Source

• CaseKey: integer (int64)
  Read Only: true

  The unique identifier of the case.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top