Jump to

• Request
• Response

Get all permits, planning applications, and business license parcel addresses

get

/fscmRestApi/resources/11.13.18.05/publicSectorExploreCityPermits

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:
  
  

  • AgencyActiveLICsearchfinder: Finds a business license record associated with a specified parcel address.
    Finder Variables:
    • myapplication; string; Finds all business licence records where user is either a primary person or a contact.
    • value; string; The parcel address used to find a business license record.
  • AgencyActivePMTsearchfinder: Finds a permit record associated with a specified parcel address.
    Finder Variables:
    • myapplication; string; Finds all permit records where user is either a primary person or a contact.
    • value; string; The parcel address used to find a permit record.
  • AgencyActivePZsearchfinder: Finds a planning application record associated with a specified parcel address.
    Finder Variables:
    • myapplication; string; Finds all business licence records where user is either a primary person or a contact.
    • value; string; The parcel address used to find a planning application record.
  • PrimaryKey: Finds a permit, planning application, or business license record associated with the parcel address by primary key.
    Finder Variables:
    • LnpRecordKey; integer; The primary key that is used to find a permit, planning application, or business license associated with the parcel address.
• 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:
  

  • Address1; string; The first line of the parcel address.
  • Address2; string; The second line of the parcel address.
  • Address3; string; The third line of the parcel address.
  • Address4; string; The fourth line of the parcel address.
  • AddressId; integer; The identifier for the address.
  • AddressKey; integer; The unique identifier for parcel address information.
  • AgencyId; integer; The identifier for the public sector agency.
  • Applicant; integer; The applicant ID for the permit, planning application, or business license.
  • ApplicantBizProfileId; integer; The identifier for the business profile that is associated with the permit, planning application or business license.
  • ApplicantProfileId; integer; The identifier for the personal profile that is associated with the permit, planning application, or business license.
  • BuildingType; string; The building type of the parcel.
  • BusAddress1; string; The first line of the business address for a business license.
  • BusAddress2; string; The second line of the business address for a business license.
  • BusAddress3; string; The third line of the business address for a business license.
  • BusAddress4; string; The fourth line of the business address for a business license.
  • BusAddressId; integer; The address ID for the business license.
  • BusBusinessLegalName; string; The business legal name for a business license.
  • BusBusinessName; string; The business name for a business license.
  • BusCity; string; The city of the business address for a business license.
  • BusCountry; string; The country of the business address for a business license.
  • BusCounty; string; The country of the business address for a business license.
  • BusDbaBusinessName; string; The business DBA name for a business license.
  • BusDescription; string; The business description for a business license.
  • BusEnabledFlag; string; Indicates whether the business entity for a business license is enabled.
  • BusEntAddressId; integer; The address ID for a business entity address in a business license.
  • BusEntEnabledFlag; string; Indicates whether a business entity license record is active.
  • BusEntStatus; string; The business entity status in a business license transaction record.
  • BusExemptFlag; string; Indicates whether the business entity for a business license is a tax-exempt organization.
  • BusFulladdress; string; The full parcel address for a business license. The full address consists of the values from the Address 1, Address 2, Address 3, and Address 4 fields for the parcel address, but not the values from other address fields such as city, state, and postal code.
  • BusLatitude; number; The latitude of the business license parcel address.
  • BusLocAddress1; string; The first line of the parcel address for a business license.
  • BusLocAddress2; string; The second line of the parcel address for a business license.
  • BusLocCity; string; The city of the parcel address for a business license.
  • BusLocDescription; string; The description for a business license.
  • BusLongitude; number; The longitude of the business license parcel address.
  • BusOwnershipType; string; The business ownership type of the business license.
  • BusParcelId; integer; The parcel ID for the business license.
  • BusParcelIdEntered; string; The user-specified identifier for the parcel for a business license.
  • BusPostalCode; string; The postal code of the business address for a business license.
  • BusPostalPlusCode; string; The postal plus code of the business address for a business license.
  • BusProvince; string; The province of the business address for a business license.
  • BusStartDate; string; The start date for a business license.
  • BusState; string; The state of the business address for a business license.
  • BusStatus; string; The business entity status from the business entity record.
  • BusinessEntityId; string; The business entity ID for a business license.
  • BusinessEntityKey; integer; The business entity key for a business license.
  • City; string; The city of the parcel address.
  • Classification; string; The classification of the record type.
  • Country; string; The country of the parcel address.
  • County; string; The county of the parcel address.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date and time when the record was created.
  • CurrentTransFlag; string; The current transaction flag for a business license.
  • Description; string; The description of the permit, planning application, or business license.
  • Floor; string; The floor of the parcel address.
  • FullAddress; string; The full address including all lines of the parcel address. There are four possible lines: Address1, Address2, Address3, and Address4.
  • IssueDate; string; The date and time when the permit, planning application, or business license was created.
  • IssueDt; string; The date and time when the permit, planning application, or business license was created.
  • Latitude; number; The latitude of the parcel address.
  • LicenseStatus; string; The business entity license status for a business license.
  • LnpBusinessOwnersKey; integer; The business owner key for a business license record.
  • LnpRecordId; string; The user entered permit, planning application, or business license number.
  • LnpRecordKey; integer; The unique permit, planning application, or business license identifier.
  • Longitude; number; The longitude of the parcel address.
  • MailingAddress1; string; The first line of the mailing address for a business license.
  • MailingAddress2; string; The second line of the mailing address for a business license.
  • MailingCity; string; The city of the mailing address for a business license.
  • OwnerName; string; The owner name for a business license.
  • ParcelId; integer; The identifier for the parcel or parcel number.
  • ParcelIdEntered; string; The user-entered parcel name in the parcel record.
  • ParcelKey; integer; The unique identifier for parcel record information.
  • PermitIssueDate; string; The date and time when the permit was issued or reissued.
  • PersonName; string; The name of the applicant for a permit, planning application, or business license.
  • PostalCode; string; The postal code of the parcel address.
  • PostalPlus4Code; string; The Postal Plus 4 Code of the parcel address. This code is also known as a ZIP+4 Code and contains 9 digits.
  • Province; string; The province of the parcel address.
  • RecordType; string; The record type information.
  • RecordTypeId; string; The unique identifier for the record type key.
  • Srid; integer; The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. This is used in all GIS systems.
  • State; string; The state of the parcel address.
  • Status; string; The status of the permit, planning application, or business license.
  • StreetDirection; string; The street direction of the parcel address.
  • StreetName; string; The street name of the parcel address.
  • StreetNumber; string; The street number of the parcel address.
  • StreetType; string; The street type of the parcel address.
  • Subclassification; string; The subclassification of the record type.
  • SystemStatus; string; The system status of the transaction.
  • UnitNumber; string; The unit number of the parcel address.
  • VersionType; string; The version of the permit, planning application, or business license.
