Update a violation notice type
patch
/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeTypes/{publicSectorViolationNoticeTypesUniqID}
Request
Path Parameters
-
publicSectorViolationNoticeTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and NoticeTypeCode ---for the Violation Notice Types resource and used to uniquely identify an instance of Violation Notice Types. The client should not generate the hash key value. Instead, the client should query on the Violation Notice Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Notice Types.
For example: publicSectorViolationNoticeTypes?q=AgencyId=<value1>;NoticeTypeCode=<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
-
BipTemplateId: string
Title:
Report Mapping
Maximum Length:32
The report definition of the record. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation notice type is available for use. -
Name: string
Title:
Name
Maximum Length:200
The name of the violation notice type.
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 : publicSectorViolationNoticeTypes-item-response
Type:
Show Source
object
-
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 description of the notice type. -
BipTemplateId: string
Title:
Report Mapping
Maximum Length:32
The report definition of the 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. -
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:
Name
Maximum Length:200
The name of the violation notice type. -
NoticeTypeCode: string
Title:
ID
Maximum Length:100
The violation notice type code of the 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.