Get all violation notice groups
get
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups
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 violation notice group that matches the specified search criteria.
Finder Variables:- AgencyId; integer; The identifier of the agency.
- NoticeGroupCode; string; The violation notice group code.
- simpleSearchFinder: Finds the violation notice group that matches the specified search criteria.
Finder Variables:- value; string; Finds the violation notice group that matches the specified search value.
- PrimaryKey: Finds the violation notice group 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:- AgencyId; integer; The identifier of the agency.
- ApplicationCategory; string; The application category of the notice type.
- ApplicationCategoryName; string; The application category name of the notice type.
- CaseCreationFlag; boolean; Indicates whether to create a system notice on case creation.
- CreatedBy; string; The name of the user who created the row.
- CreationDate; string; The date and time when the row was created.
- EnabledFlag; boolean; Indicates whether the violation notice group is available for use.
- LastUpdateDate; string; The date and time when the row was last updated.
- LastUpdatedBy; string; The name of the user who last updated the row.
- Name; string; The name of the violation notice group.
- NoticeGroupCode; string; The violation notice group code of the record.
-
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 : publicSectorViolationNoticeGroups
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 : publicSectorViolationNoticeGroups-item-response
Type:
Show Source
object
-
AdhocNotices: array
Violation Ad Hoc Notices
Title:
Violation Ad Hoc Notices
The violation ad hoc notice resource is used to view, create, or modify a violation ad hoc notice type mapping within a violation notice group. Violation ad hoc notice types are used in Code Enforcement cases. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
ApplicationCategory: string
Title:
Classification
Maximum Length:15
Default Value:ORA_CASE
The application category of the notice type. -
ApplicationCategoryName: string
Read Only:
true
Maximum Length:255
The application category name of the notice type. -
CaseCreationFlag: boolean
Title:
Create System Notice on Case Creation
Maximum Length:20
Default Value:true
Indicates whether to create a system notice on case creation. -
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. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation notice group is available for use. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Group Name
Maximum Length:200
The name of the violation notice group. -
NoticeGroupCode: string
Title:
Group ID
Maximum Length:100
The violation notice group code of the record. -
NoticeMappings: array
Violation Notice Type Mappings
Title:
Violation Notice Type Mappings
The violation notice type mapping resource is used to view, create, or modify a violation notice type mapping in a violation notice group. Violation notice types are used in Code Enforcement cases.
Nested Schema : Violation Ad Hoc Notices
Type:
array
Title:
Violation Ad Hoc Notices
The violation ad hoc notice resource is used to view, create, or modify a violation ad hoc notice type mapping within a violation notice group. Violation ad hoc notice types 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 : Violation Notice Type Mappings
Type:
array
Title:
Violation Notice Type Mappings
The violation notice type mapping resource is used to view, create, or modify a violation notice type mapping in a violation notice group. Violation notice types are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorViolationNoticeGroups-AdhocNotices-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
CategoryCode: string
Title:
Ad Hoc Notice Category
Maximum Length:30
The user defined category identifier of an ad hoc notice. -
CategoryCodeName: string
Title:
Category Name
Read Only:true
Maximum Length:255
The user defined category name of an ad hoc notice. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation notice type is available for use in the violation notice group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
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. -
NoticeCount: integer
(int32)
Title:
Count
The sequence of the notice record. -
NoticeGroupCode: string
Title:
Group ID
Maximum Length:100
The violation notice group code of the record. -
NoticeTypeCode: string
Title:
ID
Maximum Length:100
The violation notice type code of the record. -
NoticeTypeName: string
Title:
Name
Read Only:true
Maximum Length:255
The name of the ad hoc notice type associated with the notice group.
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 : publicSectorViolationNoticeGroups-NoticeMappings-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
CaseStatus: string
Title:
Status
Maximum Length:15
The status of the case record. -
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. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation notice type is available for use in the violation notice group. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoticeCount: integer
(int32)
Title:
Sequence
The sequence of the notice record. -
NoticeGroupCode: string
Title:
Group ID
Maximum Length:100
The violation notice group code of the record. -
NoticeTypeCode: string
Title:
ID
Maximum Length:100
The violation notice type code of the record. -
NoticeTypeName: string
Title:
Name
Read Only:true
Maximum Length:255
The name of the notice type associated with the notice group. -
StatusName: string
Title:
Status
Read Only:true
Maximum Length:255
The status name of the record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source