Create a violation code reference group
post
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
CodeReferenceGroupCode(required): string
Title:
Code Reference Group ID
Maximum Length:100
The violation code reference group code of the record. -
CodeReferences: array
Code References
Title:
Code References
The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases. -
Description: string
Title:
Description
Maximum Length:500
The description of the violation code reference group. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation code reference group is available for use. -
Name(required): string
Title:
Name
Maximum Length:200
The name of the violation code reference group.
Nested Schema : Code References
Type:
array
Title:
Code References
The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
CodeReferenceCode: string
Title:
Code Reference ID
Maximum Length:100
The violation code reference code of the record. -
CodeReferenceGroupCode: string
Title:
Code Reference Group ID
Maximum Length:100
The violation code reference group code of the record. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation code reference is available for use in the group.
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 : publicSectorViolationCodeReferenceGroups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
CodeReferenceGroupCode: string
Title:
Code Reference Group ID
Maximum Length:100
The violation code reference group code of the record. -
CodeReferences: array
Code References
Title:
Code References
The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases. -
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. -
Description: string
Title:
Description
Maximum Length:500
The description of the violation code reference group. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation code reference 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:
Name
Maximum Length:200
The name of the violation code reference group.
Nested Schema : Code References
Type:
array
Title:
Code References
The code reference resource is used to view, create, or modify a violation code reference. Violation code references 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 : publicSectorViolationCodeReferenceGroups-CodeReferences-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
CodeReferenceCode: string
Title:
Code Reference ID
Maximum Length:100
The violation code reference code of the record. -
CodeReferenceGroupCode: string
Title:
Code Reference Group ID
Maximum Length:100
The violation code reference group code 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 code reference is available for use in the 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.
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.
Links
- CodeReferences
-
Parameters:
- publicSectorViolationCodeReferenceGroupsUniqID:
$request.path.publicSectorViolationCodeReferenceGroupsUniqID
The code reference resource is used to view, create, or modify a violation code reference. Violation code references are used in Code Enforcement cases. - publicSectorViolationCodeReferenceGroupsUniqID: