Get all cases
get
/fscmRestApi/resources/11.13.18.05/publicSectorUserCases
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:- PrimaryKey: Finds the case that matches the specified search criteria.
Finder Variables:- CaseKey; integer; The unique identifier of the case.
- findCaseById: Finds the case that matches the specified case identifier.
Finder Variables:- inputCaseId; string; The identifier of the case.
- simpleSearchFinder: Finds the case that matches the specified search criteria.
Finder Variables:- value; string; Finds the case that matches the specified search value.
- PrimaryKey: Finds the case that matches the specified search criteria.
-
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:- ActiveInspection; string; A flag to indicate whether there is an active inspection for the case.
- AppealCreationDate; string; The date when an appeal for the case was submitted.
- AppealHearingDate; string; The date when the hearing for the appeal is scheduled.
- CaseAttachmentCount; integer; The count of case attachments added by responsible parties.
- CaseId; string; The identifier of the case.
- CaseKey; integer; The unique identifier of the case.
- CitationCount; integer; The number of citations issued for the case.
- CodeOfficerDisplayName; string; The name of the code officer assigned to the case.
- CodeOfficerPhoneNumber; string; The phone number of the code officer assigned to the case.
- ComplianceDueDate; string; The compliance date of the case.
- CurrencyCode; string; The currency code associated with the fees for the case.
- EarliestDueAmount; number; The fee amount that is due on the earliest due date for the case.
- EarliestDueDate; string; The earliest date for which fees are due for the case.
- FunctionalStatus; string; The user defined case status name that maps to a delivered system status.
- HearingBody; string; The name of the hearing body that has scheduled the hearing.
- IssueDescription; string; The description of the issue.
- IssueSubtype; string; The name of the issue subtype associated with the case.
- IssueType; string; The name of the issue type 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.
- PropertyCity; string; The city 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.
- 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.
- Status; string; The status of the case.
- StatusName; string; The name of the status of the case.
- SubmitDate; string; The date when the case was submitted.
- TotalCaseFees; number; Total fees to be paid for the case.
- TotalFeesPaid; number; Total fee amount that is paid for the case.
- TotalPaymentInProcess; number; Total fee amount for the case for which payment is in process.
-
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:
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.
Root Schema : publicSectorUserCases
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 : publicSectorUserCases-item-response
Type:
Show Source
object
-
ActiveInspection: string
Read Only:
true
Maximum Length:255
A flag to indicate whether there is an active inspection for the case. -
AllowCaseAppeals: array
Allow Case Appeals
Title:
Allow Case Appeals
The allow case appeal resource is used to view a case appeal allowance. Case appeals are used in code enforcement cases. -
AppealCreationDate: string
(date-time)
Title:
Appeal Requested On
Read Only:true
The date when an appeal for the case was submitted. -
AppealHearingDate: string
(date-time)
Title:
Hearing Scheduled For
Read Only:true
The date when the hearing for the appeal is scheduled. -
CaseAttachmentCount: integer
Read Only:
true
The count of case attachments added by responsible parties. -
CaseCodeReference: array
Code Violations
Title:
Code Violations
The code violation resource is used to view a code violation of the case. -
CaseId: string
Title:
Case ID
Read Only:true
Maximum Length:50
The identifier of the case. -
CaseKey: integer
(int64)
Read Only:
true
The unique identifier of the case. -
CitationCount: integer
Read Only:
true
The number of citations issued for the case. -
CodeOfficerDisplayName: string
Title:
Code Officer
Read Only:true
Maximum Length:255
The name of the code officer assigned to the case. -
CodeOfficerPhoneNumber: string
Title:
Code Officer Phone Number
Read Only:true
Maximum Length:255
The phone number of the code officer assigned to the case. -
ComplianceDueDate: string
(date)
Title:
Compliance Date
Read Only:true
The compliance date of the case. -
CurrencyCode: string
Read Only:
true
Maximum Length:255
The currency code associated with the fees for the case. -
EarliestDueAmount: number
Read Only:
true
The fee amount that is due on the earliest due date for the case. -
EarliestDueDate: string
(date)
Title:
Due On
Read Only:true
The earliest date for which fees are due for the case. -
FunctionalStatus: string
Read Only:
true
Maximum Length:15
The user defined case status name that maps to a delivered system status. -
HearingBody: string
Read Only:
true
The name of the hearing body that has scheduled the hearing. -
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. -
IssueType: string
Title:
Issue Type
Read Only:true
Maximum Length:100
The name of the issue type associated with the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
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. -
PropertyCity: string
Title:
City
Read Only:true
Maximum Length:60
The city of the property address of the case. -
PropertyCountry: string
Read Only:
true
Maximum Length:3
The country of the property address of the case. -
PropertyCounty: string
Read Only:
true
Maximum Length:60
The county of the property address of the case. -
PropertyPostalCode: string
Read Only:
true
Maximum Length:60
The postal code of the property address of the case. -
PropertyPostalPlusFourCode: string
Read Only:
true
Maximum Length:10
The postal plus code of the property address of the case. -
PropertyProvince: string
Read Only:
true
Maximum Length:60
The province of the property address of the case. -
PropertyState: string
Title:
State Name
Read Only:true
Maximum Length:60
The state of the property address of the case. -
Status: string
Title:
Case Status
Read Only:true
Maximum Length:15
Default Value:ORA_VIO
The status of the case. -
StatusName: string
Title:
Status
Read Only:true
Maximum Length:30
The name of the status of the case. -
SubmitDate: string
(date-time)
Title:
Submitted On
Read Only:true
The date when the case was submitted. -
TotalCaseFees: number
Title:
Total Due
Read Only:true
Total fees to be paid for the case. -
TotalFeesPaid: number
Title:
Total Paid
Read Only:true
Total fee amount that is paid for the case. -
TotalPaymentInProcess: number
Title:
Payment in Progress
Read Only:true
Total fee amount for the case for which payment is in process. -
UserCaseFeePayments: array
Case Fee Payments
Title:
Case Fee Payments
The user case fee payment resource is used to view the fee payments of the case. -
UserNotices: array
User Notices
Title:
User Notices
The user notice resource is used to view a notice issued to a user. Notices can be issued for code enforcement violations or citations.
Nested Schema : Allow Case Appeals
Type:
array
Title:
Allow Case Appeals
The allow case appeal resource is used to view a case appeal allowance. Case appeals are used in code enforcement cases.
Show Source
Nested Schema : Code Violations
Type:
array
Title:
Code Violations
The code violation resource is used to view a code violation of the case.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Case Fee Payments
Type:
array
Title:
Case Fee Payments
The user case fee payment resource is used to view the fee payments of the case.
Show Source
Nested Schema : User Notices
Type:
array
Title:
User Notices
The user notice resource is used to view a notice issued to a user. Notices can be issued for code enforcement violations or citations.
Show Source
Nested Schema : publicSectorUserCases-AllowCaseAppeals-item-response
Type:
Show Source
object
-
AppealDueDate: string
(date)
Title:
Appeal By
Read Only:true
The last date by which a user can submit an appeal for the case. -
CaseKey: integer
(int64)
Read Only:
true
The unique identifier of the case. -
DenyReasonCode: string
Read Only:
true
The reason due to which appeal is not allowed for the case. -
IsAppealAllowed: boolean
Read Only:
true
Maximum Length:255
Indicates whether appeal is allowed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : publicSectorUserCases-CaseCodeReference-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
The identifier of the agency. -
CaseId: string
Read Only:
true
Maximum Length:50
The identifier of the case. -
CaseKey: integer
(int64)
Read Only:
true
The unique identifier of the case. -
CodeRefCode: string
Read Only:
true
Maximum Length:100
The reference code for the case code violation. -
CodeRefDescription: string
(byte)
Read Only:
true
The reference description for the case code violation. -
CoderefKey: integer
Read Only:
true
The unique identifier of the case code violation. -
CodeRefName: string
Read Only:
true
Maximum Length:200
The reference name for the case code violation. -
CorrectiveActionCode: string
Read Only:
true
Maximum Length:100
The code for the corrective action of the case code violation. -
CorrectiveActionDescription: string
(byte)
Read Only:
true
The description for the corrective action of the case code violation. -
CorrectiveActionName: string
Read Only:
true
Maximum Length:200
The name for the corrective action of the case code violation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Status: string
Read Only:
true
Maximum Length:8
The status of the case code violation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorUserCases-UserCaseFeePayments-item-response
Type:
Show Source
object
-
CaseKey: integer
Read Only:
true
The unique identifier of the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PaymentDate: string
(date)
Read Only:
true
The date of the case fee payment. -
PaymentHistoryKey: integer
(int64)
Read Only:
true
The unique identifier of the case fee payment history. -
PaymentReferenceId: string
Read Only:
true
Maximum Length:50
The reference identifier of the case fee payment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorUserCases-UserNotices-item-response
Type:
Show Source
object
-
CaseKey: integer
(int64)
Read Only:
true
The unique identifier of the case associated with the case notice. -
CaseNoticeId: string
Title:
Notice ID
Read Only:true
Maximum Length:50
The identifier of the case notice. -
CaseNoticeKey: integer
(int64)
Read Only:
true
The unique identifier of the case notice. -
GeneratedDate: string
(date-time)
Title:
Generated Date
Read Only:true
The date of generation of the case notice. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source