Update a violation notice group
patch
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}
Request
Path Parameters
-
publicSectorViolationNoticeGroupsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and NoticeGroupCode ---for the Violation Notice Groups resource and used to uniquely identify an instance of Violation Notice Groups. The client should not generate the hash key value. Instead, the client should query on the Violation Notice Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Notice Groups.
For example: publicSectorViolationNoticeGroups?q=AgencyId=<value1>;NoticeGroupCode=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AdhocNotices: array
Violation Ad Hoc Notices
Title:
Violation Ad Hoc NoticesThe 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. -
CaseCreationFlag: boolean
Title:
Create System Notice on Case CreationMaximum Length:20Default Value:trueIndicates whether to create a system notice on case creation. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Default Value:trueIndicates whether the violation notice group is available for use. -
Name: string
Title:
Group NameMaximum Length:200The name of the violation notice group. -
NoticeMappings: array
Violation Notice Type Mappings
Title:
Violation Notice Type MappingsThe 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:
arrayTitle:
Violation Ad Hoc NoticesThe 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 : Violation Notice Type Mappings
Type:
arrayTitle:
Violation Notice Type MappingsThe 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 : schema
Type:
Show Source
object-
CategoryCode: string
Title:
Ad Hoc Notice CategoryMaximum Length:30The user defined category identifier of an ad hoc notice. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Default Value:trueIndicates whether the violation notice type is available for use in the violation notice group. -
NoticeCount: integer
(int32)
Title:
CountThe sequence of the notice record.
Nested Schema : schema
Type:
Show Source
object-
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Default Value:trueIndicates whether the violation notice type is available for use in the violation notice group. -
NoticeTypeCode: string
Title:
IDMaximum Length:100The violation notice type code of the record.
Response
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 : publicSectorViolationNoticeGroups-item-response
Type:
Show Source
object-
AdhocNotices: array
Violation Ad Hoc Notices
Title:
Violation Ad Hoc NoticesThe 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 IDDefault Value:1The identifier of the agency. -
ApplicationCategory: string
Title:
ClassificationMaximum Length:15Default Value:ORA_CASEThe application category of the notice type. -
ApplicationCategoryName: string
Read Only:
trueMaximum Length:255The application category name of the notice type. -
CaseCreationFlag: boolean
Title:
Create System Notice on Case CreationMaximum Length:20Default Value:trueIndicates whether to create a system notice on case creation. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the row was created. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Default Value:trueIndicates whether the violation notice group is available for use. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The name of the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
Group NameMaximum Length:200The name of the violation notice group. -
NoticeGroupCode: string
Title:
Group IDMaximum Length:100The violation notice group code of the record. -
NoticeMappings: array
Violation Notice Type Mappings
Title:
Violation Notice Type MappingsThe 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:
arrayTitle:
Violation Ad Hoc NoticesThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Violation Notice Type Mappings
Type:
arrayTitle:
Violation Notice Type MappingsThe 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 IDDefault Value:1The identifier of the agency. -
CategoryCode: string
Title:
Ad Hoc Notice CategoryMaximum Length:30The user defined category identifier of an ad hoc notice. -
CategoryCodeName: string
Title:
Category NameRead Only:trueMaximum Length:255The user defined category name of an ad hoc notice. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the row was created. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Default Value:trueIndicates whether the violation notice type is available for use in the violation notice group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the row was last updated. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoticeCount: integer
(int32)
Title:
CountThe sequence of the notice record. -
NoticeGroupCode: string
Title:
Group IDMaximum Length:100The violation notice group code of the record. -
NoticeTypeCode: string
Title:
IDMaximum Length:100The violation notice type code of the record. -
NoticeTypeName: string
Title:
NameRead Only:trueMaximum Length:255The name of the ad hoc notice type associated with the notice group.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 IDDefault Value:1The identifier of the agency. -
CaseStatus: string
Title:
StatusMaximum Length:15The status of the case record. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the row was created. -
EnabledFlag: boolean
Title:
EnabledMaximum Length:1Default Value:trueIndicates whether the violation notice type is available for use in the violation notice group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The name of the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoticeCount: integer
(int32)
Title:
SequenceThe sequence of the notice record. -
NoticeGroupCode: string
Title:
Group IDMaximum Length:100The violation notice group code of the record. -
NoticeTypeCode: string
Title:
IDMaximum Length:100The violation notice type code of the record. -
NoticeTypeName: string
Title:
NameRead Only:trueMaximum Length:255The name of the notice type associated with the notice group. -
StatusName: string
Title:
StatusRead Only:trueMaximum Length:255The status name of the record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- AdhocNotices
-
Parameters:
- publicSectorViolationNoticeGroupsUniqID:
$request.path.publicSectorViolationNoticeGroupsUniqID
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. - publicSectorViolationNoticeGroupsUniqID:
- NoticeMappings
-
Parameters:
- publicSectorViolationNoticeGroupsUniqID:
$request.path.publicSectorViolationNoticeGroupsUniqID
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. - publicSectorViolationNoticeGroupsUniqID: