Jump to

• Request
• Response

Create an inspection action is not supported

post

/fscmRestApi/resources/11.13.18.05/publicSectorUnasgnInspections

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorUnasgnInspections-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  The first line of the address on the inspection.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second line of the address on the inspection.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third line of the address on the inspection.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth line of the address on the inspection.
• AddressId: integer (int64)
  Read Only: true

  The unique identifier of the record parcel address.
• AgencyId: integer (int32)
  Read Only: true

  The unique identifier of the agency associated with the inspection.
• City: string
  Read Only: true

  Maximum Length: 60

  The city of the address on the inspection.
• Country: string
  Read Only: true

  Maximum Length: 3

  The country of the address on the inspection.
• County: string
  Read Only: true

  Maximum Length: 60

  The county of the address on the inspection.
• Description: string
  Read Only: true

  Maximum Length: 100

  The description of the inspection, which comes from the inspection type.
• EstimatedDurationHrs: number
  Read Only: true

  The estimated duration of the inspection in hours.
• InspectionCompleteDttm: string (date-time)
  Read Only: true

  The date and time at which the inspection was completed.
• InspectionDistrict: string
  Read Only: true

  Maximum Length: 50

  The district on the inspection.
• InspectionGroup: string
  Read Only: true

  Maximum Length: 15

  The inspection group associated with the permit.
• InspectionId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the inspection.
• InspectionKey: integer (int64)
  Read Only: true

  The unique identifier of the inspection.
• InspectionResult: string
  Read Only: true

  Maximum Length: 25

  The result of the inspection as recorded by the inspector.
• InspectionStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the inspection.
• InspectionType: string
  Read Only: true

  Maximum Length: 15

  The inspection type on the inspection.
• InspectorId: integer (int64)
  Read Only: true

  The unique identifier of the inspector assigned to the inspection.
• InspectorName: string
  Read Only: true

  Maximum Length: 360

  The name of the assigned inspector.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the application record.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier of the record associated with the permit.
• ParcelId: integer (int64)
  Read Only: true

  The unique identifier of the record parcel.
• PermitDescription: string
  Read Only: true

  Maximum Length: 1000

  The description of the record associated with the inspection.
• PostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code of the address on the inspection.
• PreferredDate: string (date-time)
  Read Only: true

  The preferred date for the inspection to be performed.
• PreferredInspectorName: string
  Read Only: true

  Maximum Length: 360

  The name of the preferred inspector.
• PreferredTime: string
  Read Only: true

  Maximum Length: 15

  The preferred time for the inspection to be performed.
• PriorInspectorName: string
  Read Only: true

  Maximum Length: 360

  The name of the inspector assigned to the prior inspection associated with this reinspection.
• ReadyByDttm: string (date-time)
  Read Only: true

  The date and time after which the inspection can be performed.
• ReinspectionIdBy: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the inspection that is the reinspection of this inspection.
• ReinspectionIdOf: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the prior inspection associated with this reinspection.
• ScheduledEndDttm: string (date-time)
  Read Only: true

  The date and time that the inspection is scheduled to end.
• ScheduledStartDttm: string (date-time)
  Read Only: true

  The date and time that the inspection is scheduled to start.
• SchedulingMethod: string
  Read Only: true

  Maximum Length: 15

  The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
• State: string
  Read Only: true

  Maximum Length: 60

  The state code of the address on the inspection.
• SystemResult: string
  Read Only: true

  Maximum Length: 20

  The code that represents the result of the inspection.
• SystemStatus: string
  Read Only: true

  Maximum Length: 15

  The code that represents the status of the inspection.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "maxLength":15,
            "type":"string",
            "description":"The inspection type on the inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SchedulingMethod":{
            "maxLength":15,
            "type":"string",
            "description":"The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the inspection, which comes from the inspection type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the inspection.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ScheduledEndDttm":{
            "type":"string",
            "description":"The date and time that the inspection is scheduled to end.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredInspectorName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the preferred inspector.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemResult":{
            "maxLength":20,
            "type":"string",
            "description":"The code that represents the result of the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectorName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the assigned inspector.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledStartDttm":{
            "type":"string",
            "description":"The date and time that the inspection is scheduled to start.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReinspectionIdBy":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the inspection that is the reinspection of this inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReinspectionIdOf":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the prior inspection associated with this reinspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredTime":{
            "maxLength":15,
            "type":"string",
            "description":"The preferred time for the inspection to be performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedDurationHrs":{
            "type":"number",
            "description":"The estimated duration of the inspection in hours.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":8,
                "scale":2
            },
            "x-queryable":true
        },
        "InspectionKey":{
            "type":"integer",
            "description":"The unique identifier of the inspection.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PriorInspectorName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the inspector assigned to the prior inspection associated with this reinspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionGroup":{
            "maxLength":15,
            "type":"string",
            "description":"The inspection group associated with the permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the record parcel address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The code that represents the status of the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the record associated with the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the application record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier of the record parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionDistrict":{
            "maxLength":50,
            "type":"string",
            "description":"The district on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionResult":{
            "maxLength":25,
            "type":"string",
            "description":"The result of the inspection as recorded by the inspector.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record associated with the permit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionCompleteDttm":{
            "type":"string",
            "description":"The date and time at which the inspection was completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectorId":{
            "type":"integer",
            "description":"The unique identifier of the inspector assigned to the inspection.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state code of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadyByDttm":{
            "type":"string",
            "description":"The date and time after which the inspection can be performed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the address on the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredDate":{
            "type":"string",
            "description":"The preferred date for the inspection to be performed.",
            "format":"date-time",
            "nullable":true,
            "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."
        }
    }
}

Back to Top