Jump to

• Request
• Response

Update a business location

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation/{BusinessLocationKey}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• BusinessEntityKey: integer
  System-generated identifier for a business entity.
• BusinessLocationKey: integer
  System-generated unique identifier for a business location.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorBusinessRegistrations-BusinessLocation-item

Type: object

Show Source

• Address1(optional): string
  First line of the physical address.
• Address2(optional): string
  Second line of the physical address.
• Address3(optional): string
  Third line of the physical address.
• Address4(optional): string
  Fourth line of the physical address.
• AddressCode(optional): string
  Maximum Length: 32

  Unique identifier for the parcel address.
• AddressId(optional): integer(int64)
  The unique identifier for the address.
• AddressType(optional): string
  Maximum Length: 20

  Attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others.
• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the business location.
• AltPhoneAreaCode(optional): string
  Alternate phone area code.
• AltPhoneContactPointId(optional): integer(int64)
  Unique identifier for the alternate phone contact.
• AltPhoneCountryCode(optional): string
  Alternate phone country code.
• AltPhoneExtension(optional): string
  Alternate phone extension number of the location.
• AltPhoneNumber(optional): string
  Alternate phone number of the location.
• AltPhoneType(optional): string
  Alternate phone type of the location.
• AltRawPhoneNumber(optional): string
  Alternate raw phone number of the location.
• AreaSize(optional): number
  Size of the business location.
• AreaSizeUom(optional): string
  Maximum Length: 10

  Unit of measure for the business location size.
• BuildingType(optional): string
  Maximum Length: 20

  Building type used for parcel address searches.
• BusCategory(optional): string
  Maximum Length: 50

  The category for the business.
• BusDbaBusinessName(optional): string
  The operating name of the business.
• BusDescription(optional): string
  Description of the business.
• BusinessEntityId(optional): string
  Maximum Length: 50

  The unique identifier for the business entity associated with the location.
• BusinessEntityKey(optional): integer(int64)
  System-generated identifier for a business entity.
• BusinessLocationId(optional): string
  Maximum Length: 50

  The unique identifier for the business location.
• BusinessLocationKey(optional): integer(int64)
  System-generated unique identifier for a business location.
• BusinessLocationPartyId(optional): integer(int64)
  The unique identifier for the party associated with the business location.
• BusStateTaxId(optional): string
  Maximum Length: 20

  State tax ID of the business location.
• BusSubCategory(optional): string
  Maximum Length: 50

  The subcategory for the business.
• City(optional): string
  The location address city.
• CityTaxId(optional): string
  Maximum Length: 20

  The unique tax identifier issued to the business by the city.
• CoordinateX(optional): integer(int64)
  Geographic X-coordinate of the parcel address location.
• CoordinateY(optional): integer(int64)
  Geographic Y-coordinate of the parcel address location.
• Country(optional): string
  The location address country.
• County(optional): string
  Physical address county.
• CreationDate(optional): string(date-time)
  The date that the business location was created.
• CrossroadOne(optional): string
  Maximum Length: 240

  Cross road 1 that is part of parcel address.
• CrossroadTwo(optional): string
  Maximum Length: 240

  Cross road 2 that is part of parcel address.
• CtyFoodSerLicExp(optional): string(date)
  Expiration date of the county food service license associated with the business location.
• CtyFoodSerLicNum(optional): string
  Maximum Length: 30

  County food service license number of the business location.
• EcontactAvailabilityOne(optional): string
  Maximum Length: 1000

  Availability of the primary emergency contact.
• EcontactAvailabilityTwo(optional): string
  Maximum Length: 1000

  Availability of the secondary emergency contact.
• EcontactEmailOne(optional): string
  Maximum Length: 320

  Email address of the primary emergency contact.
• EcontactEmailTwo(optional): string
  Maximum Length: 320

  Email address of the secondary emergency contact.
• EcontactFirstNameOne(optional): string
  Maximum Length: 150

  First name of the primary emergency contact.
• EcontactFirstNameTwo(optional): string
  Maximum Length: 150

  First name of the secondary emergency contact.
• EcontactLastNameOne(optional): string
  Maximum Length: 150

  Last name of the primary emergency contact.
• EcontactLastNameTwo(optional): string
  Maximum Length: 150

  Last name of the secondary emergency contact.
• EcontactPhoneAreaCodeOne(optional): string
  Primary emergency contact area code.
• EcontactPhoneAreaCodeTwo(optional): string
  Secondary emergency contact area code.
• EcontactPhoneCountryOne(optional): string
  Primary emergency contact country.
• EcontactPhoneCountryTwo(optional): string
  Secondary emergency contact country code.
• EcontactPhoneExtensionOne(optional): string
  Primary emergency contact phone extension number of the location.
• EcontactPhoneExtensionTwo(optional): string
  Secondary emergency contact phone extension number of the location.
• EcontactPhoneNumberOne(optional): string
  Primary emergency contact phone number of the location.
• EcontactPhoneNumberTwo(optional): string
  Secondary emergency contact phone number of the location.
• EcontactPhoneTypeOne(optional): string
  Phone type of the primary emergency contact for the location.
