Jump to

• Request
• Response

Create a business location

post

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

Request

Path Parameters

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address1: string
  Title: Address 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  Fourth line of the physical address.
• AddressCode: string
  Maximum Length: 32

  Unique identifier for the parcel address.
• AddressId: integer (int64)
  The unique identifier for the address.
• AddressType: string
  Title: Address Type

  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)
  The unique identifier of the agency associated with the business location.
• AltPhoneAreaCode: string
  Maximum Length: 20

  Alternate phone area code.
• AltPhoneContactPointId: integer (int64)
  Unique identifier for the alternate phone contact.
• AltPhoneCountryCode: string
  Maximum Length: 10

  Alternate phone country code.
• AltPhoneExtension: string
  Maximum Length: 20

  Alternate phone extension number of the location.
• AltPhoneNumber: string
  Maximum Length: 40

  Alternate phone number of the location.
• AltPhoneType: string
  Maximum Length: 30

  Alternate phone type of the location.
• AltRawPhoneNumber: string
  Maximum Length: 60

  Alternate raw phone number of the location.
• AreaSize: integer (int64)
  Size of the business location.
• AreaSizeUom: string
  Maximum Length: 10

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

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

  The category for the business.
• BusDbaBusinessName: string
  Title: Doing Business As

  Maximum Length: 360

  The operating name of the business.
• BusDescription: string
  Title: Business Description

  Maximum Length: 2000

  Description of the business.
• BusinessEntityId: string
  Maximum Length: 50

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

  The unique identifier for the business location.
• BusinessLocationKey: integer (int64)
  System-generated unique identifier for a business location.
• BusinessLocationPartyId: integer (int64)
  The unique identifier for the party associated with the business location.
• BusStateTaxId: string
  Title: State Tax ID

  Maximum Length: 20

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

  The subcategory for the business.
• City: string
  Title: City

  Maximum Length: 60

  The location address city.
• CityTaxId: string
  Title: City Tax ID

  Maximum Length: 20

  The unique tax identifier issued to the business by the city.
• CoordinateX: number
  Geographic X-coordinate of the parcel address location.
• CoordinateY: number
  Geographic Y-coordinate of the parcel address location.
• Country: string
  Title: Country

  Maximum Length: 2

  The location address country.
• County: string
  Maximum Length: 60

  Physical address county.
• CrossroadOne: string
  Maximum Length: 240

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

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

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

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

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

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

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  Last name of the secondary emergency contact.
• EcontactPhoneAreaCodeOne: string
  Title: Emergency Contact Phone Area Code 1

  Maximum Length: 20

  Primary emergency contact area code.
• EcontactPhoneAreaCodeTwo: string
  Title: Emergency Contact Phone Area Code 2

  Maximum Length: 20

  Secondary emergency contact area code.
• EcontactPhoneCountryOne: string
  Title: Emergency Contact Phone Country 1

  Maximum Length: 10

  Primary emergency contact country.
• EcontactPhoneCountryTwo: string
  Title: Emergency Contact Phone Country 2

  Maximum Length: 10

  Secondary emergency contact country code.
• EcontactPhoneExtensionOne: string
  Title: Emergency Contact Phone Extension 1

  Maximum Length: 20

  Primary emergency contact phone extension number of the location.
• EcontactPhoneExtensionTwo: string
  Title: Emergency Contact Phone Extension 2

  Maximum Length: 20

  Secondary emergency contact phone extension number of the location.
• EcontactPhoneNumberOne: string
  Title: Emergency Contact Phone Number 1

  Maximum Length: 40

  Primary emergency contact phone number of the location.
• EcontactPhoneNumberTwo: string
  Title: Emergency Contact Phone Number 2

  Maximum Length: 40

  Secondary emergency contact phone number of the location.
• EcontactPhoneTypeOne: string
  Title: Emergency Contact Phone Type 1

  Maximum Length: 30

  Phone type of the primary emergency contact for the location.
