Jump to

• Request
• Response

Get an inspection communication item

get

/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCommunicationsWithoutTransients/{publicSectorInspectionCommunicationsWithoutTransientsUniqID}

Request

Path Parameters

• publicSectorInspectionCommunicationsWithoutTransientsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LnpRecordKey and InspectionId ---for the Inspection Communications Without Transients resource and used to uniquely identify an instance of Inspection Communications Without Transients. The client should not generate the hash key value. Instead, the client should query on the Inspection Communications Without Transients collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Communications Without Transients.
  
  For example: publicSectorInspectionCommunicationsWithoutTransients?q=LnpRecordKey=<value1>;InspectionId=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

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 : publicSectorInspectionCommunicationsWithoutTransients-item-response

Type: object

Show Source

• Applicant: integer (int64)
  Title: Applicant

  Read Only: true

  The party ID of the person applying for the application.
• ApplicantEmailAddress1: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The permit applicant???s email address.
• ApplicantEmailAddress2: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The permit applicant???s additional email address.
• ApplicantPersonName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The permit applicant???s name.
• ApplicantPersonNameSuffix: string
  Title: Applicant Suffix

  Read Only: true

  Maximum Length: 30

  The suffix for the permit applicant???s name.
• ApplicantPhoneAreaCode: string
  Title: Applicant Phone Area Code

  Read Only: true

  Maximum Length: 10

  The area code for the permit applicant???s phone number.
• ApplicantPhoneCountryCode: string
  Title: Applicant Phone Country Code

  Read Only: true

  Maximum Length: 10

  The country code for the permit applicant???s phone number.
• ApplicantPhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The extension for the permit applicant???s phone number.
• ApplicantPhoneNumber: string
  Title: Applicant Phone

  Read Only: true

  Maximum Length: 40

  The permit applicant???s phone number.
• AssessFee: string
  Title: Assess Fee

  Read Only: true

  Maximum Length: 1

  Indicates whether fees should be assessed for the inspection.
• ContactEmail: string
  Title: Contact Email

  Read Only: true

  Maximum Length: 320

  The email address of the contact at the inspection site.
• ContactName: string
  Title: Location Contact

  Read Only: true

  Maximum Length: 450

  The name of the contact at the inspection site.
• EstimatedTimeArrival: string (date-time)
  Title: Inspection ETA From

  Read Only: true

  The earliest estimated arrival time at the building inspection site.
• EstimatedTimeArrivalEnd: string (date-time)
  Title: Inspection ETA To

  Read Only: true

  The latest estimated arrival time at the building inspection site.
• FeesBalanceDue: number
  Title: Fees Balance Due

  Read Only: true

  The balance due for the inspection.
• FinalInspection: string
  Title: Final Inspection

  Read Only: true

  Maximum Length: 1

  Indicates whether this is the final inspection (default is no).
• GenJobCost: number
  Title: Job Cost

  Read Only: true

  The construction job cost (used in the Construction Information component of the Permit Designer).
• HideFromUserFlag: string
  Title: Unannounced

  Read Only: true

  Maximum Length: 1

  Indicates whether the inspection is displayed to a nonagency user before completion (default is false, meaning it is always displayed to nonagency users).
• InspectionAddress1: string
  Title: Inspection Address Line 1

  Read Only: true

  Maximum Length: 240

  The first address line of the building inspection site.
• InspectionAddress2: string
  Title: Inspection Address Line 2

  Read Only: true

  Maximum Length: 240

  The second address line of the building inspection site.
• InspectionCity: string
  Title: Inspection City

  Read Only: true

  Maximum Length: 60

  The city in the building inspection site address.
• InspectionCompleteDttm: string (date-time)
  Title: Completion Date

  Read Only: true

  The date and time the inspection was completed.
• InspectionCountry: string
  Title: Inspection Country

  Read Only: true

  Maximum Length: 3

  The country in the building inspection site address.
• InspectionCounty: string
  Title: Inspection County

  Read Only: true

  Maximum Length: 60

  The county in the building inspection site address.
• InspectionId: string
  Title: Inspection

  Read Only: true

  Maximum Length: 50

  The unique identifier of an inspection.
• InspectionKey: integer (int64)
  Title: Inspection Key

  Read Only: true

  The key for an inspection record.
• InspectionLocation: string
  Title: Inspection Location

  Read Only: true

  Maximum Length: 100

  The location where the inspection will be performed.
• InspectionPostalCode: string
  Title: Inspection Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the building inspection site address.
• InspectionProvince: string
  Title: Inspection Province

  Read Only: true

  Maximum Length: 60

  The province in the building inspection site address.
• InspectionRating: string
  Title: Rating

  Read Only: true

  Maximum Length: 5

  The overall inspection rating, calculated using a defined rating method.
• InspectionResult: string
  Title: Result

  Read Only: true

  Maximum Length: 25

  The inspection result (for example, Pass, Fail, Yes, or No).