• EcontactPhoneTypeTwo(optional): string
  Secondary emergency contact phone type of the location.
• EcontactRawPhoneNumberOne(optional): string
  Primary emergency contact raw phone number of the location.
• EcontactRawPhoneNumberTwo(optional): string
  Secondary emergency contact raw phone number of the location.
• EmailAddress(optional): string
  Maximum Length: 320

  Email address of the location.
• EmployeeTotal(optional): integer(int32)
  Total number of employees in organization.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the business location has been enabled.
• EndDate(optional): string(date)
  The end date of the business location.
• EOnePhoneContactPointId(optional): integer(int64)
  The unique identifier for the primary phone contact.
• ETwoPhoneContactPointId(optional): integer(int64)
  The unique identifier for the secondary phone contact.
• Floor(optional): string
  The floor number of the physical address.
• InactiveReason(optional): string
  Maximum Length: 1000

  The reason that the business location was inactivated.
• Landmark(optional): string
  Maximum Length: 200

  Landmark for the parcel address.
• LastUpdateDate(optional): string(date-time)
  The date that the business location was last updated.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The login identifier of the person who last updated the business location.
• Latitude(optional): number
  Latitude of the location.
• links(optional): array Items
  Title: Items

  Link Relations
• Longitude(optional): number
  Longitude of the location.
• MailingAddress1(optional): string
  First line of the location mailing address.
• MailingAddress2(optional): string
  Third line of the location mailing address.
• MailingAddress3(optional): string
  Second line of the location mailing address.
• MailingAddress4(optional): string
  Fourth line of the location mailing address.
• MailingCity(optional): string
  Location mailing address city.
• MailingCountry(optional): string
  Location mailing address country.
• MailingCounty(optional): string
  Location mailing address county.
• MailingPostalCode(optional): string
  Location mailing address postal code.
• MailingPostalPlusFourCode(optional): string
  Location mailing postal plus 4 code.
• MailingProvince(optional): string
  Location mailing address province.
• MailingState(optional): string
  Location mailing address state.
• MobileBusFlag(optional): string
  Maximum Length: 1

  Indicates whether the business is a mobile product or provides mobile service.
• MunicipalityId(optional): string
  Maximum Length: 20

  Municipality in which the parcel address is located.
• ObjectVersionNumber(optional): integer(int32)
  Workflow project revision number used to define the workflow.
• OtherTaxId(optional): string
  Maximum Length: 20

  The unique tax identifier issued to the business by the county.
• ParcelId(optional): integer(int64)
  The unique identifier for the parcel.
• ParcelIdEntered(optional): string
  Maximum Length: 30

  The parcel number.
• PostalCode(optional): string
  Physical address postal code.
• PostalPlus4Code(optional): string
  Physical address postal plus 4 code.
• PrimaryPhoneAreaCode(optional): string
  Primary phone area code.
• PrimaryPhoneCountryCode(optional): string
  Primary phone country code.
• PrimaryPhoneExtension(optional): string
  Primary phone extension number of the location.
• PrimaryPhoneNumber(optional): string
  Primary phone number of the location.
• PrimaryPhoneType(optional): string
  Primary phone type of the location.
• PrimaryRawPhoneNumber(optional): string
  Primary raw phone number of the location.
• PrimPhoneContactPointId(optional): integer(int64)
  The unique identifier of the primary phone contact.
• Province(optional): string
  Physical address province.
• RentalUnitNum(optional): integer(int64)
  Number of rental units for the business location.
• SameMailAddressFlag(optional): string
  Maximum Length: 1

  Indicates whether the mailing address is same as mailing address.
• SellPerNum(optional): string
  Maximum Length: 30

  Business sellers permit number of the location.
• SellPerNumExp(optional): string(date)
  Expiration date of the business sellers permit number associated with the location.
• StartDate(optional): string(date)
  The start date of the business location.
• State(optional): string
  Physical address state.
• Status(optional): string
  Maximum Length: 20

  Current status of the location.
• StQualPerNum(optional): string
  Maximum Length: 30

  The ID number issued to the business by the State Equalization Board.
• StreetDirection(optional): string
  Street direction of the location.
• StreetName(optional): string
  Maximum Length: 240

  Street name used for parcel address searches.
• StreetNumber(optional): string
  Street number of the location.
• StreetSuffix(optional): string
  Maximum Length: 20

  Street name that describes the street.
• StreetType(optional): string
  Maximum Length: 20

  Street type used for parcel address searches.
• TaxClass(optional): string
  Maximum Length: 30

  Municipal tax class of the business location.
• UnitNumber(optional): string
  Maximum Length: 30

  Apartment unit number used for parcel address searches.
• Website(optional): string
  Maximum Length: 1000

  Website address of the location.
• WithinJurisdictionFlag(optional): string
  Maximum Length: 1

  Indicates whether the business is located within the agency's jurisdiction.

{
    "properties":{
        "Address1":{
            "type":"string",
            "description":"First line of the physical address."
        },
        "Address2":{
            "type":"string",
            "description":"Second line of the physical address."
        },
        "Address3":{
            "type":"string",
            "description":"Third line of the physical address."
        },
        "Address4":{
            "type":"string",
            "description":"Fourth line of the physical address."
        },
        "AddressCode":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier for the parcel address."
        },
        "AddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the address."
        },
        "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."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the business location."
        },
        "AltPhoneAreaCode":{
            "type":"string",
            "description":"Alternate phone area code."
        },
        "AltPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier for the alternate phone contact."
        },
        "AltPhoneCountryCode":{
            "type":"string",
            "description":"Alternate phone country code."
        },
        "AltPhoneExtension":{
            "type":"string",
            "description":"Alternate phone extension number of the location."
        },
        "AltPhoneNumber":{
            "type":"string",
            "description":"Alternate phone number of the location."
        },
        "AltPhoneType":{
            "type":"string",
            "description":"Alternate phone type of the location."
        },
        "AltRawPhoneNumber":{
            "type":"string",
            "description":"Alternate raw phone number of the location."
        },
        "AreaSize":{
            "type":"number",
            "description":"Size of the business location."
        },
        "AreaSizeUom":{
            "maxLength":10,
            "type":"string",
            "description":"Unit of measure for the business location size."
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"Building type used for parcel address searches."
        },
        "BusCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The category for the business."
        },
        "BusDbaBusinessName":{
            "type":"string",
            "description":"The operating name of the business."
        },
        "BusDescription":{
            "type":"string",
            "description":"Description of the business."
        },
        "BusStateTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"State tax ID of the business location."
        },
        "BusSubCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The subcategory for the business."
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business entity associated with the location."
        },
        "BusinessEntityKey":{
            "format":"int64",
            "type":"integer",
            "description":"System-generated identifier for a business entity."
        },
        "BusinessLocationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business location."
        },
        "BusinessLocationKey":{
            "format":"int64",
            "type":"integer",
            "description":"System-generated unique identifier for a business location."
        },
        "BusinessLocationPartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the party associated with the business location."
        },
        "City":{
            "type":"string",
            "description":"The location address city."
        },
        "CityTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique tax identifier issued to the business by the city."
        },
        "CoordinateX":{
            "format":"int64",
            "type":"integer",
            "description":"Geographic X-coordinate of the parcel address location."
        },
        "CoordinateY":{
            "format":"int64",
            "type":"integer",
            "description":"Geographic Y-coordinate of the parcel address location."
        },
        "Country":{
            "type":"string",
            "description":"The location address country."
        },
        "County":{
            "type":"string",
            "description":"Physical address county."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the business location was created."
        },
        "CrossroadOne":{
            "maxLength":240,
            "type":"string",
            "description":"Cross road 1 that is part of parcel address."
        },
        "CrossroadTwo":{
            "maxLength":240,
            "type":"string",
            "description":"Cross road 2 that is part of parcel address."
        },
        "CtyFoodSerLicExp":{
            "format":"date",
            "type":"string",
            "description":"Expiration date of the county food service license associated with the business location."
        },
        "CtyFoodSerLicNum":{
            "maxLength":30,
            "type":"string",
            "description":"County food service license number of the business location."
        },
        "EOnePhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the primary phone contact."
        },
        "ETwoPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the secondary phone contact."
        },
        "EcontactAvailabilityOne":{
            "maxLength":1000,
            "type":"string",
            "description":"Availability of the primary emergency contact."
        },
        "EcontactAvailabilityTwo":{
            "maxLength":1000,
            "type":"string",
            "description":"Availability of the secondary emergency contact."
        },
        "EcontactEmailOne":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the primary emergency contact."
        },
        "EcontactEmailTwo":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the secondary emergency contact."
        },
        "EcontactFirstNameOne":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the primary emergency contact."
        },
        "EcontactFirstNameTwo":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the secondary emergency contact."
        },
        "EcontactLastNameOne":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the primary emergency contact."
        },
        "EcontactLastNameTwo":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the secondary emergency contact."
        },
        "EcontactPhoneAreaCodeOne":{
            "type":"string",
            "description":"Primary emergency contact area code."
        },
        "EcontactPhoneAreaCodeTwo":{
            "type":"string",
            "description":"Secondary emergency contact area code."
        },
        "EcontactPhoneCountryOne":{
            "type":"string",
            "description":"Primary emergency contact country."
        },
        "EcontactPhoneCountryTwo":{
            "type":"string",
            "description":"Secondary emergency contact country code."
        },
        "EcontactPhoneExtensionOne":{
            "type":"string",
            "description":"Primary emergency contact phone extension number of the location."
        },
        "EcontactPhoneExtensionTwo":{
            "type":"string",
            "description":"Secondary emergency contact phone extension number of the location."
        },
        "EcontactPhoneNumberOne":{
            "type":"string",
            "description":"Primary emergency contact phone number of the location."
        },
        "EcontactPhoneNumberTwo":{
            "type":"string",
            "description":"Secondary emergency contact phone number of the location."
        },
        "EcontactPhoneTypeOne":{
            "type":"string",
            "description":"Phone type of the primary emergency contact for the location."
        },
        "EcontactPhoneTypeTwo":{
            "type":"string",
            "description":"Secondary emergency contact phone type of the location."
        },
        "EcontactRawPhoneNumberOne":{
            "type":"string",
            "description":"Primary emergency contact raw phone number of the location."
        },
        "EcontactRawPhoneNumberTwo":{
            "type":"string",
            "description":"Secondary emergency contact raw phone number of the location."
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the location."
        },
        "EmployeeTotal":{
            "format":"int32",
            "type":"integer",
            "description":"Total number of employees in organization."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business location has been enabled."
        },
        "EndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date of the business location."
        },
        "Floor":{
            "type":"string",
            "description":"The floor number of the physical address."
        },
        "InactiveReason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason that the business location was inactivated."
        },
        "Landmark":{
            "maxLength":200,
            "type":"string",
            "description":"Landmark for the parcel address."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the business location was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier of the person who last updated the business location."
        },
        "Latitude":{
            "type":"number",
            "description":"Latitude of the location."
        },
        "Longitude":{
            "type":"number",
            "description":"Longitude of the location."
        },
        "MailingAddress1":{
            "type":"string",
            "description":"First line of the location mailing address."
        },
        "MailingAddress2":{
            "type":"string",
            "description":"Third line of the location mailing address."
        },
        "MailingAddress3":{
            "type":"string",
            "description":"Second line of the location mailing address."
        },
        "MailingAddress4":{
            "type":"string",
            "description":"Fourth line of the location mailing address."
        },
        "MailingCity":{
            "type":"string",
            "description":"Location mailing address city."
        },
        "MailingCountry":{
            "type":"string",
            "description":"Location mailing address country."
        },
        "MailingCounty":{
            "type":"string",
            "description":"Location mailing address county."
        },
        "MailingPostalCode":{
            "type":"string",
            "description":"Location mailing address postal code."
        },
        "MailingPostalPlusFourCode":{
            "type":"string",
            "description":"Location mailing postal plus 4 code."
        },
        "MailingProvince":{
            "type":"string",
            "description":"Location mailing address province."
        },
        "MailingState":{
            "type":"string",
            "description":"Location mailing address state."
        },
        "MobileBusFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is a mobile product or provides mobile service."
        },
        "MunicipalityId":{
            "maxLength":20,
            "type":"string",
            "description":"Municipality in which the parcel address is located."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"Workflow project revision number used to define the workflow."
        },
        "OtherTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique tax identifier issued to the business by the county."
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel."
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The parcel number."
        },
        "PostalCode":{
            "type":"string",
            "description":"Physical address postal code."
        },
        "PostalPlus4Code":{
            "type":"string",
            "description":"Physical address postal plus 4 code."
        },
        "PrimPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the primary phone contact."
        },
        "PrimaryPhoneAreaCode":{
            "type":"string",
            "description":"Primary phone area code."
        },
        "PrimaryPhoneCountryCode":{
            "type":"string",
            "description":"Primary phone country code."
        },
        "PrimaryPhoneExtension":{
            "type":"string",
            "description":"Primary phone extension number of the location."
        },
        "PrimaryPhoneNumber":{
            "type":"string",
            "description":"Primary phone number of the location."
        },
        "PrimaryPhoneType":{
            "type":"string",
            "description":"Primary phone type of the location."
        },
        "PrimaryRawPhoneNumber":{
            "type":"string",
            "description":"Primary raw phone number of the location."
        },
        "Province":{
            "type":"string",
            "description":"Physical address province."
        },
        "RentalUnitNum":{
            "format":"int64",
            "type":"integer",
            "description":"Number of rental units for the business location."
        },
        "SameMailAddressFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the mailing address is same as mailing address."
        },
        "SellPerNum":{
            "maxLength":30,
            "type":"string",
            "description":"Business sellers permit number of the location."
        },
        "SellPerNumExp":{
            "format":"date",
            "type":"string",
            "description":"Expiration date of the business sellers permit number associated with the location."
        },
        "StQualPerNum":{
            "maxLength":30,
            "type":"string",
            "description":"The ID number issued to the business by the State Equalization Board."
        },
        "StartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date of the business location."
        },
        "State":{
            "type":"string",
            "description":"Physical address state."
        },
        "Status":{
            "maxLength":20,
            "type":"string",
            "description":"Current status of the location."
        },
        "StreetDirection":{
            "type":"string",
            "description":"Street direction of the location."
        },
        "StreetName":{
            "maxLength":240,
            "type":"string",
            "description":"Street name used for parcel address searches."
        },
        "StreetNumber":{
            "type":"string",
            "description":"Street number of the location."
        },
        "StreetSuffix":{
            "maxLength":20,
            "type":"string",
            "description":"Street name that describes the street."
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"Street type used for parcel address searches."
        },
        "TaxClass":{
            "maxLength":30,
            "type":"string",
            "description":"Municipal tax class of the business location."
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Apartment unit number used for parcel address searches."
        },
        "Website":{
            "maxLength":1000,
            "type":"string",
            "description":"Website address of the location."
        },
        "WithinJurisdictionFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is located within the agency's jurisdiction."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBusinessRegistrations-BusinessLocation-item