• EcontactPhoneTypeTwo: string
  Title: Emergency Contact Phone Type 2

  Maximum Length: 30

  Secondary emergency contact phone type of the location.
• EcontactRawPhoneNumberOne: string
  Maximum Length: 60

  Primary emergency contact raw phone number of the location.
• EcontactRawPhoneNumberTwo: string
  Maximum Length: 60

  Secondary emergency contact raw phone number of the location.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

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

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

  The floor number of the physical address.
• InactiveReason: string
  Maximum Length: 1000

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

  Landmark for the parcel address.
• Latitude: number
  Latitude of the location.
• LocationType: string
  Title: Location Type

  Maximum Length: 30

  The attribute used to identify the type of location.
• Longitude: number
  Longitude of the location.
• MailingAddress1: string
  Title: Mailing Address Line 1

  Maximum Length: 240

  First line of the location mailing address.
• MailingAddress2: string
  Title: Mailing Address Line 2

  Maximum Length: 240

  Third line of the location mailing address.
• MailingAddress3: string
  Maximum Length: 240

  Second line of the location mailing address.
• MailingAddress4: string
  Maximum Length: 240

  Fourth line of the location mailing address.
• MailingCity: string
  Title: Mailing City

  Maximum Length: 60

  Location mailing address city.
• MailingCountry: string
  Title: Mailing Country

  Maximum Length: 2

  Location mailing address country.
• MailingCounty: string
  Title: Mailing County

  Maximum Length: 60

  Location mailing address county.
• MailingPostalCode: string
  Title: Mailing Postal Code

  Maximum Length: 60

  Location mailing address postal code.
• MailingPostalPlusFourCode: string
  Maximum Length: 20

  Location mailing postal plus 4 code.
• MailingProvince: string
  Title: Mailing Province

  Maximum Length: 60

  Location mailing address province.
• MailingState: string
  Title: Mailing State

  Maximum Length: 60

  Location mailing address state.
• MobileBusFlag: string
  Title: Mobile Business

  Maximum Length: 1

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

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

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

  The parcel number.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  Physical address postal code.
• PostalPlus4Code: string
  Maximum Length: 20

  Physical address postal plus 4 code.
• PrimaryPhoneAreaCode: string
  Title: Primary Phone Area Code

  Maximum Length: 20

  Primary phone area code.
• PrimaryPhoneCountryCode: string
  Title: Primary Phone Country Code

  Maximum Length: 10

  Primary phone country code.
• PrimaryPhoneExtension: string
  Title: Primary Phone Extension

  Maximum Length: 20

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

  Maximum Length: 40

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

  Maximum Length: 30

  Primary phone type of the location.
• PrimaryRawPhoneNumber: string
  Maximum Length: 60

  Primary raw phone number of the location.
• PrimPhoneContactPointId: integer (int64)
  The unique identifier of the primary phone contact.
• Province: string
  Title: Province

  Maximum Length: 60

  Physical address province.
• RentalUnitNum: integer (int64)
  Number of rental units for the business location.
• SameMailAddressFlag: string
  Maximum Length: 1

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

  Business sellers permit number of the location.
• SellPerNumExp: string (date)
  Expiration date of the business sellers permit number associated with the location.
• StartDate: string (date)
  Title: Start Date

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

  Maximum Length: 60

  Physical address state.
• Status: string
  Maximum Length: 20

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

  The ID number issued to the business by the State Equalization Board.
• StreetDirection: string
  Maximum Length: 50

  Street direction of the location.
• StreetName: string
  Maximum Length: 240

  Street name used for parcel address searches.
• StreetNumber: string
  Maximum Length: 240

  Street number of the location.
• StreetSuffix: string
  Maximum Length: 20

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

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

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

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

  Website address of the location.
• WithinJurisdictionFlag: string
  Title: Within Jurisdiction

  Maximum Length: 1

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

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

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 : publicSectorBusinessRegistrations-BusinessLocation-item-response

Type: object

Show Source