• 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:
  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 : publicSectorExploreCityPermits

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/publicSectorExploreCityPermits-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorExploreCityPermits-item-response

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

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  The identifier for the address.
• AddressKey: integer (int64)
  Read Only: true

  The unique identifier for parcel address information.
• AgencyId: integer (int32)
  Read Only: true

  The identifier for the public sector agency.
• Applicant: integer (int64)
  Read Only: true

  The applicant ID for the permit, planning application, or business license.
• ApplicantBizProfileId: integer (int64)
  Read Only: true

  The identifier for the business profile that is associated with the permit, planning application or business license.
• ApplicantProfileId: integer (int64)
  Read Only: true

  The identifier for the personal profile that is associated with the permit, planning application, or business license.
• BuildingType: string
  Read Only: true

  Maximum Length: 20

  The building type of the parcel.
• BusAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line of the business address for a business license.
• BusAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line of the business address for a business license.
• BusAddress3: string
  Read Only: true

  Maximum Length: 240

  The third line of the business address for a business license.
• BusAddress4: string
  Read Only: true

  Maximum Length: 240

  The fourth line of the business address for a business license.
• BusAddressId: integer (int64)
  Read Only: true

  The address ID for the business license.
• BusBusinessLegalName: string
  Read Only: true

  Maximum Length: 240

  The business legal name for a business license.