Type: object

Show Source

• Address1(optional): string
  First line of the physical address.
• Address2(optional): string
  Second line of the physical address.
• Address3(optional): string
  Third line of the physical address.
• Address4(optional): string
  Fourth line of the physical address.
• AddressCode(optional): string
  Maximum Length: 32

  Unique identifier for the parcel address.
• AddressId(optional): integer(int64)
  The unique identifier for the address.
• AddressType(optional): string
  Maximum Length: 20

  Attribute used for address point validation. Possible values might be main address, virtual address, shipping gate address, or others.
• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the business location.
• AltPhoneAreaCode(optional): string
  Alternate phone area code.
• AltPhoneContactPointId(optional): integer(int64)
  Unique identifier for the alternate phone contact.
• AltPhoneCountryCode(optional): string
  Alternate phone country code.
• AltPhoneExtension(optional): string
  Alternate phone extension number of the location.
• AltPhoneNumber(optional): string
  Alternate phone number of the location.
• AltPhoneType(optional): string
  Alternate phone type of the location.
• AltRawPhoneNumber(optional): string
  Alternate raw phone number of the location.
• AreaSize(optional): number
  Size of the business location.
• AreaSizeUom(optional): string
  Maximum Length: 10

  Unit of measure for the business location size.
• BuildingType(optional): string
  Maximum Length: 20

  Building type used for parcel address searches.
