Jump to

• Request
• Response

Get a permit expiry communication item

get

/fscmRestApi/resources/11.13.18.05/publicSectorPermitExpiryCommunications/{LnpRecordKey}

Request

Path Parameters

• LnpRecordKey(required): integer
  The unique identifier for the record.

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

Type: object

Show Source

• AboutToExpireDate: string (date-time)
  Title: About to Expire Date

  Read Only: true

  The date when the notification about an expiring license or permit is sent.
• AddressKey: integer (int64)
  Read Only: true

  The parcel address key.
• AgencyId: integer (int32)
  Read Only: true

  The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• ApplAteDate: string (date-time)
  Read Only: true

  The date to indicate when the application is about to expire.
• ApplExpirationDate: string (date-time)
  Title: Application Expiration Date

  Read Only: true

  The date when the application expires.
• Applicant: integer (int64)
  Title: Applicant

  Read Only: true

  The party identifier of the permit applicant.
• ApplicantAddress1: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the permit applicant address.
• ApplicantAddress2: string
  Title: Applicant Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the permit applicant address.
• ApplicantBizProfileId: integer (int64)
  Title: Business Profile

  Read Only: true

  The business profile used by the applicant.
• ApplicantCity: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

  The city in the permit applicant address.
• ApplicantCountry: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

  The country in the permit applicant address.
• ApplicantCounty: string
  Title: Applicant County

  Read Only: true

  Maximum Length: 60

  The county in the permit applicant address.
• ApplicantEmailAddress1: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The first email address of the permit applicant.
• ApplicantEmailAddress2: string
  Title: Applicant Email 2

  Read Only: true

  Maximum Length: 320

  The second email address of the permit applicant.
• ApplicantPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The area code in the phone number of the permit applicant.
• ApplicantPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The country code in the phone number of the permit applicant.
• ApplicantPhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The phone number extension of the permit applicant.
• ApplicantPhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 40

  The permit applicant phone number.
• ApplicantPostalCode: string
  Title: Applicant Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the permit applicant address.
• ApplicantProfileId: integer (int64)
  Title: Applicant Profile

  Read Only: true

  The user profile of the applicant.
• ApplicantProvince: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the permit applicant address.
• ApplicantState: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The state in the permit applicant address.
• BalanceDue: number
  Title: Fees Balance Due

  Read Only: true

  The application balance due amount.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The user who last updated the record.
• DelinquentDate: string (date-time)
  Title: Delinquent Date

  Read Only: true

  The date the license becomes delinquent.
• DistrictName: string
  Title: District

  Read Only: true

  Maximum Length: 50

  The type of the current parcel.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Read Only: true

  The date the license or permit is no longer valid.
• ExpirationGraceDate: string (date-time)
  Title: Grace Period Date

  Read Only: true

  The application expiry grace date.
• ExtensionsCount: integer (int32)
  Title: Number of Extensions

  Read Only: true

  The application expiry extension count.
• GracePeriod: integer (int64)
  Title: Grace Period

  Read Only: true

  The grace period for the application expiry.
• GracePeriodUom: string
  Title: Grace Period UOM

  Read Only: true

  Maximum Length: 5

  The grace period unit for the application expiry.
• InsCommenceAteDate: string (date-time)
  Title: Inspection Commencement About to Expire Date

  Read Only: true

  The date when the notification about an expiring license or permit is sent.
• InsCommenceExpDate: string (date-time)
  Title: Inspection Commencement Expiration Date

  Read Only: true

  The date the license or permit is no longer valid.
• InsCommenceGraceDate: string (date-time)
  Title: Inspection Commencement Expiration Grace Date

  Read Only: true

  The application expiry grace date.
• InsCommencementDateOption: string
  Title: Date Option

  Read Only: true

  Maximum Length: 30

  The inspection commencement date option.
• InsCommencementDuration: integer (int64)
  Title: Duration

  Read Only: true

  The inspection commencement duration.
