Get all cases
get
/fscmRestApi/resources/11.13.18.05/publicSectorCases
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:- CasePUIDKey: Finds the case that matches the specified alternate key.
Finder Variables:- CasePuid; string; The public unique identifier of the migrated case record.
- 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; 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: Finds the case that matches the specified search criteria.
Finder Variables:- value; string; Finds the case that matches the specified search value.
- CasePUIDKey: Finds the case that matches the specified alternate key.
-
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 of the case.
- AgencyId; integer; The unique identifier of the agency of the case.
- AppealDueDate; string; The last date by which a user is allowed to submit an appeal for the case.
- AssignedId; integer; The unique identifier of the code officer assigned to the case.
- AssignedPuid; string; The public 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.
- CasePuid; string; The public unique identifier of the migrated case record.
- 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 code violation of the case was complied on.
- 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.
- DistrictId; string; The unique identifier of the district of the location of the case.
- DistrictType; string; The type of district associated with 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.
- IntakePuid; string; The public unique identifier of the migrated intake record.
- IntakeSource; string; The source of the case intake.
- InternalPriority; string; The internal priority of the case.
- IssueDescription; string; The description of the issue.
- IssueSubtype; string; The name of the issue subtype associated with 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.
- 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.
- LocationDescription; string; The description of the location.
- Longitude; number; The longitude of the location of the case.
- 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.
- 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.
- ReviewerPuid; string; The public unique identifier of the code technician assigned to the case.
- SourceTransactionPuid; string; The public unique identifier of the migrated source transaction record.
- 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.
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorCases
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCases-item-response
Type:
Show Source
object
-
AccessCode: string
Title:
Access Number
Maximum Length:5
The access code of the case. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency of the case. -
AppealDueDate: string
(date)
Title:
Appeal By
The last date by which a user is allowed to submit an appeal for the case. -
AssignedId: integer
(int64)
Title:
Inspector Assigned
The unique identifier of the code officer assigned to the case. -
AssignedPuid: string
The public unique identifier of the code officer assigned to the case.
-
CaseCodeReference: array
Code Violation
Title:
Code Violation
The code violation resource is used to view the code violation associated with a case. -
CaseId: string
Title:
Case ID
Maximum Length:50
The identifier of the case. -
CaseKey: integer
(int64)
The unique identifier of the case.
-
CasePuid: string
Maximum Length:
480
The public unique identifier of the migrated case record. -
ChangeReason: string
The reason for modifying the case.
-
ClosedBy: string
Title:
Closed By
Maximum Length:64
The name of the user who closed the case. -
ClosedDate: string
(date-time)
Title:
Closed On
The date when the case was closed. -
ClosedReason: string
Title:
Reason for Closing
Maximum Length:450
The reason for closing the case. -
ComplianceDueDate: string
(date)
Title:
Compliance Date
The compliance date of the case. -
CompliedOn: string
(date)
The date on which the code violation of the case was complied on.
-
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
Maximum Length:1
Default Value:false
The switch to indicate that the case is critical. -
DistrictId: string
Maximum Length:
30
The unique identifier of the district of the location of the case. -
DistrictType: string
Title:
District Type
Maximum Length:50
The type of district associated with the case. -
FunctionalStatus: string
Maximum Length:
15
The user defined case status name that maps to a delivered system status. -
InspectionActDate: string
(date)
The completion date of the case inspection.
-
IntakeKey: integer
(int64)
Read Only:
true
The unique identifier of the intake. -
IntakePuid: string
Maximum Length:
480
Default Value:The public unique identifier of the migrated intake record. -
IntakeSource: string
Maximum Length:
30
Default Value:ORA_CS
The source of the case intake. -
InternalPriority: string
Title:
Internal Priority
Maximum Length:30
Default Value:ORA_N
The internal priority of the case. -
IssueDescription: string
Title:
Issue Description
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. -
IssueSubtypeId: string
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
Maximum Length:
50
The unique identifier of the issue type of 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
The latitude of the location of the case.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDescription: string
Title:
Location Description
Maximum Length:1000
The description of the location. -
Longitude: number
The longitude of the location of the case.
-
ObsoleteFlag: boolean
Maximum Length:
1
Default Value:false
The switch to indicate that the case is obsolete. -
ParcelIdEntered: string
Maximum Length:
30
The unique identifier of the parcel retrieved from the map for the case. -
Priority: string
Title:
Priority
Maximum Length:30
Default Value:ORA_N
The priority of the case. -
PropertyAddress1: string
Title:
Address Line 1
Maximum Length:240
The first line of the property address of the case. -
PropertyAddress2: string
Title:
Address Line 2
Maximum Length:240
The second line of the property address of the case. -
PropertyAddress3: string
Title:
Address Line 3
Maximum Length:240
The third line of the property address of the case. -
PropertyAddress4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the property address of the case. -
PropertyAddressId: integer
(int64)
The unique identifier of the property address of the case.
-
PropertyCity: string
Title:
City
Maximum Length:60
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
Title:
Country
Maximum Length:3
The country of the property address of the case. -
PropertyCounty: string
Maximum Length:
60
The county of the property address of the case. -
PropertyOwnerId: integer
The unique identifier of the property owner of the case.
-
PropertyParcelId: integer
(int64)
The unique identifier of the property parcel of the case.
-
PropertyPostalCode: string
Maximum Length:
60
The postal code of the property address of the case. -
PropertyPostalPlusFourCode: string
Maximum Length:
10
The postal plus code of the property address of the case. -
PropertyProvince: string
Maximum Length:
60
The province of the property address of the case. -
PropertyState: string
Title:
State Name
Maximum Length:60
The state of the property address of the case. -
ReferralCode: string
Title:
Referred To
Maximum Length:100
The unique identifier of the referral body of the case. -
ReportedById: string
Title:
Reported By
Maximum Length:64
The unique identifier of the person who reported the case. -
ReviewerId: integer
(int64)
Title:
Technician Assigned
The unique identifier of the code technician assigned to the case. -
ReviewerPuid: string
The public unique identifier of the code technician assigned to the case.
-
Shape: object
Shape
Read Only:
true
The shape of the property associated with the case. -
SourceTransactionPuid: string
The public unique identifier of the migrated source transaction record.
-
SourceTrxId: string
Maximum Length:
50
The unique identifier of the source transaction that created the case. -
Status: string
Title:
Case Status
Maximum Length:15
Default Value:ORA_VIO
The status of the case. -
StatusDescription: string
Title:
Description
Read Only:true
Maximum Length:30
The description of the status of the case. -
SubmitDate: string
(date-time)
Title:
Submitted On
The date when the case was submitted. -
UpdateAllComplyBy: string
Maximum Length:
80
Default Value:N
The indicator to update the code violation comply by date.
Nested Schema : Code Violation
Type:
array
Title:
Code Violation
The code violation resource is used to view the code violation associated with a case.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shape
Type:
object
Read Only:
true
The shape of the property associated with the case.
Nested Schema : publicSectorCases-CaseCodeReference-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
-
CaseId: string
Read Only:
true
Maximum Length:50
-
CaseKey: integer
(int64)
-
CasePuid: string
Maximum Length:
480
Default Value: -
ChangeReasonCode: string
Title:
Reason for Update
Default Value:ORA_ADMIN
-
ChangeReasonText: string
Title:
Description
-
CodeReferenceCode: string
Title:
Code Violation
Maximum Length:100
-
CodeReferenceDescription: string
(byte)
-
CodeReferenceKey: integer
(int64)
-
CodeReferenceName: string
Maximum Length:
200
-
CodeReferencePuid: string
Maximum Length:
480
-
Comments: string
Title:
Comments
Maximum Length:1000
-
CompliedOn: string
(date)
Title:
Complied On
-
ComplyBy: string
(date)
Title:
Comply By
-
CorrectiveActionCode: string
Maximum Length:
100
-
CorrectiveActionDescription: string
(byte)
-
CorrectiveActionName: string
Maximum Length:
200
-
CreationDate: string
(date-time)
Read Only:
true
-
FeeFrequencyUnit: string
Title:
Frequency
Maximum Length:30
Default Value:ORA_F
-
FeeRate: number
Title:
Rate
Default Value:0
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceInspectionKey: integer
(int64)
-
SourceInspectionPuid: string
Maximum Length:
480
-
SourceTransactionContext: string
Maximum Length:
80
Default Value:ORA_MAN
-
SourceTransactionContextKey: integer
-
Status: string
Title:
Status
Maximum Length:8
Default Value:ORA_OPEN
-
StatusText: string
Read Only:
true
Maximum Length:255
-
TotalFees: number
Title:
Total Fine
Read Only:true
-
TotalPaidFees: number
Title:
Total Fine Paid
Read Only:true
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.