• BusCategory(optional): string
  Maximum Length: 50

  The category for the business.
• BusDbaBusinessName(optional): string
  The operating name of the business.
• BusDescription(optional): string
  Description of the business.
• BusinessEntityId(optional): string
  Maximum Length: 50

  The unique identifier for the business entity associated with the location.
• BusinessEntityKey(optional): integer(int64)
  System-generated identifier for a business entity.
• BusinessLocationId(optional): string
  Maximum Length: 50

  The unique identifier for the business location.
• BusinessLocationKey(optional): integer(int64)
  System-generated unique identifier for a business location.
• BusinessLocationPartyId(optional): integer(int64)
  The unique identifier for the party associated with the business location.
• BusStateTaxId(optional): string
  Maximum Length: 20

  State tax ID of the business location.
• BusSubCategory(optional): string
  Maximum Length: 50

  The subcategory for the business.
• City(optional): string
  The location address city.
• CityTaxId(optional): string
  Maximum Length: 20

  The unique tax identifier issued to the business by the city.
• CoordinateX(optional): integer(int64)
  Geographic X-coordinate of the parcel address location.
• CoordinateY(optional): integer(int64)
  Geographic Y-coordinate of the parcel address location.
• Country(optional): string
  The location address country.
• County(optional): string
  Physical address county.
• CreationDate(optional): string(date-time)
  The date that the business location was created.
• CrossroadOne(optional): string
  Maximum Length: 240

  Cross road 1 that is part of parcel address.
• CrossroadTwo(optional): string
  Maximum Length: 240

  Cross road 2 that is part of parcel address.
• CtyFoodSerLicExp(optional): string(date)
  Expiration date of the county food service license associated with the business location.
• CtyFoodSerLicNum(optional): string
  Maximum Length: 30

  County food service license number of the business location.
• EcontactAvailabilityOne(optional): string
  Maximum Length: 1000

  Availability of the primary emergency contact.
• EcontactAvailabilityTwo(optional): string
  Maximum Length: 1000

  Availability of the secondary emergency contact.
• EcontactEmailOne(optional): string
  Maximum Length: 320

  Email address of the primary emergency contact.
• EcontactEmailTwo(optional): string
  Maximum Length: 320

  Email address of the secondary emergency contact.
• EcontactFirstNameOne(optional): string
  Maximum Length: 150

  First name of the primary emergency contact.
• EcontactFirstNameTwo(optional): string
  Maximum Length: 150

  First name of the secondary emergency contact.
• EcontactLastNameOne(optional): string
  Maximum Length: 150

  Last name of the primary emergency contact.
• EcontactLastNameTwo(optional): string
  Maximum Length: 150

  Last name of the secondary emergency contact.
• EcontactPhoneAreaCodeOne(optional): string
  Primary emergency contact area code.
• EcontactPhoneAreaCodeTwo(optional): string
  Secondary emergency contact area code.
• EcontactPhoneCountryOne(optional): string
  Primary emergency contact country.
• EcontactPhoneCountryTwo(optional): string
  Secondary emergency contact country code.
• EcontactPhoneExtensionOne(optional): string
  Primary emergency contact phone extension number of the location.
• EcontactPhoneExtensionTwo(optional): string
  Secondary emergency contact phone extension number of the location.
• EcontactPhoneNumberOne(optional): string
  Primary emergency contact phone number of the location.
• EcontactPhoneNumberTwo(optional): string
  Secondary emergency contact phone number of the location.
• EcontactPhoneTypeOne(optional): string
  Phone type of the primary emergency contact for the location.
• EcontactPhoneTypeTwo(optional): string
  Secondary emergency contact phone type of the location.
