1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Code Enforcement
  4. Case Details Without Transients

Get all cases

get

/fscmRestApi/resources/11.13.18.05/publicSectorCaseDetailsWithoutTransients

Request

Query Parameters
  • 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).
  • 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
  • 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:

    • PrimaryKey: Finds the case access that matches the specified search criteria.
      Finder Variables:
      • CaseKey; integer; The unique identifier of the case.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 used to claim the case.
    • AgencyId; integer; The unique identifier of the agency associated with the case.
    • AppealDueDate; string; The appeal due date for the case.
    • AssignedCodeOfficerEmail; string; The email address of the code officer assigned to the case.
    • AssignedCodeOfficerName; string; The name of the code officer assigned to the case.
    • AssignedCodeOfficerPhone; string; The phone number of the code officer assigned to the case.
    • AssignedCodeTechnicianEmail; string; The email address of the code technician assigned to the case.
    • AssignedCodeTechnicianName; string; The name of the code technician assigned to the case.
    • AssignedCodeTechnicianPhone; string; The phone number of the code technician assigned to the case.
    • AssignedId; integer; The unique identifier of the code officer assigned to the case.
    • CaseId; string; The case identifier.
    • CaseKey; integer; The unique identifier of the case.
    • ChangeReason; string; The reason for the case status change.
    • ClosedBy; string; The name of the user who closed the case.
    • ClosedDate; string; The date the case was closed.
    • ClosedReason; string; The reason the case was closed.
    • ComplianceDueDate; string; The compliance date for the case.
    • CompliedOn; string; The date the case met all compliance requirements.
    • CreatedBy; string; The name of the user who created the row.
    • CreationDate; string; The date and time the row was created.
    • CriticalFlag; boolean; Indicates whether the case is critical.
    • DistrictDescription; string; The description of the case district.
    • DistrictId; string; The unique identifier of the district for the case location.
    • DistrictType; string; The district type for the case location.
    • DistrictTypeDescription; string; The description of the case district type.
    • EarlyComplyByDate; string; The earliest ???comply by??? date among 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; Indicates whether the case is reopened.
    • IssueDescription; string; The issue description.
    • IssueSubtype; string; The label for the issue subtype associated with the case.
    • IssueSubtypeCode; string; The description of the case status.
    • IssueSubtypeId; string; The unique identifier of the case issue subtype.
    • IssueType; string; The label for the issue type associated with the case.
    • IssueTypeId; string; The unique identifier of the case issue type.
    • LastComplyByDate; string; The latest ???comply by??? date among open code violations for the case.
    • LastGisSyncDatetime; string; The label for the field that displays the most recent date and time when applications (such as permits, planning applications, and business licenses) were synchronized to GIS mapping.
    • LastUpdateDate; string; The date and time the row was last updated.
    • LastUpdatedBy; string; The name of the user who last updated the row.
    • Latitude; number; The latitude of the case location.
    • LayoutVersion; string; The version of the case intake form layout.
    • LocationDescription; string; The description of the case location.
    • Longitude; number; The longitude of the case location.
    • MigratedDataFlag; string; The migrated data identifier.
    • ObsoleteFlag; boolean; Indicates whether the case is obsolete.
    • ParcelIdEntered; string; The unique identifier of the parcel retrieved from the map for the case.
    • Priority; string; The case priority.
    • ProcessInconsistent; string; Indicates whether the case workflow is in an inconsistent state.
    • ProcessInstStatus; string; The workflow process instance status associated with the case.
    • ProcessInstanceId; string; The workflow process instance identifier associated with the case.
    • PropertyAddress1; string; The first address line of the case property address.
    • PropertyAddress2; string; The second address line of the case property address.
    • PropertyAddress3; string; The third address line of the case property address.
    • PropertyAddress4; string; The fourth address line of the case property address.
    • PropertyAddressId; integer; The unique identifier of the case property address.
    • PropertyCity; string; The city in the case property address.
    • PropertyCoordinateX; number; The x-coordinate of the case property address.
    • PropertyCoordinateY; number; The y-coordinate of the case property address.
    • PropertyCountry; string; The country in the case property address.
    • PropertyCounty; string; The county in the case property address.
    • PropertyParcelId; integer; The unique identifier of the case property parcel.
    • PropertyPostalCode; string; The postal code in the case property address.
    • PropertyPostalPlusFourcode; string; The postal-plus code in the case property address.
    • PropertyProvince; string; The province in the case property address.
    • PropertyState; string; The state in the case property address.
    • ReferralCode; string; The unique identifier of the case referral body.
    • ReportedById; string; The unique identifier of the person who reported the case.
    • ResponsiblePartyEmail; string; The email address of the primary responsible party associated with the case.
    • ResponsiblePartyName; string; The name of the primary responsible party associated with the case.
    • ResponsiblePartyPhone; string; The phone number of the primary responsible party associated with 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 case status.
    • StatusDescription; string; The case status description.
    • SubmitDate; string; The date 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 fees paid for the case.
    • TotalPayableFees; number; The total payable fees for the case.
    • TotalPaymentInProcess; number; The total fees for the case with payment in progress.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : publicSectorCaseDetailsWithoutTransients
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorCaseDetailsWithoutTransients-item-response
Type: object
Show Source
Back to Top