• InspectionResultDescr: string
  Title: Result Description

  Read Only: true

  Maximum Length: 100

  The inspection result description.
• InspectionScore: integer (int32)
  Title: Score

  Read Only: true

  The calculated total inspection score.
• InspectionState: string
  Title: Inspection State

  Read Only: true

  Maximum Length: 60

  The state in the building inspection site address.
• InspectionStatus: string
  Title: Inspection Status

  Read Only: true

  Maximum Length: 100

  The description of the inspection status.
• InspectionType: string
  Title: Inspection Type

  Read Only: true

  Maximum Length: 100

  The unique identifier of an inspection type.
• InspectorId: integer (int64)
  Title: Inspector ID

  Read Only: true

  The inspector assigned to the inspection.
• InspectorName: string
  Title: Inspector

  Read Only: true

  Maximum Length: 360

  The inspector???s name.
• LastGisSyncDatetime: string (date-time)
  Title: GIS Last Synced

  Read Only: true

  The date and time the transaction information was last synchronized to GIS.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Application ID

  Read Only: true

  Maximum Length: 50

  The building permit record identifier (for example, Building Permit ID RA-2017-00029).
• LnpRecordKey: integer
  Read Only: true

  The unique identifier of a permit record.
• LocationLatitude: number
  Title: Latitude

  Read Only: true

  The latitude of the inspection location.
• LocationLongitude: number
  Title: Longitude

  Read Only: true

  The longitude of the inspection location.
• NumberMajorViolations: integer (int32)
  Title: Major Violation Count

  Read Only: true

  The total number of major violations for the inspection.
• Owner: string
  Title: Owner

  Read Only: true

  Maximum Length: 150

  The primary (or only) owner of the parcel or property.
• OwnerEmailId: string
  Title: Owner Email

  Read Only: true

  Maximum Length: 50

  The parcel owner???s email address.
• ParcelId: integer (int64)
  Title: Parcel

  Read Only: true

  The identifier of the record parcel.
• ParcelIdEntered: string
  Title: Parcel Number

  Read Only: true

  Maximum Length: 50

  The unique identifier of the parcel retrieved from the map.
• PermitDescription: string
  Title: Permit Description

  Read Only: true

  Maximum Length: 255

  The permit record description.
• PermitStatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 15

  The permit record status.
• PermitStatusDescription: string
  Title: Application Status Description

  Read Only: true

  Maximum Length: 100

  The permit record status description.
• PermitSystemStatus: string
  Title: Application System Status

  Read Only: true

  Maximum Length: 15

  The permit record status code.
• RecordType: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The permit type shown on the inspection schedule page (for example, a residential addition).
• RecordTypeId: string
  Title: Application Type ID

  Read Only: true

  Maximum Length: 30

  The unique alphanumeric code or short name for the record type.
• ReinspectionFlag: string
  Title: Reinspection

  Read Only: true

  Maximum Length: 1

  Indicates whether the inspection is a reinspection (default is no).
• ReinspectionIdBy: string
  Title: Reinspected By

  Read Only: true

  Maximum Length: 50

  The unique identifier of the reinspection.
• ReinspectionIdOf: string
  Title: Reinspection Of

  Read Only: true

  Maximum Length: 50

  The unique identifier of the failed inspection that requires a reinspection.
• RequiredFlag: string
  Title: Required

  Read Only: true

  Maximum Length: 1

  Indicates whether the inspection is required (defaults from the inspection group; if not available, the default is no/not required).
• ScheduledEndDttm: string (date-time)
  Title: Schedule End Date

  Read Only: true

  The scheduled inspection end date.
• ScheduledStartDttm: string (date-time)
  Title: Schedule Start Date

  Read Only: true

  The scheduled inspection start date.
• SecondaryOwner: string
  Title: Secondary Owner

  Read Only: true

  Maximum Length: 150

  The secondary owner of the parcel or property.
• SystemResult: string
  Title: System Result

  Read Only: true

  Maximum Length: 20

  The unique alphanumeric code or short name for the inspection result.