• Address1: string
  Title: Address 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  Fourth line of the physical address.
• AddressCode: string
  Maximum Length: 32

  Unique identifier for the parcel address.
• AddressId: integer (int64)
  The unique identifier for the address.
• AddressType: string
  Title: Address Type

  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)
  The unique identifier of the agency associated with the business location.
• AltPhoneAreaCode: string
  Maximum Length: 20

  Alternate phone area code.
• AltPhoneContactPointId: integer (int64)
  Unique identifier for the alternate phone contact.
• AltPhoneCountryCode: string
  Maximum Length: 10

  Alternate phone country code.
• AltPhoneExtension: string
  Maximum Length: 20

  Alternate phone extension number of the location.
• AltPhoneNumber: string
  Maximum Length: 40

  Alternate phone number of the location.
• AltPhoneType: string
  Maximum Length: 30

  Alternate phone type of the location.
• AltRawPhoneNumber: string
  Maximum Length: 60

  Alternate raw phone number of the location.
• AreaSize: integer (int64)
  Size of the business location.
• AreaSizeUom: string
  Maximum Length: 10

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

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

  The category for the business.
• BusDbaBusinessName: string
  Title: Doing Business As

  Maximum Length: 360

  The operating name of the business.
• BusDescription: string
  Title: Business Description

  Maximum Length: 2000

  Description of the business.
• BusinessEntityId: string
  Maximum Length: 50

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

  The unique identifier for the business location.
• BusinessLocationKey: integer (int64)
  System-generated unique identifier for a business location.
• BusinessLocationPartyId: integer (int64)
  The unique identifier for the party associated with the business location.
• BusStateTaxId: string
  Title: State Tax ID

  Maximum Length: 20

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

  The subcategory for the business.
• City: string
  Title: City

  Maximum Length: 60

  The location address city.
• CityTaxId: string
  Title: City Tax ID

  Maximum Length: 20

  The unique tax identifier issued to the business by the city.
• CoordinateX: number
  Geographic X-coordinate of the parcel address location.
• CoordinateY: number
  Geographic Y-coordinate of the parcel address location.
• Country: string
  Title: Country

  Maximum Length: 2

  The location address country.
• County: string
  Maximum Length: 60

  Physical address county.
• CreationDate: string (date-time)
  Read Only: true

  The date that the business location was created.
• CrossroadOne: string
  Maximum Length: 240

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

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

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

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

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

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

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

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

  Maximum Length: 150

  Last name of the secondary emergency contact.
• EcontactPhoneAreaCodeOne: string
  Title: Emergency Contact Phone Area Code 1

  Maximum Length: 20

  Primary emergency contact area code.
• EcontactPhoneAreaCodeTwo: string
  Title: Emergency Contact Phone Area Code 2

  Maximum Length: 20

  Secondary emergency contact area code.
• EcontactPhoneCountryOne: string
  Title: Emergency Contact Phone Country 1

  Maximum Length: 10

  Primary emergency contact country.
• EcontactPhoneCountryTwo: string
  Title: Emergency Contact Phone Country 2

  Maximum Length: 10

  Secondary emergency contact country code.
• EcontactPhoneExtensionOne: string
  Title: Emergency Contact Phone Extension 1

  Maximum Length: 20

  Primary emergency contact phone extension number of the location.
• EcontactPhoneExtensionTwo: string
  Title: Emergency Contact Phone Extension 2

  Maximum Length: 20

  Secondary emergency contact phone extension number of the location.
• EcontactPhoneNumberOne: string
  Title: Emergency Contact Phone Number 1

  Maximum Length: 40

  Primary emergency contact phone number of the location.
• EcontactPhoneNumberTwo: string
  Title: Emergency Contact Phone Number 2

  Maximum Length: 40

  Secondary emergency contact phone number of the location.
• EcontactPhoneTypeOne: string
  Title: Emergency Contact Phone Type 1

  Maximum Length: 30

  Phone type of the primary emergency contact for the location.