• EcontactRawPhoneNumberOne(optional): string
  Primary emergency contact raw phone number of the location.
• EcontactRawPhoneNumberTwo(optional): string
  Secondary emergency contact raw phone number of the location.
• EmailAddress(optional): string
  Maximum Length: 320

  Email address of the location.
• EmployeeTotal(optional): integer(int32)
  Total number of employees in organization.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates whether the business location has been enabled.
• EndDate(optional): string(date)
  The end date of the business location.
• EOnePhoneContactPointId(optional): integer(int64)
  The unique identifier for the primary phone contact.
• ETwoPhoneContactPointId(optional): integer(int64)
  The unique identifier for the secondary phone contact.
• Floor(optional): string
  The floor number of the physical address.
• InactiveReason(optional): string
  Maximum Length: 1000

  The reason that the business location was inactivated.
• Landmark(optional): string
  Maximum Length: 200

  Landmark for the parcel address.
• LastUpdateDate(optional): string(date-time)
  The date that the business location was last updated.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The login identifier of the person who last updated the business location.
• Latitude(optional): number
  Latitude of the location.
• links(optional): array Items
  Title: Items

  Link Relations
• Longitude(optional): number
  Longitude of the location.
• MailingAddress1(optional): string
  First line of the location mailing address.
• MailingAddress2(optional): string
  Third line of the location mailing address.
• MailingAddress3(optional): string
  Second line of the location mailing address.
• MailingAddress4(optional): string
  Fourth line of the location mailing address.
• MailingCity(optional): string
  Location mailing address city.
• MailingCountry(optional): string
  Location mailing address country.
• MailingCounty(optional): string
  Location mailing address county.
• MailingPostalCode(optional): string
  Location mailing address postal code.
• MailingPostalPlusFourCode(optional): string
  Location mailing postal plus 4 code.
• MailingProvince(optional): string
  Location mailing address province.
• MailingState(optional): string
  Location mailing address state.
• MobileBusFlag(optional): string
  Maximum Length: 1

  Indicates whether the business is a mobile product or provides mobile service.
• MunicipalityId(optional): string
  Maximum Length: 20

  Municipality in which the parcel address is located.
• ObjectVersionNumber(optional): integer(int32)
  Workflow project revision number used to define the workflow.
• OtherTaxId(optional): string
  Maximum Length: 20

  The unique tax identifier issued to the business by the county.
• ParcelId(optional): integer(int64)
  The unique identifier for the parcel.
• ParcelIdEntered(optional): string
  Maximum Length: 30

  The parcel number.
• PostalCode(optional): string
  Physical address postal code.
• PostalPlus4Code(optional): string
  Physical address postal plus 4 code.
• PrimaryPhoneAreaCode(optional): string
  Primary phone area code.
• PrimaryPhoneCountryCode(optional): string
  Primary phone country code.
• PrimaryPhoneExtension(optional): string
  Primary phone extension number of the location.
• PrimaryPhoneNumber(optional): string
  Primary phone number of the location.
• PrimaryPhoneType(optional): string
  Primary phone type of the location.
• PrimaryRawPhoneNumber(optional): string
  Primary raw phone number of the location.
• PrimPhoneContactPointId(optional): integer(int64)
  The unique identifier of the primary phone contact.
• Province(optional): string
  Physical address province.
• RentalUnitNum(optional): integer(int64)
  Number of rental units for the business location.
• SameMailAddressFlag(optional): string
  Maximum Length: 1

  Indicates whether the mailing address is same as mailing address.
• SellPerNum(optional): string
  Maximum Length: 30

  Business sellers permit number of the location.
• SellPerNumExp(optional): string(date)
  Expiration date of the business sellers permit number associated with the location.
• StartDate(optional): string(date)
  The start date of the business location.
• State(optional): string
  Physical address state.
• Status(optional): string
  Maximum Length: 20

  Current status of the location.
• StQualPerNum(optional): string
  Maximum Length: 30

  The ID number issued to the business by the State Equalization Board.
• StreetDirection(optional): string
  Street direction of the location.
• StreetName(optional): string
  Maximum Length: 240

  Street name used for parcel address searches.
• StreetNumber(optional): string
  Street number of the location.
• StreetSuffix(optional): string
  Maximum Length: 20

  Street name that describes the street.
• StreetType(optional): string
  Maximum Length: 20

  Street type used for parcel address searches.
• TaxClass(optional): string
  Maximum Length: 30

  Municipal tax class of the business location.
• UnitNumber(optional): string
  Maximum Length: 30

  Apartment unit number used for parcel address searches.
• Website(optional): string
  Maximum Length: 1000

  Website address of the location.
• WithinJurisdictionFlag(optional): string
  Maximum Length: 1

  Indicates whether the business is located within the agency's jurisdiction.

