Get all case code references
get
/fscmRestApi/resources/11.13.18.05/publicSectorCaseCodeReferences
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:- CaseCodeReferencePuidKey: Finds the case code reference that matches the specified alternate key.
Finder Variables:- CodeReferencePuid; string; The public unique identifier of the migrated case code reference record.
- PrimaryKey: Finds the case code reference that matches the specified search criteria.
Finder Variables:- CodeReferenceKey; integer; The unique identifier for a case code reference.
- CaseCodeReferencePuidKey: Finds the case code reference 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:- AgencyId; integer; The agency identifier of the case code reference.
- CaseId; string; The unique identifier of the case.
- CaseKey; integer; The unique identifier of the case.
- CasePuid; string; The public unique identifier of the migrated case record.
- CodeReferenceCode; string; The identifier of the violation code reference.
- CodeReferenceKey; integer; The unique identifier of the case code reference.
- CodeReferenceName; string; The name of the violation code reference.
- CodeReferencePuid; string; The public unique identifier of the migrated case code reference record.
- Comments; string; The comments associated with the code violation.
- CompliedOn; string; The date on which the code violation is complied on.
- ComplyBy; string; The date by which the code violation should be complied on.
- CorrectiveActionCode; string; The identifier of the corrective action.
- CorrectiveActionName; string; The name of the corrective action.
- CreationDate; string; The date and time when the row was created.
- FeeFrequencyUnit; string; The fee frequency of the code violation.
- FeeRate; number; The fee rate associated with the code violation.
- LastUpdateDate; string; The date and time when the row was last updated.
- SourceInspectionKey; integer; The unique identifier of the code enforcement inspection.
- SourceInspectionPuid; string; The public unique identifier of the migrated code enforcement inspection record.
- Status; string; Indicates the status code of the code violation.
- StatusText; string; Indicates the status text of the code violation.
- TotalFees; number; The total fees calculated for the code violation.
- TotalPaidFees; number; The total fees paid for the code violation.
-
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 : publicSectorCaseCodeReferences
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 : publicSectorCaseCodeReferences-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the case code reference. -
CaseId: string
Read Only:
true
Maximum Length:50
The unique identifier of the case. -
CaseKey: integer
(int64)
The unique identifier of the case.
-
CasePuid: string
Maximum Length:
480
Default Value:The public unique identifier of the migrated case record. -
ChangeReasonCode: string
Default Value:
ORA_ADMIN
The identifier of the change reason. -
ChangeReasonText: string
The description of the change reason.
-
CodeReferenceCode: string
Title:
Code Violation
Maximum Length:100
The identifier of the violation code reference. -
CodeReferenceDescription: string
(byte)
The description of the violation code reference.
-
CodeReferenceKey: integer
(int64)
The unique identifier of the case code reference.
-
CodeReferenceName: string
Maximum Length:
200
The name of the violation code reference. -
CodeReferencePuid: string
Maximum Length:
480
The public unique identifier of the migrated case code reference record. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments associated with the code violation. -
CompliedOn: string
(date)
Title:
Complied On
The date on which the code violation is complied on. -
ComplyBy: string
(date)
Title:
Comply By
The date by which the code violation should be complied on. -
CorrectiveActionCode: string
Maximum Length:
100
The identifier of the corrective action. -
CorrectiveActionDescription: string
(byte)
The description of the corrective action.
-
CorrectiveActionName: string
Maximum Length:
200
The name of the corrective action. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
FeeFrequencyUnit: string
Title:
Frequency
Maximum Length:30
Default Value:ORA_F
The fee frequency of the code violation. -
FeeRate: number
Title:
Rate
Default Value:0
The fee rate associated with the code violation. -
FeeRecords: array
Case Fee Records
Title:
Case Fee Records
The case fee record resource is used to view, create, or modify a case code violation. Case fee records are used in Code Enforcement cases. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceInspectionKey: integer
(int64)
The unique identifier of the code enforcement inspection.
-
SourceInspectionPuid: string
Maximum Length:
480
The public unique identifier of the migrated code enforcement inspection record. -
SourceTransactionContext: string
Maximum Length:
80
Default Value:ORA_MAN
The source transaction context type associated with the code violation. -
SourceTransactionContextKey: integer
The unique identifier of the source transaction context.
-
Status: string
Title:
Status
Maximum Length:8
Default Value:ORA_OPEN
Indicates the status code of the code violation. -
StatusText: string
Read Only:
true
Maximum Length:255
Indicates the status text of the code violation. -
TotalFees: number
Title:
Total Fine
Read Only:true
The total fees calculated for the code violation. -
TotalPaidFees: number
Title:
Total Fine Paid
Read Only:true
The total fees paid for the code violation.
Nested Schema : Case Fee Records
Type:
array
Title:
Case Fee Records
The case fee record resource is used to view, create, or modify a case code violation. Case fee records are used in Code Enforcement cases.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCaseCodeReferences-FeeRecords-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The agency identifier of the case fee record. -
AssessedDate: string
(date-time)
Title:
Assessed Date
The date on which the fee was assessed for the case fee record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
Default Value:USD
The currency code for the case fee record. -
DepartmentId: string
Maximum Length:
30
The department identifier of the case fee record. -
DueDate: string
(date)
Title:
Due Date
The due date to pay the case fee. -
FeeAmount: number
Title:
Amount
The fee amount for the case fee record. -
FeeItemId: string
Title:
Fee Item
Maximum Length:30
The fee item identifier of the case fee record. -
FeeMemo: string
Title:
Comments
Maximum Length:500
The fee comments for the case fee record. -
FeeQuantity: number
Title:
Quantity
Default Value:1
The fee quantity for the case fee record. -
FeeRecordId: string
Title:
Fee Record ID
Read Only:true
Maximum Length:50
The unique identifier of the case fee record. -
FeeRecordKey: integer
(int64)
Read Only:
true
The unique identifier of the case fee record. -
FeeStatus: string
Title:
Status
Maximum Length:15
Default Value:ORA_DUE
The fee status for the case fee record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingSource: string
Read Only:
true
Maximum Length:10
The mapping source type for the case fee record.
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.