• EcontactPhoneTypeTwo: string
  Title: Emergency Contact Phone Type 2

  Maximum Length: 30

  Secondary emergency contact phone type of the location.
• EcontactRawPhoneNumberOne: string
  Maximum Length: 60

  Primary emergency contact raw phone number of the location.
• EcontactRawPhoneNumberTwo: string
  Maximum Length: 60

  Secondary emergency contact raw phone number of the location.
• EmailAddress: string
  Title: Email

  Maximum Length: 320

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

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

  The floor number of the physical address.
• InactiveReason: string
  Maximum Length: 1000

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

  Landmark for the parcel address.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date that the business location was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login identifier of the person who last updated the business location.
• Latitude: number
  Latitude of the location.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  The attribute used to identify the type of location.
• Longitude: number
  Longitude of the location.
• MailingAddress1: string
  Title: Mailing Address Line 1

  Maximum Length: 240

  First line of the location mailing address.
• MailingAddress2: string
  Title: Mailing Address Line 2

  Maximum Length: 240

  Third line of the location mailing address.
• MailingAddress3: string
  Maximum Length: 240

  Second line of the location mailing address.
• MailingAddress4: string
  Maximum Length: 240

  Fourth line of the location mailing address.
• MailingCity: string
  Title: Mailing City

  Maximum Length: 60

  Location mailing address city.
• MailingCountry: string
  Title: Mailing Country

  Maximum Length: 2

  Location mailing address country.
• MailingCounty: string
  Title: Mailing County

  Maximum Length: 60

  Location mailing address county.
• MailingPostalCode: string
  Title: Mailing Postal Code

  Maximum Length: 60

  Location mailing address postal code.
• MailingPostalPlusFourCode: string
  Maximum Length: 20

  Location mailing postal plus 4 code.
• MailingProvince: string
  Title: Mailing Province

  Maximum Length: 60

  Location mailing address province.
• MailingState: string
  Title: Mailing State

  Maximum Length: 60

  Location mailing address state.
• MobileBusFlag: string
  Title: Mobile Business

  Maximum Length: 1

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

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

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

  The parcel number.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  Physical address postal code.
• PostalPlus4Code: string
  Maximum Length: 20

  Physical address postal plus 4 code.
• PrimaryPhoneAreaCode: string
  Title: Primary Phone Area Code

  Maximum Length: 20

  Primary phone area code.
• PrimaryPhoneCountryCode: string
  Title: Primary Phone Country Code

  Maximum Length: 10

  Primary phone country code.
• PrimaryPhoneExtension: string
  Title: Primary Phone Extension

  Maximum Length: 20

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

  Maximum Length: 40

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

  Maximum Length: 30

  Primary phone type of the location.
• PrimaryRawPhoneNumber: string
  Maximum Length: 60

  Primary raw phone number of the location.
• PrimPhoneContactPointId: integer (int64)
  The unique identifier of the primary phone contact.
• Province: string
  Title: Province

  Maximum Length: 60

  Physical address province.
• RentalUnitNum: integer (int64)
  Number of rental units for the business location.
• SameMailAddressFlag: string
  Maximum Length: 1

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

  Business sellers permit number of the location.
• SellPerNumExp: string (date)
  Expiration date of the business sellers permit number associated with the location.
• StartDate: string (date)
  Title: Start Date

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

  Maximum Length: 60

  Physical address state.
• Status: string
  Maximum Length: 20

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

  The ID number issued to the business by the State Equalization Board.
• StreetDirection: string
  Maximum Length: 50

  Street direction of the location.
• StreetName: string
  Maximum Length: 240

  Street name used for parcel address searches.
• StreetNumber: string
  Maximum Length: 240

  Street number of the location.
• StreetSuffix: string
  Maximum Length: 20

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

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

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

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

  Website address of the location.
• WithinJurisdictionFlag: string
  Title: Within Jurisdiction

  Maximum Length: 1

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

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