Jump to

• Request
• Response

Get a business location

get

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessEntityListDetails/{BusinessEntityKey}/child/BusLocationListDetails/{BusinessLocationKey}

Request

Path Parameters

• BusinessEntityKey(required): integer(int64)
  System generated unique identifier for a business entity.
• BusinessLocationKey(required): integer(int64)
  System generated unique identifier for a business location.

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 : publicSectorBusinessEntityListDetails-BusLocationListDetails-item-response

Type: object

Show Source

• Address1: string
  Title: Address 1

  Read Only: true

  Maximum Length: 240

  First line of the physical address.
• Address2: string
  Title: Address 2

  Read Only: true

  Maximum Length: 240

  Second line of the physical address.
• Address3: string
  Title: Address 3

  Read Only: true

  Maximum Length: 240

  Third line of the physical address.
• Address4: string
  Title: Address 4

  Read Only: true

  Maximum Length: 240

  Fourth line of the physical address.
• AddressCode: string
  Read Only: true

  Maximum Length: 32

  Unique identifier for the parcel address.
• AddressId: integer (int64)
  Read Only: true

  The unique identifier for the parcel address.
• AddressLocId: integer (int64)
  Read Only: true

  Unique identifier of the physical address.
• AddressType: string
  Read Only: true

  Maximum Length: 20

  Attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others.
• AgencyId: integer (int32)
  Read Only: true

  Unique identifier of the agency.
• AltPhoneAreaCode: string
  Read Only: true

  Maximum Length: 20

  Alternate phone area code.
• AltPhoneContactPointId: integer (int64)
  Read Only: true

  Alternate phone contact point identifier.
• AltPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  Alternate phone country code.
• AltPhoneExtension: string
  Read Only: true

  Maximum Length: 20

  Alternate phone extension number of the location.
• AltPhoneNumber: string
  Title: Alternate Phone

  Read Only: true

  Maximum Length: 40

  Alternate phone number of the location.
• AltPhoneType: string
  Title: Alternate Phone Type

  Read Only: true

  Maximum Length: 30

  Alternate phone type of the location.
• AltRawPhoneNumber: string
  Read Only: true

  Maximum Length: 60

  Alternate raw phone number of the location.
• AreaSize: integer (int64)
  Read Only: true

  Size of the business location.
• AreaSizeUom: string
  Read Only: true

  Maximum Length: 10

  Unit of measure for the business location size.
• Building: string
  Read Only: true

  Maximum Length: 240

  Street number of the location.
• BuildingType: string
  Read Only: true

  Maximum Length: 20

  Building type used for parcel address searches.
• BusCategory: string
  Title: Category

  Read Only: true

  Maximum Length: 50

  Indicates the type of business.
• BusinessEntityId: string
  Title: Business

  Read Only: true

  Maximum Length: 50

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

  System generated unique identifier for a business entity.
• BusinessLocationId: string
  Title: Location ID

  Read Only: true

  Maximum Length: 255

  The unique identifier for a business location.
• BusinessLocationKey: integer (int64)
  Read Only: true

  System generated unique identifier for a business location.
• BusinessLocationPartyId: integer (int64)
  Read Only: true

  Business location party ID.
• BusStateTaxId: string
  Title: State Tax ID

  Read Only: true

  Maximum Length: 20

  State tax ID of the business location.
• BusSubCategory: string
  Title: Subcategory

  Read Only: true

  Maximum Length: 50

  Business subcategory.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  Physical address city.
• CityTaxId: string
  Title: City Tax ID

  Read Only: true

  Maximum Length: 20

  City tax ID of the business location.
• CoordinateX: integer (int64)
  Read Only: true

  Geographic X-coordinate of the parcel address location.
• CoordinateY: integer (int64)
  Read Only: true

  Geographic Y-coordinate of the parcel address location.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 2

  Physical address country.
• County: string
  Read Only: true

  Maximum Length: 60

  Physical address county.
• CrossroadOne: string
  Read Only: true

  Maximum Length: 240

  Cross road 1 that is part of parcel address.
• CrossroadTwo: string
  Read Only: true

  Maximum Length: 240

  Cross road 2 that is part of parcel address.
• CtyFoodSerLicExp: string (date)
  Read Only: true

  Expiration date of the county food service license associated with the business location.
• CtyFoodSerLicNum: string
  Read Only: true

  Maximum Length: 30

  County food service license number of the business location.
• Description: string
  Title: Business Description

  Read Only: true

  Maximum Length: 2000

  Description of the business location.
• EcontactAvailabilityOne: string
  Read Only: true

  Maximum Length: 1000

  Availability of the primary emergency contact.
• EcontactAvailabilityTwo: string
  Read Only: true

  Maximum Length: 1000

  Availability of the secondary emergency contact.
• EcontactEmailOne: string
  Read Only: true

  Maximum Length: 320

  Email address of the primary emergency contact.
• EcontactEmailTwo: string
  Read Only: true

  Maximum Length: 320

  Email address of the secondary emergency contact.
• EcontactFirstNameOne: string
  Title: Contact 1 First Name

  Read Only: true

  Maximum Length: 150

  First name of the primary emergency contact.
• EcontactFirstNameTwo: string
  Title: Contact 2 First Name

  Read Only: true

  Maximum Length: 150

  First name of the secondary emergency contact.
• EcontactLastNameOne: string
  Title: Contact 1 Last Name

  Read Only: true

  Maximum Length: 150

  Last name of the primary emergency contact.
• EcontactLastNameTwo: string
  Title: Contact 2 Last Name

  Read Only: true

  Maximum Length: 150

  Last name of the secondary emergency contact.
• EcontactPhoneAreaCodeOne: string
  Read Only: true

  Maximum Length: 20

  Primary emergency contact area code.
• EcontactPhoneAreaCodeTwo: string
  Read Only: true

  Maximum Length: 20

  Secondary emergency contact area code.
• EcontactPhoneCountryOne: string
  Read Only: true

  Maximum Length: 10

  Primary emergency contact country.
• EcontactPhoneCountryTwo: string
  Read Only: true

  Maximum Length: 10

  Secondary emergency contact country code.
• EcontactPhoneExtensionOne: string
  Read Only: true

  Maximum Length: 20

  Primary emergency contact phone extension number of the location.
• EcontactPhoneExtensionTwo: string
  Read Only: true

  Maximum Length: 20

  Secondary emergency contact phone extension number of the location.
• EcontactPhoneNumberOne: string
  Read Only: true

  Maximum Length: 40

  Primary emergency contact phone number of the location.
• EcontactPhoneNumberTwo: string
  Read Only: true

  Maximum Length: 40

  Secondary emergency contact phone number of the location.
• EcontactPhoneTypeOne: string
  Read Only: true

  Maximum Length: 30

  Phone type of the primary emergency contact for the location.
• EcontactPhoneTypeTwo: string
  Read Only: true

  Maximum Length: 30

  Secondary emergency contact phone type of the location.
• EcontactRawPhoneNumberOne: string
  Read Only: true

  Maximum Length: 60

  Primary emergency contact raw phone number of the location.
• EcontactRawPhoneNumberTwo: string
  Read Only: true

  Maximum Length: 60

  Secondary emergency contact raw phone number of the location.
• EffectiveEndDate: string (date)
  Read Only: true

  Effective end date of the location.
• EffectiveStartDate: string (date)
  Title: Proposed Start Date

  Read Only: true

  Effective start date of the location.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  Email address of the location.
• EmployeesTotal: number
  Read Only: true

  Total number of employees for the business location.
• EnabledFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the business location has been enabled.
• EndDate: string (date)
  Read Only: true

  The end date of the business location.
• EOnePhoneContactPointId: integer (int64)
  Read Only: true

  Unique identifier of the primary emergency phone contact.
• ETwoPhoneContactPointId: integer (int64)
  Read Only: true

  Unique identifier of the secondary emergency phone contact.
• FloorNumber: string
  Read Only: true

  Maximum Length: 40

  The floor number of the physical address.
• InactiveReason: string
  Read Only: true

  Maximum Length: 1000

  The reason that the business location was inactivated.
• JgzzFiscalCode: string
  Read Only: true

  Maximum Length: 20

  Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe.
• Landmark: string
  Read Only: true

  Maximum Length: 200

  Landmark for the parcel address.
• Latitude: number
  Read Only: true

  Latitude of the location.
• LineOfBusiness: string
  Read Only: true

  Maximum Length: 240

  Line of business.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationType: string
  Title: Location Type

  Read Only: true

  Maximum Length: 30

  The type of location.
• Longitude: number
  Read Only: true

  Longitude of the location.
• MailAddress1: string
  Read Only: true

  Maximum Length: 240

  First line of the location mailing address.
• MailAddress2: string
  Read Only: true

  Maximum Length: 240

  Second line of the location mailing address.
• MailAddress3: string
  Read Only: true

  Maximum Length: 240

  Third line of the location mailing address.
• MailAddress4: string
  Read Only: true

  Maximum Length: 240

  Fourth line of the location mailing address.
• MailAddrsLocId: integer (int64)
  Read Only: true

  Unique identifier of the mailing address for the business location.
• MailCity: string
  Read Only: true

  Maximum Length: 60

  Location mailing city.
• MailCountry: string
  Read Only: true

  Maximum Length: 2

  Location mailing country.
• MailCounty: string
  Read Only: true

  Maximum Length: 60

  Location mailing county.
• MailPostalCode: string
  Read Only: true

  Maximum Length: 60

  Location mailing postal code.
• MailPostalPlusCode: string
  Read Only: true

  Maximum Length: 20

  Location mailing postal plus 4 code.
• MailProvince: string
  Read Only: true

  Maximum Length: 60

  Location mailing province.
• MailState: string
  Read Only: true

  Maximum Length: 60

  Location mailing state.
• MobileBusinessFlag: string
  Title: Is this a mobile business?

  Read Only: true

  Maximum Length: 1

  Indicates whether the business is a mobile product or provides mobile service.
• MunicipalityId: string
  Read Only: true

  Maximum Length: 20

  Municipality in which the parcel address is located.
• OrganizationName: string
  Title: Doing Business As

  Read Only: true

  Maximum Length: 360

  Doing business as name.
• OrgProfilesStatus: string
  Read Only: true

  Maximum Length: 1

  Organization profile status.
• OtherTaxId: string
  Title: County Tax ID

  Read Only: true

  Maximum Length: 20

  County tax ID of the business location.
• ParcelId: integer (int64)
  Title: Parcel

  Read Only: true

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

  Maximum Length: 50

  The parcel number.
• Position: string
  Read Only: true

  Maximum Length: 50

  Street direction of the location.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  Physical address postal code.
• PostalPlus4Code: string
  Read Only: true

  Maximum Length: 20

  Physical address postal plus 4 code.
• PrimaryPhoneAreaCode: string
  Read Only: true

  Maximum Length: 20

  Primary phone area code.
• PrimaryPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  Primary phone country code.
• PrimaryPhoneExtension: string
  Read Only: true

  Maximum Length: 20

  Primary phone extension number of the location.
• PrimaryPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  Maximum Length: 40

  Primary phone number of the location.
• PrimaryPhoneType: string
  Title: Primary Phone Type

  Read Only: true

  Maximum Length: 30

  Primary phone type of the location.
• PrimaryRawPhoneNumber: string
  Read Only: true

  Maximum Length: 60

  Primary raw phone number of the location.
• PrimPhoneContactPointId: integer (int64)
  Read Only: true

  Primary phone contact point identifier.
• Province: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  Physical address province.
• RentalUnitNum: integer (int64)
  Read Only: true

  Number of rental units for the business location.
• SameMailAddressFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the mailing address is same as the location address.
• SellPerNum: string
  Title: Seller's Permit Number

  Read Only: true

  Maximum Length: 30

  Business sellers permit number of the location.
• SellPerNumExp: string (date)
  Title: Seller's Permit Expiration Date

  Read Only: true

  Expiration date of the business sellers permit number associated with the location.
• StartDate: string (date)
  Read Only: true

  The start date of the business location.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  Physical address state.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 20

  Current status of the location.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Current status meaning of the location.
• StQualPerNum: string
  Title: State Equalization Board Number

  Read Only: true

  Maximum Length: 30

  State equalization board number of the business location.
• StreetName: string
  Read Only: true

  Maximum Length: 240

  Street name used for parcel address searches.
• StreetSuffix: string
  Read Only: true

  Maximum Length: 20

  Street name that describes the street.
• StreetType: string
  Read Only: true

  Maximum Length: 20

  Street type used for parcel address searches.
• TaxClass: string
  Title: Tax Class Name

  Read Only: true

  Maximum Length: 30

  Municipal tax class of the business location.
• UnitNumber: string
  Read Only: true

  Maximum Length: 30

  Apartment unit number used for parcel address searches.
• Website: string
  Title: Website

  Read Only: true

  Maximum Length: 1000

  Website address of the location.
• WithinJurisdictionFlag: string
  Title: Is this business physically located within the agency's jurisdiction?

  Read Only: true

  Maximum Length: 1

  Indicates whether the business is located within agency jurisdiction.

