Jump to

• Request
• Response

Get all business license inspection communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorBlInspectionCommunications

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a business license inspection communication item using the specified inspection identifiers.
    Finder Variables:
    • InspectionId; string; The unique identifier for a business license inspection.
    • LnpRecordKey; integer; The unique identifier for a business license record.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActivityDescription; string; The business license application description.
  • ActivityStatus; string; The status of the business license activity.
  • ActivitySystemStatus; string; The predefined system status to which the activity status maps.
  • AgencyUser; string; Indicates whether the business license inspection was last modified by an agency user.
  • Applicant; integer; The party ID of the person applying for the business license.
  • ApplicantEmailAddress1; string; The business license applicant's email address.
  • ApplicantEmailAddress2; string; The business license applicant's additional email address.
  • ApplicantLoginId; string; The business license applicant login ID.
  • ApplicantPersonName; string; The business license applicant name.
  • ApplicantPersonNameSuffix; string; The suffix to the business license applicant name.
  • ApplicantPhoneAreaCode; string; The area code for the business license applicant's phone number.
  • ApplicantPhoneCountryCode; string; The country code for the business license applicant's phone number.
  • ApplicantPhoneExtension; string; The business license applicant phone number extension.
  • ApplicantPhoneNumber; string; The business license applicant phone number.
  • ApplicantUserId; string; The business license applicant user ID.
  • AssessFee; string; Indicates whether fees should be assessed for the business license inspection. The default is N for no.
  • BusBusinessLegalName; string; The name of the applicant's business. For example, a contractor enters his or her contracting business name.
  • BusDbaBusinessName; string; The field in the business information component of the form designer used to describe the business name, which is different than the legal business name.
  • CancellationReason; string; The reason for canceling the business license inspection.
  • Classification; string; The classification of the application record.
  • ContactEmail; string; The email of the contact at the business license inspection site.
  • ContactName; string; The name of the contact at the inspection site.
  • ContactTextMessage; string; The contact???s phone number for text messages.
  • EstimatedTimeArrival; string; The inspector's earliest estimated time of arrival at the business license inspection site.
  • EstimatedTimeArrivalEnd; string; The inspector's latest estimated time of arrival at the business license inspection site.
  • FeeBalanceDue; number; Displays the fee balance due for the business license.
  • FinalInspection; string; Indicates whether this is the final business license inspection. The default is N for no.
  • HideFromUserFlag; string; Indicates whether the inspection will be displayed to a nonagency user prior to completion. The default value is false, which indicates the inspection is always displayed to nonagency users.
  • InspectionAddress1; string; The first address line of the business license inspection site.
  • InspectionAddress2; string; The second address line of the business license inspection site.
  • InspectionCity; string; The city in the address of the business license inspection site.
  • InspectionCompleteDttm; string; The date and time when the business license inspection was completed.
  • InspectionCountry; string; The country in the address of the business license inspection site.
  • InspectionCounty; string; The county in the address of the business license inspection site.
  • InspectionId; string; The unique identifier for a business license inspection.
  • InspectionLocation; string; The location where the business license inspection will take place.
  • InspectionPostalCode; string; The postal code in the address of the business license inspection site.
  • InspectionProvince; string; The province in the address of the business license inspection site.
  • InspectionRating; string; The overall rating of the business license inspection, which is calculated based on a defined rating method.
  • InspectionResult; string; The results of the business license inspection. For example, Pass, Fail, Yes, or No.
  • InspectionScore; integer; The calculated total score of the business license inspection.
  • InspectionState; string; The state in the address of the business license inspection site.
  • InspectionStatus; string; The business license inspection status description.
  • InspectionType; string; The unique identifier for a business license inspection type.
  • InspectionUpdateDate; string; The date when the record was last updated.
  • InspectorArrival; string; The time when the inspector is expected to arrive for an inspection. The value can be displayed as Date Only, Specific Time, or Time Range, as specified in the agency options.
  • InspectorEmail; string; The inspector email address.
  • InspectorId; integer; The inspector assigned to the business license inspection.
  • InspectorLoginId; string; The inspector login ID.
  • InspectorName; string; The name of the inspector.
  • InspectorPhone; string; The inspector phone number.
  • InspectorUserId; string; The inspector user ID.
  • LicenseStatus; string; The status of the business license application.
  • LnpRecordId; string; The business license record identifier. For example, a license ID with a value such as License ID RA-2017-00029.
  • LnpRecordKey; integer; The unique identifier for a business license record.
  • NumberMajorViolations; integer; The total number of major violations for the business license inspection.
  • Owner; string; The primary or only owner of the parcel or property.
  • OwnerEmailId; string; The parcel owner email address.
  • ParcelId; integer; The identifier of the record parcel.
  • RecordType; string; The user-friendly name for the business license application type.
  • RecordTypeId; string; The unique alphanumeric code or short name for the record type.
  • ScheduledEndDttm; string; The scheduled business license inspection end date.
  • ScheduledStartDttm; string; The scheduled business license inspection start date.
  • ScheduledTimeRange; string; Displays the business license Inspection's scheduled time range based on the defined setup of the application type.
  • SecondaryOwner; string; The secondary owner of the parcel or property.
  • Subclassification; string; The subclassification for the application record.
  • SystemResult; string; The unique alphanumeric code or short name for the business license inspection result.
  • Url; string; The business license inspection URL used within a communications template.
  • UrlLabel; string; The label displayed for a business license inspection URL used within a communications template.
  • VersionType; string; The version of the business license. Values are original, amendment, and renewal.
  • WfProcessId; string; The workflow process ID.
  • WorkflowAssignedDate; string; The date when the workflow task was assigned.
  • WorkflowDueDate; string; The workflow task due date.
  • WorkflowTaskId; string; The workflow task ID.
  • WorkflowTaskName; string; The workflow task name.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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(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 : publicSectorBlInspectionCommunications

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorBlInspectionCommunications-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Inspections",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorBlInspectionCommunications-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBlInspectionCommunications-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 : publicSectorBlInspectionCommunications-item-response

Type: object

Show Source

• ActivityDescription: string
  Title: Activity Description

  Read Only: true

  Maximum Length: 255

  The business license application description.
• ActivityStatus: string
  Title: Activity Status

  Read Only: true

  Maximum Length: 255

  The status of the business license activity.
• ActivitySystemStatus: string
  Title: Activity System Status

  Read Only: true

  Maximum Length: 255

  The predefined system status to which the activity status maps.
• AgencyUser: string
  Title: Agency User

  Read Only: true

  Indicates whether the business license inspection was last modified by an agency user.
• Applicant: integer (int64)
  Read Only: true

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

  Read Only: true

  Maximum Length: 320

  The business license applicant's email address.
• ApplicantEmailAddress2: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The business license applicant's additional email address.
• ApplicantLoginId: string
  Read Only: true

  The business license applicant login ID.
• ApplicantPersonName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The business license applicant name.
• ApplicantPersonNameSuffix: string
  Title: Applicant Suffix

  Read Only: true

  Maximum Length: 30

  The suffix to the business license applicant name.
• ApplicantPhoneAreaCode: string
  Title: Applicant Phone Area Code

  Read Only: true

  Maximum Length: 10

  The area code for the business license applicant's phone number.
• ApplicantPhoneCountryCode: string
  Title: Applicant Phone Country Code

  Read Only: true

  Maximum Length: 10

  The country code for the business license applicant's phone number.
• ApplicantPhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The business license applicant phone number extension.
• ApplicantPhoneNumber: string
  Title: Applicant Phone

  Read Only: true

  Maximum Length: 40

  The business license applicant phone number.
• ApplicantUserId: string
  Title: Applicant User ID

  Read Only: true

  The business license applicant user ID.
• AssessFee: string
  Title: Assess Fee

  Read Only: true

  Maximum Length: 1

  Indicates whether fees should be assessed for the business license inspection. The default is N for no.
• BusBusinessLegalName: string
  Title: Business Legal Name

  Read Only: true

  Maximum Length: 255

  The name of the applicant's business. For example, a contractor enters his or her contracting business name.
• BusDbaBusinessName: string
  Title: Doing Business As

  Read Only: true

  Maximum Length: 255

  The field in the business information component of the form designer used to describe the business name, which is different than the legal business name.
• CancellationReason: string
  Title: Cancellation Reason

  Read Only: true

  Maximum Length: 255

  The reason for canceling the business license inspection.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 255

  The classification of the application record.
• ContactEmail: string
  Title: Contact Email

  Read Only: true

  Maximum Length: 320

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

  Read Only: true

  Maximum Length: 450

  The name of the contact at the inspection site.
• ContactTextMessage: string
  Title: Location Contact Mobile Phone

  Read Only: true

  The contact???s phone number for text messages.
• EstimatedTimeArrival: string (date-time)
  Title: Inspection ETA From

  Read Only: true

  The inspector's earliest estimated time of arrival at the business license inspection site.
• EstimatedTimeArrivalEnd: string (date-time)
  Title: Inspection ETA To

  Read Only: true

  The inspector's latest estimated time of arrival at the business license inspection site.
• FeeBalanceDue: number
  Title: Fees Balance Due

  Displays the fee balance due for the business license.
• FinalInspection: string
  Title: Final Inspection

  Read Only: true

  Maximum Length: 1

  Indicates whether this is the final business license inspection. The default is N for no.
• HideFromUserFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the inspection will be displayed to a nonagency user prior to completion. The default value is false, which indicates the inspection 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 business license inspection site.
• InspectionAddress2: string
  Title: Inspection Address Line 2

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 3

  The country in the address of the business license inspection site.
• InspectionCounty: string
  Title: Inspection County

  Read Only: true

  Maximum Length: 60

  The county in the address of the business license inspection site.
• InspectionId: string
  Title: Inspection

  Read Only: true

  Maximum Length: 50

  The unique identifier for a business license inspection.
• InspectionLocation: string
  Title: Inspection Location

  Read Only: true

  Maximum Length: 100

  The location where the business license inspection will take place.
• InspectionPostalCode: string
  Title: Inspection Postal Code

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 60

  The province in the address of the business license inspection site.
• InspectionRating: string
  Title: Rating

  Read Only: true

  Maximum Length: 5

  The overall rating of the business license inspection, which is calculated based on a defined rating method.
• InspectionResult: string
  Title: Result

  Read Only: true

  Maximum Length: 25

  The results of the business license inspection. For example, Pass, Fail, Yes, or No.
• InspectionScore: integer (int32)
  Title: Score

  Read Only: true

  The calculated total score of the business license inspection.
• InspectionState: string
  Title: Inspection State

  Read Only: true

  Maximum Length: 60

  The state in the address of the business license inspection site.
• InspectionStatus: string
  Title: Inspection Status

  Read Only: true

  Maximum Length: 100

  The business license inspection status description.
• InspectionType: string
  Title: Inspection Type

  Read Only: true

  Maximum Length: 100

  The unique identifier for a business license inspection type.
• InspectionUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• InspectorArrival: string
  Title: Inspector Arrival

  Read Only: true

  Maximum Length: 255

  The time when the inspector is expected to arrive for an inspection. The value can be displayed as Date Only, Specific Time, or Time Range, as specified in the agency options.
• InspectorEmail: string
  Title: Inspector Email

  Read Only: true

  The inspector email address.
• InspectorId: integer (int64)
  Title: Inspector ID

  Read Only: true

  The inspector assigned to the business license inspection.
• InspectorLoginId: string
  Read Only: true

  The inspector login ID.
• InspectorName: string
  Title: Inspector

  Read Only: true

  Maximum Length: 360

  The name of the inspector.
• InspectorPhone: string
  Title: Inspector Phone

  Read Only: true

  The inspector phone number.
• InspectorUserId: string
  Title: Inspector User ID

  Read Only: true

  The inspector user ID.
• LicenseStatus: string
  Title: License Status

  Read Only: true

  Maximum Length: 255

  The status of the business license application.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 50

  The business license record identifier. For example, a license ID with a value such as License ID RA-2017-00029.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for a business license record.
• NumberMajorViolations: integer (int32)
  Title: Major Violation Count

  Read Only: true

  The total number of major violations for the business license 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 email address.
• ParcelId: integer (int64)
  Title: Parcel

  Read Only: true

  The identifier of the record parcel.
• RecordType: string
  Title: License Type

  Read Only: true

  Maximum Length: 100

  The user-friendly name for the business license application type.
• RecordTypeId: string
  Title: Record Type ID

  Read Only: true

  Maximum Length: 30

  The unique alphanumeric code or short name for the record type.
• ScheduledEndDttm: string (date-time)
  Title: Schedule End Date

  Read Only: true

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

  Read Only: true

  The scheduled business license inspection start date.
• ScheduledTimeRange: string
  Title: Inspection Scheduled Time Range

  Read Only: true

  Displays the business license Inspection's scheduled time range based on the defined setup of the application type.
• SecondaryOwner: string
  Title: Secondary Owner

  Read Only: true

  Maximum Length: 150

  The secondary owner of the parcel or property.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 255

  The subclassification for the application record.
• SystemResult: string
  Title: System Result

  Read Only: true

  Maximum Length: 20

  The unique alphanumeric code or short name for the business license inspection result.
• Url: string
  Title: Inspection URL

  Read Only: true

  The business license inspection URL used within a communications template.
• UrlLabel: string
  Title: Communications URL Label

  Read Only: true

  The label displayed for a business license inspection URL used within a communications template.
• VersionType: string
  Title: Version Type

  Read Only: true

  Maximum Length: 255

  The version of the business license. Values are original, amendment, and renewal.
• WfProcessId: string
  Title: Workflow Process Definition

  Read Only: true

  Maximum Length: 255

  The workflow process ID.
• WorkflowAssignedDate: string
  Title: Workflow Assigned Date

  Read Only: true

  The date when the workflow task was assigned.
• WorkflowDueDate: string
  Read Only: true

  The workflow task due date.
• WorkflowTaskId: string
  Title: Workflow Task ID

  Read Only: true

  The workflow task ID.
• WorkflowTaskName: string
  Title: Workflow Task Name

  Read Only: true

  The workflow task name.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for a business license inspection type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":255,
            "type":"string",
            "description":"The subclassification for the application record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantUserId":{
            "title":"Applicant User ID",
            "type":"string",
            "description":"The business license applicant user ID.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplicantPersonNameSuffix":{
            "title":"Applicant Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix to the business license applicant name.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "InspectorPhone":{
            "title":"Inspector Phone",
            "type":"string",
            "description":"The inspector phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledEndDttm":{
            "title":"Schedule End Date",
            "type":"string",
            "description":"The scheduled business license inspection end date.",
            "format":"date-time",
            "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 business license inspection result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPersonName":{
            "title":"Applicant Name",
            "maxLength":450,
            "type":"string",
            "description":"The business license applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCounty":{
            "title":"Inspection County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HideFromUserFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the inspection will be displayed to a nonagency user prior to completion. The default value is false, which indicates the inspection is always displayed to nonagency users.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WfProcessId":{
            "title":"Workflow Process Definition",
            "maxLength":255,
            "type":"string",
            "description":"The workflow process ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionLocation":{
            "title":"Inspection Location",
            "maxLength":100,
            "type":"string",
            "description":"The location where the business license inspection will take place.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":255,
            "type":"string",
            "description":"The classification of the application record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"Communications URL Label",
            "type":"string",
            "description":"The label displayed for a business license inspection URL used within a communications template.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URLLabel":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SecondaryOwner":{
            "title":"Secondary Owner",
            "maxLength":150,
            "type":"string",
            "description":"The secondary owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkflowAssignedDate":{
            "title":"Workflow Assigned Date",
            "type":"string",
            "description":"The date when the workflow task was assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionState":{
            "title":"Inspection State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactTextMessage":{
            "title":"Location Contact Mobile Phone",
            "type":"string",
            "description":"The contact???s phone number for text messages.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplicantPhoneAreaCode":{
            "title":"Applicant Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"The area code for the business license applicant's phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FinalInspection":{
            "title":"Final Inspection",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this is the final business license inspection. The default is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkflowTaskName":{
            "title":"Workflow Task Name",
            "type":"string",
            "description":"The workflow task name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyUser":{
            "title":"Agency User",
            "type":"string",
            "description":"Indicates whether the business license inspection was last modified by an agency user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionResult":{
            "title":"Result",
            "maxLength":25,
            "type":"string",
            "description":"The results of the business license inspection. For example, Pass, Fail, Yes, or No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusBusinessLegalName":{
            "title":"Business Legal Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the applicant's business. For example, a contractor enters his or her contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkflowDueDate":{
            "type":"string",
            "description":"The workflow task due date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectorArrival":{
            "title":"Inspector Arrival",
            "maxLength":255,
            "type":"string",
            "description":"The time when the inspector is expected to arrive for an inspection. The value can be displayed as Date Only, Specific Time, or Time Range, as specified in the agency options.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantLoginId":{
            "type":"string",
            "description":"The business license applicant login ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a business license record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCompleteDttm":{
            "title":"Completion Date",
            "type":"string",
            "description":"The date and time when the business license inspection was completed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkflowTaskId":{
            "title":"Workflow Task ID",
            "type":"string",
            "description":"The workflow task ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectorId":{
            "title":"Inspector ID",
            "type":"integer",
            "description":"The inspector assigned to the business license inspection.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectorUserId":{
            "title":"Inspector User ID",
            "type":"string",
            "description":"The inspector user ID.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AssessFee":{
            "title":"Assess Fee",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether fees should be assessed for the business license inspection. The default is N for no.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionProvince":{
            "title":"Inspection Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseStatus":{
            "title":"License Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectorLoginId":{
            "type":"string",
            "description":"The inspector login ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the person applying for the business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectorEmail":{
            "title":"Inspector Email",
            "type":"string",
            "description":"The inspector email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Sender":"Y",
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The business license applicant phone number extension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStatus":{
            "title":"Activity Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the business license activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancellationReason":{
            "title":"Cancellation Reason",
            "maxLength":255,
            "type":"string",
            "description":"The reason for canceling the business license inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedTimeArrivalEnd":{
            "title":"Inspection ETA To",
            "type":"string",
            "description":"The inspector's latest estimated time of arrival at the business license inspection site.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Activity Description",
            "maxLength":255,
            "type":"string",
            "description":"The business license application description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantEmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":320,
            "type":"string",
            "description":"The business license 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 business license applicant's additional email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "InspectorName":{
            "title":"Inspector",
            "maxLength":360,
            "type":"string",
            "description":"The name of the inspector.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "title":"Inspection URL",
            "type":"string",
            "description":"The business license inspection URL used within a communications template.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "x-queryable":true
        },
        "ScheduledStartDttm":{
            "title":"Schedule Start Date",
            "type":"string",
            "description":"The scheduled business license inspection start date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerEmailId":{
            "title":"Owner Email",
            "maxLength":50,
            "type":"string",
            "description":"The parcel owner email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "InspectionStatus":{
            "title":"Inspection Status",
            "maxLength":100,
            "type":"string",
            "description":"The business license inspection status description.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"License Type",
            "maxLength":100,
            "type":"string",
            "description":"The user-friendly name for the business license application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record 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
        },
        "InspectionPostalCode":{
            "title":"Inspection Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"License ID",
            "maxLength":50,
            "type":"string",
            "description":"The business license record identifier. For example, a license ID with a value such as License ID RA-2017-00029.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "InspectionScore":{
            "title":"Score",
            "type":"integer",
            "description":"The calculated total score of the business license inspection.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone",
            "maxLength":40,
            "type":"string",
            "description":"The business license applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionId":{
            "title":"Inspection",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a business license inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "title":"Doing Business As",
            "maxLength":255,
            "type":"string",
            "description":"The field in the business information component of the form designer used to describe the business name, which is different than the legal business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneCountryCode":{
            "title":"Applicant Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the business license applicant's phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeBalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"Displays the fee balance due for the business license.",
            "nullable":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "EstimatedTimeArrival":{
            "title":"Inspection ETA From",
            "type":"string",
            "description":"The inspector's earliest estimated time of arrival at the business license inspection site.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionRating":{
            "title":"Rating",
            "maxLength":5,
            "type":"string",
            "description":"The overall rating of the business license inspection, which is calculated based on a defined rating method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionType":{
            "title":"Version Type",
            "maxLength":255,
            "type":"string",
            "description":"The version of the business license. Values are original, amendment, and renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberMajorViolations":{
            "title":"Major Violation Count",
            "type":"integer",
            "description":"The total number of major violations for the business license inspection.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ScheduledTimeRange":{
            "title":"Inspection Scheduled Time Range",
            "type":"string",
            "description":"Displays the business license Inspection's scheduled time range based on the defined setup of the application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionAddress2":{
            "title":"Inspection Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmail":{
            "title":"Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The email of the contact at the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "InspectionCity":{
            "title":"Inspection City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCountry":{
            "title":"Inspection Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionAddress1":{
            "title":"Inspection Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivitySystemStatus":{
            "title":"Activity System Status",
            "maxLength":255,
            "type":"string",
            "description":"The predefined system status to which the activity status maps.",
            "nullable":true,
            "readOnly":true,
            "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
        }
    }
}

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