• BusBusinessName: string
  Read Only: true

  Maximum Length: 100

  The business name for a business license.
• BusCity: string
  Read Only: true

  Maximum Length: 60

  The city of the business address for a business license.
• BusCountry: string
  Read Only: true

  Maximum Length: 3

  The country of the business address for a business license.
• BusCounty: string
  Read Only: true

  Maximum Length: 60

  The country of the business address for a business license.
• BusDbaBusinessName: string
  Read Only: true

  Maximum Length: 100

  The business DBA name for a business license.
• BusDescription: string
  Read Only: true

  Maximum Length: 200

  The business description for a business license.
• BusEnabledFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the business entity for a business license is enabled.
• BusEntAddressId: integer (int64)
  Read Only: true

  The address ID for a business entity address in a business license.
• BusEntEnabledFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether a business entity license record is active.
• BusEntStatus: string
  Read Only: true

  Maximum Length: 10

  The business entity status in a business license transaction record.
• BusExemptFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the business entity for a business license is a tax-exempt organization.
• BusFulladdress: string
  Read Only: true

  Maximum Length: 960

  The full parcel address for a business license. The full address consists of the values from the Address 1, Address 2, Address 3, and Address 4 fields for the parcel address, but not the values from other address fields such as city, state, and postal code.
• BusinessEntityId: string
  Read Only: true

  Maximum Length: 50

  The business entity ID for a business license.
• BusinessEntityKey: integer (int64)
  Read Only: true

  The business entity key for a business license.
• BusLatitude: number
  Read Only: true

  The latitude of the business license parcel address.
• BusLocAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line of the parcel address for a business license.
• BusLocAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line of the parcel address for a business license.
• BusLocCity: string
  Read Only: true

  Maximum Length: 60

  The city of the parcel address for a business license.
• BusLocDescription: string
  Read Only: true

  Maximum Length: 200

  The description for a business license.
• BusLongitude: number
  Read Only: true

  The longitude of the business license parcel address.
• BusOwnershipType: string
  Read Only: true

  Maximum Length: 15

  The business ownership type of the business license.
• BusParcelId: integer (int64)
  Read Only: true

  The parcel ID for the business license.
• BusParcelIdEntered: string
  Read Only: true

  Maximum Length: 30

  The user-specified identifier for the parcel for a business license.
• BusPostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code of the business address for a business license.
• BusPostalPlusCode: string
  Read Only: true

  Maximum Length: 10

  The postal plus code of the business address for a business license.
• BusProvince: string
  Read Only: true

  Maximum Length: 60

  The province of the business address for a business license.
• BusStartDate: string (date)
  Read Only: true

  The start date for a business license.
• BusState: string
  Read Only: true

  Maximum Length: 60

  The state of the business address for a business license.
• BusStatus: string
  Read Only: true

  Maximum Length: 10

  The business entity status from the business entity record.
• City: string
  Read Only: true

  Maximum Length: 60

  The city of the parcel address.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the record type.
• Country: string
  Read Only: true

  Maximum Length: 3

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

  Maximum Length: 5

  The county of the parcel address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date)
  Read Only: true

  The date and time when the record was created.
• CurrentTransFlag: string
  Read Only: true

  Maximum Length: 1

  The current transaction flag for a business license.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The description of the permit, planning application, or business license.
• Floor: string
  Read Only: true

  Maximum Length: 20

  The floor of the parcel address.
• FullAddress: string
  Title: Address

  Read Only: true

  Maximum Length: 960

  The full address including all lines of the parcel address. There are four possible lines: Address1, Address2, Address3, and Address4.
• IssueDate: string (date)
  Read Only: true

  The date and time when the permit, planning application, or business license was created.
• IssueDt: string (date-time)
  Read Only: true

  The date and time when the permit, planning application, or business license was created.
• Latitude: number
  Read Only: true

  The latitude of the parcel address.