{
    "type":"object",
    "properties":{
        "MailAddrsLocId":{
            "type":"integer",
            "description":"Unique identifier of the mailing address for the business location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryPhoneType":{
            "title":"Primary Phone Type",
            "maxLength":30,
            "type":"string",
            "description":"Primary phone type of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactEmailTwo":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the secondary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CtyFoodSerLicExp":{
            "type":"string",
            "description":"Expiration date of the county food service license associated with the business location.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SellPerNum":{
            "title":"Seller's Permit Number",
            "maxLength":30,
            "type":"string",
            "description":"Business sellers permit number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetSuffix":{
            "maxLength":20,
            "type":"string",
            "description":"Street name that describes the street.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"Building type used for parcel address searches.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"System generated unique identifier for a business entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":50,
            "type":"string",
            "description":"The parcel number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactFirstNameTwo":{
            "title":"Contact 2 First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the secondary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":20,
            "type":"string",
            "description":"Current status of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneAreaCode":{
            "maxLength":20,
            "type":"string",
            "description":"Primary phone area code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Position":{
            "maxLength":50,
            "type":"string",
            "description":"Street direction of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Landmark":{
            "maxLength":200,
            "type":"string",
            "description":"Landmark for the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailCounty":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing county.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessLocationPartyId":{
            "type":"integer",
            "description":"Business location party ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"Street type used for parcel address searches.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"Longitude of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"Email address of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactPhoneCountryOne":{
            "maxLength":10,
            "type":"string",
            "description":"Primary emergency contact country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactFirstNameOne":{
            "title":"Contact 1 First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the primary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailProvince":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing province.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailPostalPlusCode":{
            "maxLength":20,
            "type":"string",
            "description":"Location mailing postal plus 4 code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AreaSizeUom":{
            "maxLength":10,
            "type":"string",
            "description":"Unit of measure for the business location size.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Primary Phone",
            "maxLength":40,
            "type":"string",
            "description":"Primary phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ETwoPhoneContactPointId":{
            "type":"integer",
            "description":"Unique identifier of the secondary emergency phone contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"Physical address country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Apartment unit number used for parcel address searches.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "type":"integer",
            "description":"Geographic X-coordinate of the parcel address location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoordinateY":{
            "type":"integer",
            "description":"Geographic Y-coordinate of the parcel address location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EcontactPhoneTypeTwo":{
            "maxLength":30,
            "type":"string",
            "description":"Secondary emergency contact phone type of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactAvailabilityOne":{
            "maxLength":1000,
            "type":"string",
            "description":"Availability of the primary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InactiveReason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason that the business location was inactivated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "maxLength":240,
            "type":"string",
            "description":"Street number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailCountry":{
            "maxLength":2,
            "type":"string",
            "description":"Location mailing country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityId":{
            "title":"Business",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a business entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The floor number of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Business Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Unique identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "EcontactPhoneCountryTwo":{
            "maxLength":10,
            "type":"string",
            "description":"Secondary emergency contact country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OtherTaxId":{
            "title":"County Tax ID",
            "maxLength":20,
            "type":"string",
            "description":"County tax ID of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Website":{
            "title":"Website",
            "maxLength":1000,
            "type":"string",
            "description":"Website address of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Primary phone extension number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AltRawPhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Alternate raw phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactAvailabilityTwo":{
            "maxLength":1000,
            "type":"string",
            "description":"Availability of the secondary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactPhoneTypeOne":{
            "maxLength":30,
            "type":"string",
            "description":"Phone type of the primary emergency contact for the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business location has been enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCategory":{
            "title":"Category",
            "maxLength":50,
            "type":"string",
            "description":"Indicates the type of business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JgzzFiscalCode":{
            "maxLength":20,
            "type":"string",
            "description":"Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MobileBusinessFlag":{
            "title":"Is this a mobile business?",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is a mobile product or provides mobile service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CrossroadTwo":{
            "maxLength":240,
            "type":"string",
            "description":"Cross road 2 that is part of parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimPhoneContactPointId":{
            "type":"integer",
            "description":"Primary phone contact point identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SellPerNumExp":{
            "title":"Seller's Permit Expiration Date",
            "type":"string",
            "description":"Expiration date of the business sellers permit number associated with the location.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxClass":{
            "title":"Tax Class Name",
            "maxLength":30,
            "type":"string",
            "description":"Municipal tax class of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AltPhoneNumber":{
            "title":"Alternate Phone",
            "maxLength":40,
            "type":"string",
            "description":"Alternate phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the business location.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeesTotal":{
            "type":"number",
            "description":"Total number of employees for the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Primary phone country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithinJurisdictionFlag":{
            "title":"Is this business physically located within the agency's jurisdiction?",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is located within agency jurisdiction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineOfBusiness":{
            "maxLength":240,
            "type":"string",
            "description":"Line of business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLocId":{
            "type":"integer",
            "description":"Unique identifier of the physical address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressType":{
            "maxLength":20,
            "type":"string",
            "description":"Attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusSubCategory":{
            "title":"Subcategory",
            "maxLength":50,
            "type":"string",
            "description":"Business subcategory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetName":{
            "maxLength":240,
            "type":"string",
            "description":"Street name used for parcel address searches.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CityTaxId":{
            "title":"City Tax ID",
            "maxLength":20,
            "type":"string",
            "description":"City tax ID of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SameMailAddressFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the mailing address is same as the location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"Latitude of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgProfilesStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Organization profile status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CrossroadOne":{
            "maxLength":240,
            "type":"string",
            "description":"Cross road 1 that is part of parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactLastNameOne":{
            "title":"Contact 1 Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the primary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AltPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Alternate phone extension number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactPhoneExtensionOne":{
            "maxLength":20,
            "type":"string",
            "description":"Primary emergency contact phone extension number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the business location.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactPhoneAreaCodeTwo":{
            "maxLength":20,
            "type":"string",
            "description":"Secondary emergency contact area code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailState":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AltPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Alternate phone country code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactPhoneExtensionTwo":{
            "maxLength":20,
            "type":"string",
            "description":"Secondary emergency contact phone extension number of the location.",
            "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"
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier for the parcel address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the location.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactRawPhoneNumberOne":{
            "maxLength":60,
            "type":"string",
            "description":"Primary emergency contact raw phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressCode":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier for the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"Physical address city.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"Physical address province.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"Physical address postal plus 4 code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessLocationId":{
            "title":"Location ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for a business location.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactLastNameTwo":{
            "title":"Contact 2 Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the secondary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"Physical address state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactPhoneAreaCodeOne":{
            "maxLength":20,
            "type":"string",
            "description":"Primary emergency contact area code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactRawPhoneNumberTwo":{
            "maxLength":60,
            "type":"string",
            "description":"Secondary emergency contact raw phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Doing Business As",
            "maxLength":360,
            "type":"string",
            "description":"Doing business as name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StQualPerNum":{
            "title":"State Equalization Board Number",
            "maxLength":30,
            "type":"string",
            "description":"State equalization board number of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AreaSize":{
            "type":"integer",
            "description":"Size of the business location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":20
            },
            "x-queryable":true
        },
        "AltPhoneType":{
            "title":"Alternate Phone Type",
            "maxLength":30,
            "type":"string",
            "description":"Alternate phone type of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusStateTaxId":{
            "title":"State Tax ID",
            "maxLength":20,
            "type":"string",
            "description":"State tax ID of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"Physical address postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address county.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactPhoneNumberOne":{
            "maxLength":40,
            "type":"string",
            "description":"Primary emergency contact phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RentalUnitNum":{
            "type":"integer",
            "description":"Number of rental units for the business location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address 4",
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailCity":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing city.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "description":"The unique identifier for the parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EOnePhoneContactPointId":{
            "type":"integer",
            "description":"Unique identifier of the primary emergency phone contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AltPhoneContactPointId":{
            "type":"integer",
            "description":"Alternate phone contact point identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryRawPhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Primary raw phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessLocationKey":{
            "type":"integer",
            "description":"System generated unique identifier for a business location.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address 2",
            "maxLength":240,
            "type":"string",
            "description":"Second line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address 3",
            "maxLength":240,
            "type":"string",
            "description":"Third line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactPhoneNumberTwo":{
            "maxLength":40,
            "type":"string",
            "description":"Secondary emergency contact phone number of the location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address 1",
            "maxLength":240,
            "type":"string",
            "description":"First line of the physical address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MunicipalityId":{
            "maxLength":20,
            "type":"string",
            "description":"Municipality in which the parcel address is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CtyFoodSerLicNum":{
            "maxLength":30,
            "type":"string",
            "description":"County food service license number of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AltPhoneAreaCode":{
            "maxLength":20,
            "type":"string",
            "description":"Alternate phone area code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EcontactEmailOne":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the primary emergency contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Current status meaning of the location.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MailAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Proposed Start Date",
            "type":"string",
            "description":"Effective start date of the location.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationType":{
            "title":"Location Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the location mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the location mailing address.",
            "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