{
    "properties":{
        "Address1":{
            "type":"string",
            "description":"First line of the physical address."
        },
        "Address2":{
            "type":"string",
            "description":"Second line of the physical address."
        },
        "Address3":{
            "type":"string",
            "description":"Third line of the physical address."
        },
        "Address4":{
            "type":"string",
            "description":"Fourth line of the physical address."
        },
        "AddressCode":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier for the parcel address."
        },
        "AddressId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the address."
        },
        "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."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the business location."
        },
        "AltPhoneAreaCode":{
            "type":"string",
            "description":"Alternate phone area code."
        },
        "AltPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier for the alternate phone contact."
        },
        "AltPhoneCountryCode":{
            "type":"string",
            "description":"Alternate phone country code."
        },
        "AltPhoneExtension":{
            "type":"string",
            "description":"Alternate phone extension number of the location."
        },
        "AltPhoneNumber":{
            "type":"string",
            "description":"Alternate phone number of the location."
        },
        "AltPhoneType":{
            "type":"string",
            "description":"Alternate phone type of the location."
        },
        "AltRawPhoneNumber":{
            "type":"string",
            "description":"Alternate raw phone number of the location."
        },
        "AreaSize":{
            "type":"number",
            "description":"Size of the business location."
        },
        "AreaSizeUom":{
            "maxLength":10,
            "type":"string",
            "description":"Unit of measure for the business location size."
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"Building type used for parcel address searches."
        },
        "BusCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The category for the business."
        },
        "BusDbaBusinessName":{
            "type":"string",
            "description":"The operating name of the business."
        },
        "BusDescription":{
            "type":"string",
            "description":"Description of the business."
        },
        "BusStateTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"State tax ID of the business location."
        },
        "BusSubCategory":{
            "maxLength":50,
            "type":"string",
            "description":"The subcategory for the business."
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business entity associated with the location."
        },
        "BusinessEntityKey":{
            "format":"int64",
            "type":"integer",
            "description":"System-generated identifier for a business entity."
        },
        "BusinessLocationId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the business location."
        },
        "BusinessLocationKey":{
            "format":"int64",
            "type":"integer",
            "description":"System-generated unique identifier for a business location."
        },
        "BusinessLocationPartyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the party associated with the business location."
        },
        "City":{
            "type":"string",
            "description":"The location address city."
        },
        "CityTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique tax identifier issued to the business by the city."
        },
        "CoordinateX":{
            "format":"int64",
            "type":"integer",
            "description":"Geographic X-coordinate of the parcel address location."
        },
        "CoordinateY":{
            "format":"int64",
            "type":"integer",
            "description":"Geographic Y-coordinate of the parcel address location."
        },
        "Country":{
            "type":"string",
            "description":"The location address country."
        },
        "County":{
            "type":"string",
            "description":"Physical address county."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the business location was created."
        },
        "CrossroadOne":{
            "maxLength":240,
            "type":"string",
            "description":"Cross road 1 that is part of parcel address."
        },
        "CrossroadTwo":{
            "maxLength":240,
            "type":"string",
            "description":"Cross road 2 that is part of parcel address."
        },
        "CtyFoodSerLicExp":{
            "format":"date",
            "type":"string",
            "description":"Expiration date of the county food service license associated with the business location."
        },
        "CtyFoodSerLicNum":{
            "maxLength":30,
            "type":"string",
            "description":"County food service license number of the business location."
        },
        "EOnePhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the primary phone contact."
        },
        "ETwoPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the secondary phone contact."
        },
        "EcontactAvailabilityOne":{
            "maxLength":1000,
            "type":"string",
            "description":"Availability of the primary emergency contact."
        },
        "EcontactAvailabilityTwo":{
            "maxLength":1000,
            "type":"string",
            "description":"Availability of the secondary emergency contact."
        },
        "EcontactEmailOne":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the primary emergency contact."
        },
        "EcontactEmailTwo":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the secondary emergency contact."
        },
        "EcontactFirstNameOne":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the primary emergency contact."
        },
        "EcontactFirstNameTwo":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the secondary emergency contact."
        },
        "EcontactLastNameOne":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the primary emergency contact."
        },
        "EcontactLastNameTwo":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the secondary emergency contact."
        },
        "EcontactPhoneAreaCodeOne":{
            "type":"string",
            "description":"Primary emergency contact area code."
        },
        "EcontactPhoneAreaCodeTwo":{
            "type":"string",
            "description":"Secondary emergency contact area code."
        },
        "EcontactPhoneCountryOne":{
            "type":"string",
            "description":"Primary emergency contact country."
        },
        "EcontactPhoneCountryTwo":{
            "type":"string",
            "description":"Secondary emergency contact country code."
        },
        "EcontactPhoneExtensionOne":{
            "type":"string",
            "description":"Primary emergency contact phone extension number of the location."
        },
        "EcontactPhoneExtensionTwo":{
            "type":"string",
            "description":"Secondary emergency contact phone extension number of the location."
        },
        "EcontactPhoneNumberOne":{
            "type":"string",
            "description":"Primary emergency contact phone number of the location."
        },
        "EcontactPhoneNumberTwo":{
            "type":"string",
            "description":"Secondary emergency contact phone number of the location."
        },
        "EcontactPhoneTypeOne":{
            "type":"string",
            "description":"Phone type of the primary emergency contact for the location."
        },
        "EcontactPhoneTypeTwo":{
            "type":"string",
            "description":"Secondary emergency contact phone type of the location."
        },
        "EcontactRawPhoneNumberOne":{
            "type":"string",
            "description":"Primary emergency contact raw phone number of the location."
        },
        "EcontactRawPhoneNumberTwo":{
            "type":"string",
            "description":"Secondary emergency contact raw phone number of the location."
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the location."
        },
        "EmployeeTotal":{
            "format":"int32",
            "type":"integer",
            "description":"Total number of employees in organization."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business location has been enabled."
        },
        "EndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date of the business location."
        },
        "Floor":{
            "type":"string",
            "description":"The floor number of the physical address."
        },
        "InactiveReason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason that the business location was inactivated."
        },
        "Landmark":{
            "maxLength":200,
            "type":"string",
            "description":"Landmark for the parcel address."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the business location was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login identifier of the person who last updated the business location."
        },
        "Latitude":{
            "type":"number",
            "description":"Latitude of the location."
        },
        "Longitude":{
            "type":"number",
            "description":"Longitude of the location."
        },
        "MailingAddress1":{
            "type":"string",
            "description":"First line of the location mailing address."
        },
        "MailingAddress2":{
            "type":"string",
            "description":"Third line of the location mailing address."
        },
        "MailingAddress3":{
            "type":"string",
            "description":"Second line of the location mailing address."
        },
        "MailingAddress4":{
            "type":"string",
            "description":"Fourth line of the location mailing address."
        },
        "MailingCity":{
            "type":"string",
            "description":"Location mailing address city."
        },
        "MailingCountry":{
            "type":"string",
            "description":"Location mailing address country."
        },
        "MailingCounty":{
            "type":"string",
            "description":"Location mailing address county."
        },
        "MailingPostalCode":{
            "type":"string",
            "description":"Location mailing address postal code."
        },
        "MailingPostalPlusFourCode":{
            "type":"string",
            "description":"Location mailing postal plus 4 code."
        },
        "MailingProvince":{
            "type":"string",
            "description":"Location mailing address province."
        },
        "MailingState":{
            "type":"string",
            "description":"Location mailing address state."
        },
        "MobileBusFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is a mobile product or provides mobile service."
        },
        "MunicipalityId":{
            "maxLength":20,
            "type":"string",
            "description":"Municipality in which the parcel address is located."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"Workflow project revision number used to define the workflow."
        },
        "OtherTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique tax identifier issued to the business by the county."
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel."
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The parcel number."
        },
        "PostalCode":{
            "type":"string",
            "description":"Physical address postal code."
        },
        "PostalPlus4Code":{
            "type":"string",
            "description":"Physical address postal plus 4 code."
        },
        "PrimPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the primary phone contact."
        },
        "PrimaryPhoneAreaCode":{
            "type":"string",
            "description":"Primary phone area code."
        },
        "PrimaryPhoneCountryCode":{
            "type":"string",
            "description":"Primary phone country code."
        },
        "PrimaryPhoneExtension":{
            "type":"string",
            "description":"Primary phone extension number of the location."
        },
        "PrimaryPhoneNumber":{
            "type":"string",
            "description":"Primary phone number of the location."
        },
        "PrimaryPhoneType":{
            "type":"string",
            "description":"Primary phone type of the location."
        },
        "PrimaryRawPhoneNumber":{
            "type":"string",
            "description":"Primary raw phone number of the location."
        },
        "Province":{
            "type":"string",
            "description":"Physical address province."
        },
        "RentalUnitNum":{
            "format":"int64",
            "type":"integer",
            "description":"Number of rental units for the business location."
        },
        "SameMailAddressFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the mailing address is same as mailing address."
        },
        "SellPerNum":{
            "maxLength":30,
            "type":"string",
            "description":"Business sellers permit number of the location."
        },
        "SellPerNumExp":{
            "format":"date",
            "type":"string",
            "description":"Expiration date of the business sellers permit number associated with the location."
        },
        "StQualPerNum":{
            "maxLength":30,
            "type":"string",
            "description":"The ID number issued to the business by the State Equalization Board."
        },
        "StartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date of the business location."
        },
        "State":{
            "type":"string",
            "description":"Physical address state."
        },
        "Status":{
            "maxLength":20,
            "type":"string",
            "description":"Current status of the location."
        },
        "StreetDirection":{
            "type":"string",
            "description":"Street direction of the location."
        },
        "StreetName":{
            "maxLength":240,
            "type":"string",
            "description":"Street name used for parcel address searches."
        },
        "StreetNumber":{
            "type":"string",
            "description":"Street number of the location."
        },
        "StreetSuffix":{
            "maxLength":20,
            "type":"string",
            "description":"Street name that describes the street."
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"Street type used for parcel address searches."
        },
        "TaxClass":{
            "maxLength":30,
            "type":"string",
            "description":"Municipal tax class of the business location."
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Apartment unit number used for parcel address searches."
        },
        "Website":{
            "maxLength":1000,
            "type":"string",
            "description":"Website address of the location."
        },
        "WithinJurisdictionFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the business is located within the agency's jurisdiction."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top