• LicenseStatus: string
  Read Only: true

  Maximum Length: 30

  The business entity license status for a business license.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpBusinessOwnersKey: integer (int64)
  Read Only: true

  The business owner key for a business license record.
• LnpRecordId: string
  Title: Permit Number

  Read Only: true

  Maximum Length: 50

  The user entered permit, planning application, or business license number.
• LnpRecordKey: integer
  Read Only: true

  The unique permit, planning application, or business license identifier.
• Longitude: number
  Read Only: true

  The longitude of the parcel address.
• MailingAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line of the mailing address for a business license.
• MailingAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line of the mailing address for a business license.
• MailingCity: string
  Read Only: true

  Maximum Length: 60

  The city of the mailing address for a business license.
• OwnerName: string
  Read Only: true

  Maximum Length: 450

  The owner name for a business license.
• ParcelId: integer (int64)
  Title: Parcel Number

  Read Only: true

  The identifier for the parcel or parcel number.
• ParcelIdEntered: string
  Read Only: true

  Maximum Length: 30

  The user-entered parcel name in the parcel record.
• ParcelKey: integer (int64)
  Read Only: true

  The unique identifier for parcel record information.
• PermitIssueDate: string (date-time)
  Read Only: true

  The date and time when the permit was issued or reissued.
• PersonName: string
  Read Only: true

  Maximum Length: 450

  The name of the applicant for a permit, planning application, or business license.
• PostalCode: string
  Read Only: true

  Maximum Length: 20

  The postal code of the parcel address.
• PostalPlus4Code: string
  Read Only: true

  Maximum Length: 20

  The Postal Plus 4 Code of the parcel address. This code is also known as a ZIP+4 Code and contains 9 digits.
• Province: string
  Read Only: true

  Maximum Length: 20

  The province of the parcel address.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The record type information.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the record type key.
• Srid: integer (int64)
  Read Only: true

  The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. This is used in all GIS systems.
• State: string
  Read Only: true

  Maximum Length: 6

  The state of the parcel address.
• Status: string
  Read Only: true

  Maximum Length: 15

  The status of the permit, planning application, or business license.
• StreetDirection: string
  Read Only: true

  Maximum Length: 10

  The street direction of the parcel address.
• StreetName: string
  Title: Street Name

  Read Only: true

  Maximum Length: 240

  The street name of the parcel address.
• StreetNumber: string
  Read Only: true

  Maximum Length: 20

  The street number of the parcel address.
• StreetType: string
  Read Only: true

  Maximum Length: 20

  The street type of the parcel address.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The subclassification of the record type.
• SystemStatus: string
  Read Only: true

  Maximum Length: 15

  The system status of the transaction.
• UnitNumber: string
  Read Only: true

  Maximum Length: 30

  The unit number of the parcel address.