• InsCommencementDurationUom: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 5

  The inspection commencement unit for duration.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date the license or permit was issued. Used in the application information component of the Permit Designer.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date when the record was created.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 50

  The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for the record.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  Maximum Length: 360

  The business name of the applicant. For example, a contractor enters his or her contracting business name.
• 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.
• ParcelAddress1: string
  Title: Property Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the parcel or property address.
• ParcelAddress2: string
  Title: Property Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the parcel or property address.
• ParcelCity: string
  Title: Property City

  Read Only: true

  Maximum Length: 60

  The city in the parcel or property address.
• ParcelCountry: string
  Title: Property Country

  Read Only: true

  Maximum Length: 60

  The country in the parcel or property address.
• ParcelCounty: string
  Title: Property County

  Read Only: true

  Maximum Length: 60

  The county in the parcel or property address.
• ParcelId: integer (int64)
  Title: Parcel

  Read Only: true

  The identifier of the record parcel.
• ParcelPostalCode: string
  Title: Property Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the parcel or property address.
• ParcelProvince: string
  Title: Property Province

  Read Only: true

  Maximum Length: 60

  The province in the parcel or property address.
• ParcelState: string
  Title: Property State

  Read Only: true

  Maximum Length: 60

  The state in the parcel or property address.
• ParcelType: string
  Title: Parcel Type

  Read Only: true

  Maximum Length: 30

  The key of the record parcel.
• PermitDescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 1000

  The description of the permit type.
• PermitStatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 100

  The status of the permit record.
• PersonName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The permit applicant name.
• PrimaryContactEmail: string
  Title: Contact Email

  Read Only: true

  Maximum Length: 320

  The application primary contact email.
• PrimaryContactName: string
  Title: Location Contact

  Read Only: true

  Maximum Length: 450

  The application primary contact name.
• PrimaryContactPhone: string
  Title: Contact Phone Number

  Read Only: true

  Maximum Length: 60

  The application primary contact phone.
• ProjectKey: integer (int64)
  Title: Project

  Read Only: true

  The project name information for a permit.
• PropertyDescription: string
  Title: Property Description

  Read Only: true

  Maximum Length: 240

  The property description.
• RecordStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the record.
• RecordType: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.
• ReissueDate: string (date-time)
  Title: Reissue Date

  Read Only: true

  The date the license or permit was reissued. Used in the application information component of the Permit Designer.
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

  The renewal date for the license or permit.
• 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: 80

  The record subclassification.
• SubmitDate: string (date-time)
  Title: Submission Date

  Read Only: true

  The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer.
• SubmittedBy: string
  Title: Submitted By

  Read Only: true

  Maximum Length: 64

  The user who submitted the application.
• Url: string
  Title: URL

  Read Only: true

  Maximum Length: 255

  The browser link for the business license application.
• UrlLabel: string
  Title: Link to Permit Application

  Read Only: true

  Maximum Length: 255

  The label for the URL.