{
    "type":"object",
    "properties":{
        "Applicant":{
            "title":"Applicant",
            "type":"integer",
            "description":"The party ID of the person applying for the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":320,
            "type":"string",
            "description":"The permit applicant???s email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress2":{
            "title":"Applicant Email 2",
            "maxLength":320,
            "type":"string",
            "description":"The permit applicant???s additional email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplicantPersonName":{
            "title":"Applicant Name",
            "maxLength":450,
            "type":"string",
            "description":"The permit applicant???s name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPersonNameSuffix":{
            "title":"Applicant Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix for the permit applicant???s name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneAreaCode":{
            "title":"Applicant Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"The area code for the permit applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneCountryCode":{
            "title":"Applicant Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the permit applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The extension for the permit applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone",
            "maxLength":40,
            "type":"string",
            "description":"The permit applicant???s phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessFee":{
            "title":"Assess Fee",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether fees should be assessed for the inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmail":{
            "title":"Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the contact at the inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ContactName":{
            "title":"Location Contact",
            "maxLength":450,
            "type":"string",
            "description":"The name of the contact at the inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedTimeArrival":{
            "title":"Inspection ETA From",
            "type":"string",
            "description":"The earliest estimated arrival time at the building inspection site.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedTimeArrivalEnd":{
            "title":"Inspection ETA To",
            "type":"string",
            "description":"The latest estimated arrival time at the building inspection site.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeesBalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The balance due for the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "FinalInspection":{
            "title":"Final Inspection",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this is the final inspection (default is no).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenJobCost":{
            "title":"Job Cost",
            "type":"number",
            "description":"The construction job cost (used in the Construction Information component of the Permit Designer).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HideFromUserFlag":{
            "title":"Unannounced",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the inspection is displayed to a nonagency user before completion (default is false, meaning it is always displayed to nonagency users).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionAddress1":{
            "title":"Inspection Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the building inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionAddress2":{
            "title":"Inspection Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the building inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCity":{
            "title":"Inspection City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the building inspection site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCompleteDttm":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date and time the inspection was completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCountry":{
            "title":"Inspection Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the building inspection site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCounty":{
            "title":"Inspection County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the building inspection site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionId":{
            "title":"Inspection",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of an inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionKey":{
            "title":"Inspection Key",
            "type":"integer",
            "description":"The key for an inspection record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionLocation":{
            "title":"Inspection Location",
            "maxLength":100,
            "type":"string",
            "description":"The location where the inspection will be performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionPostalCode":{
            "title":"Inspection Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the building inspection site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionProvince":{
            "title":"Inspection Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the building inspection site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionRating":{
            "title":"Rating",
            "maxLength":5,
            "type":"string",
            "description":"The overall inspection rating, calculated using a defined rating method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionResult":{
            "title":"Result",
            "maxLength":25,
            "type":"string",
            "description":"The inspection result (for example, Pass, Fail, Yes, or No).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionResultDescr":{
            "title":"Result Description",
            "maxLength":100,
            "type":"string",
            "description":"The inspection result description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated total inspection score.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "InspectionState":{
            "title":"Inspection State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the building inspection site address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatus":{
            "title":"Inspection Status",
            "maxLength":100,
            "type":"string",
            "description":"The description of the inspection status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of an inspection type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectorId":{
            "title":"Inspector ID",
            "type":"integer",
            "description":"The inspector assigned to the inspection.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectorName":{
            "title":"Inspector",
            "maxLength":360,
            "type":"string",
            "description":"The inspector???s name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastGisSyncDatetime":{
            "title":"GIS Last Synced",
            "type":"string",
            "description":"The date and time the transaction information was last synchronized to GIS.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":50,
            "type":"string",
            "description":"The building permit record identifier (for example, Building Permit ID RA-2017-00029).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of a permit record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLatitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude of the inspection location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationLongitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude of the inspection location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberMajorViolations":{
            "title":"Major Violation Count",
            "type":"integer",
            "description":"The total number of major violations for the inspection.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":150,
            "type":"string",
            "description":"The primary (or only) owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerEmailId":{
            "title":"Owner Email",
            "maxLength":50,
            "type":"string",
            "description":"The parcel owner???s email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the parcel retrieved from the map.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitDescription":{
            "title":"Permit Description",
            "maxLength":255,
            "type":"string",
            "description":"The permit record description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatus":{
            "title":"Application Status",
            "maxLength":15,
            "type":"string",
            "description":"The permit record status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatusDescription":{
            "title":"Application Status Description",
            "maxLength":100,
            "type":"string",
            "description":"The permit record status description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitSystemStatus":{
            "title":"Application System Status",
            "maxLength":15,
            "type":"string",
            "description":"The permit record status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":100,
            "type":"string",
            "description":"The permit type shown on the inspection schedule page (for example, a residential addition).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Application Type ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReinspectionFlag":{
            "title":"Reinspection",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the inspection is a reinspection (default is no).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReinspectionIdBy":{
            "title":"Reinspected By",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the reinspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReinspectionIdOf":{
            "title":"Reinspection Of",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the failed inspection that requires a reinspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the inspection is required (defaults from the inspection group; if not available, the default is no/not required).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledEndDttm":{
            "title":"Schedule End Date",
            "type":"string",
            "description":"The scheduled inspection end date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledStartDttm":{
            "title":"Schedule Start Date",
            "type":"string",
            "description":"The scheduled inspection start date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryOwner":{
            "title":"Secondary Owner",
            "maxLength":150,
            "type":"string",
            "description":"The secondary owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemResult":{
            "title":"System Result",
            "maxLength":20,
            "type":"string",
            "description":"The unique alphanumeric code or short name for the inspection result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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