• VersionType: string
  Read Only: true

  Maximum Length: 1

  The version of the permit, planning application, or business license.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification of the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetName":{
            "title":"Street Name",
            "maxLength":"240",
            "type":"string",
            "description":"The street name of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusDescription":{
            "maxLength":"200",
            "type":"string",
            "description":"The business description for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullAddress":{
            "title":"Address",
            "maxLength":"960",
            "type":"string",
            "description":"The full address including all lines of the parcel address. There are four possible lines: Address1, Address2, Address3, and Address4.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusEnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the business entity for a business license is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentTransFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The current transaction flag for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusParcelId":{
            "type":"integer",
            "description":"The parcel ID for the business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BuildingType":{
            "maxLength":"20",
            "type":"string",
            "description":"The building type of the parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusBusinessName":{
            "maxLength":"100",
            "type":"string",
            "description":"The business name for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"The business entity key for a business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "description":"The user-entered parcel name in the parcel record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "maxLength":"20",
            "type":"string",
            "description":"The street number of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "type":"integer",
            "description":"The unique identifier for parcel record information.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusLocDescription":{
            "maxLength":"200",
            "type":"string",
            "description":"The description for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The identifier for the address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusCity":{
            "maxLength":"60",
            "type":"string",
            "description":"The city of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the permit, planning application, or business license.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The identifier for the personal profile that is associated with the permit, planning application, or business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "description":"The user-specified identifier for the parcel for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusOwnershipType":{
            "maxLength":"15",
            "type":"string",
            "description":"The business ownership type of the business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusBusinessLegalName":{
            "maxLength":"240",
            "type":"string",
            "description":"The business legal name for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusLatitude":{
            "type":"number",
            "description":"The latitude of the business license parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCity":{
            "maxLength":"60",
            "type":"string",
            "description":"The city of the mailing address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressKey":{
            "type":"integer",
            "description":"The unique identifier for parcel address information.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The city of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetType":{
            "maxLength":"20",
            "type":"string",
            "description":"The street type of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique permit, planning application, or business license identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"20",
            "type":"string",
            "description":"The province of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":"20",
            "type":"string",
            "description":"The Postal Plus 4 Code of the parcel address. This code is also known as a ZIP+4 Code and contains 9 digits.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusEntStatus":{
            "maxLength":"10",
            "type":"string",
            "description":"The business entity status in a business license transaction record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"6",
            "type":"string",
            "description":"The state of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The business entity license status for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "maxLength":"10",
            "type":"string",
            "description":"The street direction of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"3",
            "type":"string",
            "description":"The country of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"The country of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusAddress4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unit number of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitIssueDate":{
            "type":"string",
            "description":"The date and time when the permit was issued or reissued.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The applicant ID for the permit, planning application, or business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"The business entity ID for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerName":{
            "maxLength":"450",
            "type":"string",
            "description":"The owner name for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the permit, planning application, or business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "BusAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusAddress3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDt":{
            "type":"string",
            "description":"The date and time when the permit, planning application, or business license was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The postal code of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":"5",
            "type":"string",
            "description":"The county of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusAddressId":{
            "type":"integer",
            "description":"The address ID for the business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusEntAddressId":{
            "type":"integer",
            "description":"The address ID for a business entity address in a business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The record type information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the record type key.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusLocAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the parcel address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusState":{
            "maxLength":"60",
            "type":"string",
            "description":"The state of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the mailing address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusLocAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the parcel address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the mailing address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusLongitude":{
            "type":"number",
            "description":"The longitude of the business license parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusStatus":{
            "maxLength":"10",
            "type":"string",
            "description":"The business entity status from the business entity record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The system status of the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusStartDate":{
            "type":"string",
            "description":"The start date for a business license.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Permit Number",
            "maxLength":"50",
            "type":"string",
            "description":"The user entered permit, planning application, or business license number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel Number",
            "type":"integer",
            "description":"The identifier for the parcel or parcel number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Floor":{
            "maxLength":"20",
            "type":"string",
            "description":"The floor of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "maxLength":"450",
            "type":"string",
            "description":"The name of the applicant for a permit, planning application, or business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "maxLength":"100",
            "type":"string",
            "description":"The business DBA name for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusEntEnabledFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a business entity license record is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"The country of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"The date and time when the permit, planning application, or business license was created.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusFulladdress":{
            "maxLength":"960",
            "type":"string",
            "description":"The full parcel address for a business license. The full address consists of the values from the Address 1, Address 2, Address 3, and Address 4 fields for the parcel address, but not the values from other address fields such as city, state, and postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpBusinessOwnersKey":{
            "type":"integer",
            "description":"The business owner key for a business license record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VersionType":{
            "maxLength":"1",
            "type":"string",
            "description":"The version of the permit, planning application, or business license.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "type":"integer",
            "description":"The identifier for the business profile that is associated with the permit, planning application or business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusPostalPlusCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The postal plus code of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"The province of the business address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusLocCity":{
            "maxLength":"60",
            "type":"string",
            "description":"The city of the parcel address for a business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Srid":{
            "type":"integer",
            "description":"The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. This is used in all GIS systems.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "BusExemptFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the business entity for a business license is a tax-exempt organization.",
            "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