• Username: string
  Title: Applicant User ID

  Read Only: true

  Maximum Length: 100

  The user ID of the permit applicant.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"80",
            "type":"string",
            "description":"The record subclassification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"The date when the notification about an expiring license or permit is sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "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
        },
        "InsCommencementDuration":{
            "title":"Duration",
            "type":"integer",
            "description":"The inspection commencement duration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "ReissueDate":{
            "title":"Reissue Date",
            "type":"string",
            "description":"The date the license or permit was reissued. Used in the application information component of the Permit Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddress2":{
            "title":"Property Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddress1":{
            "title":"Property Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsCommencementDurationUom":{
            "title":"Unit of Measure",
            "maxLength":"5",
            "type":"string",
            "description":"The inspection commencement unit for duration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactEmail":{
            "title":"Contact Email",
            "maxLength":"320",
            "type":"string",
            "description":"The application primary contact email.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ParcelPostalCode":{
            "title":"Property Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "InsCommenceAteDate":{
            "title":"Inspection Commencement About to Expire Date",
            "type":"string",
            "description":"The date when the notification about an expiring license or permit is sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The record classification. The classifications can be permit, business license, professional license, or planning and zoning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":"5",
            "type":"string",
            "description":"The grace period unit for the application expiry.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"Link to Permit Application",
            "maxLength":"255",
            "type":"string",
            "description":"The label for the URL.",
            "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"
            }
        },
        "ApplicantProvince":{
            "title":"Applicant Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"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
        },
        "ApplicantPhoneAreaCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The area code in the phone number of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelType":{
            "title":"Parcel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The key of the record parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantAddress2":{
            "title":"Applicant Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelProvince":{
            "title":"Property Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactName":{
            "title":"Location Contact",
            "maxLength":"450",
            "type":"string",
            "description":"The application primary contact name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "title":"Applicant Profile",
            "type":"integer",
            "description":"The user profile of the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelCounty":{
            "title":"Property County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantState":{
            "title":"Applicant State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who submitted the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelState":{
            "title":"Property State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressKey":{
            "type":"integer",
            "description":"The parcel address key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicantCounty":{
            "title":"Applicant County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ExtensionsCount":{
            "title":"Number of Extensions",
            "type":"integer",
            "description":"The application expiry extension count.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ParcelCity":{
            "title":"Property City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":"240",
            "type":"string",
            "description":"The property description.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "InsCommenceExpDate":{
            "title":"Inspection Commencement Expiration Date",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"The renewal date for the license or permit.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Grace Period Date",
            "type":"string",
            "description":"The application expiry grace date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The grace period for the application expiry.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "Applicant":{
            "title":"Applicant",
            "type":"integer",
            "description":"The party identifier of the permit applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":"20",
            "type":"string",
            "description":"The phone number extension of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"The business name of the applicant. For example, a contractor enters his or her contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectKey":{
            "title":"Project",
            "type":"integer",
            "description":"The project name information for a permit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "InsCommenceGraceDate":{
            "title":"Inspection Commencement Expiration Grace Date",
            "type":"string",
            "description":"The application expiry grace date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":"320",
            "type":"string",
            "description":"The first email address of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress2":{
            "title":"Applicant Email 2",
            "maxLength":"320",
            "type":"string",
            "description":"The second email address of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantCity":{
            "title":"Applicant City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplExpirationDate":{
            "title":"Application Expiration Date",
            "type":"string",
            "description":"The date when the application expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":"255",
            "type":"string",
            "description":"The browser link for the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "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",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "DelinquentDate":{
            "title":"Delinquent Date",
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":"100",
            "type":"string",
            "description":"The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantAddress1":{
            "title":"Applicant Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "InsCommencementDateOption":{
            "title":"Date Option",
            "maxLength":"30",
            "type":"string",
            "description":"The inspection commencement date option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPhone":{
            "title":"Contact Phone Number",
            "maxLength":"60",
            "type":"string",
            "description":"The application primary contact phone.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PermitDescription":{
            "title":"Application Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the permit type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Permit ID",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier for the building permit record. For example, a permit number with a value such as Building Permit 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
        },
        "PersonName":{
            "title":"Applicant Name",
            "maxLength":"450",
            "type":"string",
            "description":"The permit applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelCountry":{
            "title":"Property Country",
            "maxLength":"60",
            "type":"string",
            "description":"The country in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":"40",
            "type":"string",
            "description":"The permit applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            }
        },
        "ApplicantPhoneCountryCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The country code in the phone number of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date the license or permit was issued. Used in the application information component of the Permit Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantCountry":{
            "title":"Applicant Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplAteDate":{
            "type":"string",
            "description":"The date to indicate when the application is about to expire.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "title":"Business Profile",
            "type":"integer",
            "description":"The business profile used by the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistrictName":{
            "title":"District",
            "maxLength":"50",
            "type":"string",
            "description":"The type of the current parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Username":{
            "title":"Applicant User ID",
            "maxLength":"100",
            "type":"string",
            "description":"The user ID of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The application balance due amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "PermitStatus":{
            "title":"Application Status",
            "maxLength":"100",
            "type":"string",
            "description":"The status of the permit record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top