Create an inspection group
post
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups
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 for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
Description(required): string
Title:
Description
Maximum Length:100
The description for a group of inspections that are associated with a permit type. -
EnabledFlag(required): boolean
Title:
Enabled
Maximum Length:1
Indicates whether an inspection group is available to be applied to a permit, license, or code enforcement record type. The default value is false. -
InspectionGroup(required): string
Title:
Inspection Group
Maximum Length:15
The identifier for a group of inspections that are associated with a permit, license, or code enforcement record type. -
InspectionGroupLine: array
Inspection Group Lines
Title:
Inspection Group Lines
The inspection group line resource is used to view, create, delete, or modify an inspection group line. An inspection group line identifies the individual inspection types associated with a permit, license, or plan.
Nested Schema : Inspection Group Lines
Type:
array
Title:
Inspection Group Lines
The inspection group line resource is used to view, create, delete, or modify an inspection group line. An inspection group line identifies the individual inspection types associated with a permit, license, or plan.
Show Source
Nested Schema : publicSectorInspectionGroups-InspectionGroupLine-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
DependentInspectionTypeCode: string
Maximum Length:
2000
The dependent inspection types defined for this inspection type. -
DependentInspectionTypeDescr: string
Maximum Length:
2500
The descriptions of the dependent inspection types defined for this inspection type. -
FinalInspectionFlag: boolean
Title:
Final Inspection
Maximum Length:1
Indicates the final inspection in an inspection group. Only one inspection in the group can be selected as the final inspection. The default value is false. -
InspectionGroup: string
Title:
Inspection Group
Maximum Length:15
The unique identifier for a group of inspections that are associated with a permit, license, or code enforcement record type. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The unique identifier for a type of inspection. -
Required: boolean
Title:
Required
Maximum Length:1
Indicates whether an inspection is required or not required. If true, the inspection is required. The default value is false.
Response
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 : publicSectorInspectionGroups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the inspection group. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the inspection group was created. -
Description: string
Title:
Description
Maximum Length:100
The description for a group of inspections that are associated with a permit type. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether an inspection group is available to be applied to a permit, license, or code enforcement record type. The default value is false. -
InspectionGroup: string
Title:
Inspection Group
Maximum Length:15
The identifier for a group of inspections that are associated with a permit, license, or code enforcement record type. -
InspectionGroupLine: array
Inspection Group Lines
Title:
Inspection Group Lines
The inspection group line resource is used to view, create, delete, or modify an inspection group line. An inspection group line identifies the individual inspection types associated with a permit, license, or plan. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the inspection group was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the inspection group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Inspection Group Lines
Type:
array
Title:
Inspection Group Lines
The inspection group line resource is used to view, create, delete, or modify an inspection group line. An inspection group line identifies the individual inspection types associated with a permit, license, or plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorInspectionGroups-InspectionGroupLine-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the inspection group line was created. -
DependentInspectionTypeCode: string
Maximum Length:
2000
The dependent inspection types defined for this inspection type. -
DependentInspectionTypeDescr: string
Maximum Length:
2500
The descriptions of the dependent inspection types defined for this inspection type. -
FinalInspectionFlag: boolean
Title:
Final Inspection
Maximum Length:1
Indicates the final inspection in an inspection group. Only one inspection in the group can be selected as the final inspection. The default value is false. -
InspectionGroup: string
Title:
Inspection Group
Maximum Length:15
The unique identifier for a group of inspections that are associated with a permit, license, or code enforcement record type. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The unique identifier for a type of inspection. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the inspection group line was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Required: boolean
Title:
Required
Maximum Length:1
Indicates whether an inspection is required or not required. If true, the inspection is required. The default value is false.
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
- InspectionGroupLine
-
Parameters:
- publicSectorInspectionGroupsUniqID:
$request.path.publicSectorInspectionGroupsUniqID
The inspection group line resource is used to view, create, delete, or modify an inspection group line. An inspection group line identifies the individual inspection types associated with a permit, license, or plan. - publicSectorInspectionGroupsUniqID: