Update an ad hoc violation notice type in a violation notice group
patch
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/AdhocNotices/{AdhocNoticesUniqID}
Request
Path Parameters
-
AdhocNoticesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, NoticeGroupCode and NoticeTypeCode ---for the Violation Ad Hoc Notices resource and used to uniquely identify an instance of Violation Ad Hoc Notices. The client should not generate the hash key value. Instead, the client should query on the Violation Ad Hoc Notices collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Ad Hoc Notices.
For example: AdhocNotices?q=AgencyId=<value1>;NoticeGroupCode=<value2>;NoticeTypeCode=<value3> -
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
-
CategoryCode: string
Title:
Ad Hoc Notice Category
Maximum Length:30
The user defined category identifier of an ad hoc notice. -
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. -
NoticeCount: integer
(int32)
Title:
Count
The sequence of the notice 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-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.