Jump to

• Request
• Response

Update an inspection group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}

Request

Path Parameters

• publicSectorInspectionGroupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId and InspectionGroup ---for the Inspection Groups resource and used to uniquely identify an instance of Inspection Groups. The client should not generate the hash key value. Instead, the client should query on the Inspection Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Groups.
  
  For example: publicSectorInspectionGroups?q=AgencyId=<value1>;InspectionGroup=<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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an inspection group is available to be applied to a permit, license, or code enforcement record type. The default value is false.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description for a group of inspections that are associated with a permit type.",
            "nullable":false
        },
        "InspectionGroupLine":{
            "title":"Inspection Group Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicSectorInspectionGroups-InspectionGroupLine-item-patch-request"
            }
        }
    }
}

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

• Array of: object publicSectorInspectionGroups-InspectionGroupLine-item-patch-request

{
    "title":"Inspection Group Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicSectorInspectionGroups-InspectionGroupLine-item-patch-request"
    }
}

Nested Schema : publicSectorInspectionGroups-InspectionGroupLine-item-patch-request

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "FinalInspectionFlag":{
            "title":"Final Inspection",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "DependentInspectionTypeCode":{
            "maxLength":"2000",
            "type":"string",
            "description":"The dependent inspection types defined for this inspection type.",
            "nullable":true,
            "x-queryable":false
        },
        "Required":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an inspection is required or not required. If true, the inspection is required. The default value is false.",
            "nullable":false
        },
        "DependentInspectionTypeDescr":{
            "maxLength":"2500",
            "type":"string",
            "description":"The descriptions of the dependent inspection types defined for this inspection type.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorInspectionGroups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the inspection group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inspection group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the inspection group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description for a group of inspections that are associated with a permit type.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "InspectionGroupLine":{
            "title":"Inspection Group Lines",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicSectorInspectionGroups-InspectionGroupLine-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InspectionGroup":{
            "title":"Inspection Group",
            "maxLength":"15",
            "type":"string",
            "description":"The identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an inspection group is available to be applied to a permit, license, or code enforcement record type. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inspection group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorInspectionGroups-InspectionGroupLine-item-response

{
    "title":"Inspection Group Lines",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicSectorInspectionGroups-InspectionGroupLine-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorInspectionGroups-InspectionGroupLine-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for a type of inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the inspection group line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FinalInspectionFlag":{
            "title":"Final Inspection",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "Required":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an inspection is required or not required. If true, the inspection is required. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "DependentInspectionTypeDescr":{
            "maxLength":"2500",
            "type":"string",
            "description":"The descriptions of the dependent inspection types defined for this inspection type.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DependentInspectionTypeCode":{
            "maxLength":"2000",
            "type":"string",
            "description":"The dependent inspection types defined for this inspection type.",
            "nullable":true,
            "x-queryable":false
        },
        "InspectionGroup":{
            "title":"Inspection Group",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for a group of inspections that are associated with a permit, license, or code enforcement record type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the inspection group line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

InspectionGroupLine

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorInspectionGroups/{publicSectorInspectionGroupsUniqID}/child/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.

Back to Top