Get all overdue code violations
get
/fscmRestApi/resources/11.13.18.05/publicSectorOverdueCodeViolations
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 code violations that matches the specified search criteria.
Finder Variables:- SourceTransactionKey; integer; The unique identifier of the code reference.
- findByBRFCriteria: Finds the code violations that matches the specified search criteria.
Finder Variables:- Caller; string.
- Criteria; string.
- PrimaryKey: Finds the code violations 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:- CaseComplyBy; string; The comply by date of the code enforcement case.
- CaseFunctionalStatus; string; The user-defined case status name that maps to a delivered system status.
- CaseId; string; The identifier of the case.
- CaseKey; integer; The unique identifier of the case.
- CaseStatus; string; The status of the case.
- CodeReferenceCode; string; The identifier of the code reference.
- CodeReferenceKey; integer; The unique identifier of the code reference.
- CodeReferenceStatus; string; The status of the code reference.
- FeeExists; string; Indicates whether a fee exists for a code violation.
- FeeSource; string; The source from which the fee originated.
- IssueSubtype; string; The issue subtype of the case.
- IssueType; string; The issue type of the case.
- SourceTransactionKey; integer; The unique identifier of the source transaction that created the code violation fees.
- ViolationCompliedOn; string; The complied on date that corresponds to the code violation of the case.
- ViolationComplyBy; string; The comply by date that corresponds to the code violation of the case.
-
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 : publicSectorOverdueCodeViolations
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 : publicSectorOverdueCodeViolations-item-response
Type:
Show Source
object
-
CaseComplyBy: string
(date)
Title:
Compliance Date
Read Only:true
The comply by date of the code enforcement case. -
CaseFunctionalStatus: string
Title:
Transaction Status
Read Only:true
Maximum Length:15
The user-defined case status name that maps to a delivered system status. -
CaseId: string
Title:
Case ID
Read Only:true
Maximum Length:50
The identifier of the case. -
CaseKey: integer
(int64)
Title:
Case Key
Read Only:true
The unique identifier of the case. -
CaseStatus: string
Title:
Case Status
Read Only:true
Maximum Length:15
The status of the case. -
CodeReferenceCode: string
Title:
Code Violation
Read Only:true
Maximum Length:100
The identifier of the code reference. -
CodeReferenceKey: integer
(int64)
Read Only:
true
The unique identifier of the code reference. -
CodeReferenceStatus: string
Title:
Status
Read Only:true
Maximum Length:8
The status of the code reference. -
FeeExists: string
Title:
Fee Exists
Read Only:true
Maximum Length:1
Indicates whether a fee exists for a code violation. -
FeeSource: string
Title:
Fee Source
Read Only:true
Maximum Length:6
The source from which the fee originated. -
IssueSubtype: string
Title:
Issue Subtype
Read Only:true
Maximum Length:100
The issue subtype of the case. -
IssueType: string
Title:
Issue Type
Read Only:true
Maximum Length:100
The issue type of the case. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceTransactionKey: integer
Title:
Source Transaction ID
Read Only:true
The unique identifier of the source transaction that created the code violation fees. -
ViolationCompliedOn: string
(date)
Title:
Complied On
Read Only:true
The complied on date that corresponds to the code violation of the case. -
ViolationComplyBy: string
(date)
Title:
Comply By
Read Only:true
The comply by date that corresponds to the code violation of the case.
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.