Jump to

• Request
• Response

Get all business locations

get

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationListDetails

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • simpleSearchFinder: Finds the business locations that matches the search criteria specified. Finder Variables:
    • value; string; The value used to search for business locations.
  • PrimaryKey: Finds the business locations that matches the primary key criteria specified. Finder Variables:
    • BusinessLocationId; string; The unique identifier for a business location.
    • BusinessLocationKey; integer; System generated unique identifier for a business location.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBusinessLocationListDetails

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorBusinessLocationListDetails-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorBusinessLocationListDetails-item

{
    "items":{
        "$ref":"#/definitions/publicSectorBusinessLocationListDetails-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorBusinessLocationListDetails-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  First line of the physical address.
• Address2(optional): string
  Maximum Length: 240

  Second line of the physical address.
• Address3(optional): string
  Maximum Length: 240

  Third line of the physical address.
• Address4(optional): string
  Maximum Length: 240

  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 parcel address.
• AddressLocId(optional): integer(int64)
  Unique identifier of the physical 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)
  Unique identifier of the agency.
• AltPhoneAreaCode(optional): string
  Maximum Length: 20

  Alternate phone area code.
• AltPhoneContactPointId(optional): integer(int64)
  Alternate phone contact point identifier.
• AltPhoneCountryCode(optional): string
  Maximum Length: 10

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

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

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

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

  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.
• Building(optional): string
  Maximum Length: 240

  Street number of the location.
• BuildingType(optional): string
  Maximum Length: 20

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

  Indicates the type of business.
• BusinessEntityId(optional): string
  Maximum Length: 50

  The unique identifier for a business entity.
• BusinessEntityKey(optional): integer(int64)
  System generated unique identifier for a business entity.
• BusinessLocationId(optional): string
  Maximum Length: 255

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

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

  Business subcategory.
• City(optional): string
  Maximum Length: 60

  Physical address city.
• CityTaxId(optional): string
  Maximum Length: 20

  City tax ID of the business location.
• 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
  Maximum Length: 2

  Physical address country.
• County(optional): string
  Maximum Length: 60

  Physical address county.
• 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.
• Description(optional): string
  Maximum Length: 2000

  Description 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
  Maximum Length: 20

  Primary emergency contact area code.
• EcontactPhoneAreaCodeTwo(optional): string
  Maximum Length: 20

  Secondary emergency contact area code.
• EcontactPhoneCountryOne(optional): string
  Maximum Length: 10

  Primary emergency contact country.
• EcontactPhoneCountryTwo(optional): string
  Maximum Length: 10

  Secondary emergency contact country code.
• EcontactPhoneExtensionOne(optional): string
  Maximum Length: 20

  Primary emergency contact phone extension number of the location.
• EcontactPhoneExtensionTwo(optional): string
  Maximum Length: 20

  Secondary emergency contact phone extension number of the location.
• EcontactPhoneNumberOne(optional): string
  Maximum Length: 40

  Primary emergency contact phone number of the location.
• EcontactPhoneNumberTwo(optional): string
  Maximum Length: 40

  Secondary emergency contact phone number of the location.
• EcontactPhoneTypeOne(optional): string
  Maximum Length: 30

  Phone type of the primary emergency contact for the location.
• EcontactPhoneTypeTwo(optional): string
  Maximum Length: 30

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

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

  Secondary emergency contact raw phone number of the location.
• EffectiveEndDate(optional): string(date)
  Effective end date of the location.
• EffectiveStartDate(optional): string(date)
  Effective start date of the location.
• EmailAddress(optional): string
  Maximum Length: 320

  Email address of the location.
• EmployeesTotal(optional): number
  Total number of employees for the business location.
• 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)
  Unique identifier of the primary emergency phone contact.
• ETwoPhoneContactPointId(optional): integer(int64)
  Unique identifier of the secondary emergency phone contact.
• FloorNumber(optional): string
  Maximum Length: 40

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

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

  Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe.
• Landmark(optional): string
  Maximum Length: 200

  Landmark for the parcel address.
• Latitude(optional): number
  Longitude of the location.
• LineOfBusiness(optional): string
  Maximum Length: 240

  Line of business.
• links(optional): array Items
  Title: Items

  Link Relations
• Longitude(optional): number
  Latitude of the location.
• MailAddress1(optional): string
  Maximum Length: 240

  First line of the location mailing address.
• MailAddress2(optional): string
  Maximum Length: 240

  Second line of the location mailing address.
• MailAddress3(optional): string
  Maximum Length: 240

  Third line of the location mailing address.
• MailAddress4(optional): string
  Maximum Length: 240

  Fourth line of the location mailing address.
• MailAddrsLocId(optional): integer(int64)
  Unique identifier of the mailing address for the business location.
• MailCity(optional): string
  Maximum Length: 60

  Location mailing city.
• MailCountry(optional): string
  Maximum Length: 2

  Location mailing country.
• MailCounty(optional): string
  Maximum Length: 60

  Location mailing county.
• MailPostalCode(optional): string
  Maximum Length: 60

  Location mailing postal code.
• MailPostalPlusCode(optional): string
  Maximum Length: 20

  Location mailing postal plus 4 code.
• MailProvince(optional): string
  Maximum Length: 60

  Location mailing province.
• MailState(optional): string
  Maximum Length: 60

  Location mailing state.
• MobileBusinessFlag(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.
• OrganizationName(optional): string
  Maximum Length: 360

  Doing business as name.
• OrgProfilesStatus(optional): string
  Maximum Length: 1

  Organization profile status.
• OtherTaxId(optional): string
  Maximum Length: 20

  County tax ID of the business location.
• ParcelId(optional): integer(int64)
  The unique identifier for the parcel.
• ParcelIdEntered(optional): string
  Maximum Length: 30

  The parcel number.
• Position(optional): string
  Maximum Length: 50

  Street direction of the location.
• PostalCode(optional): string
  Maximum Length: 60

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

  Physical address postal plus 4 code.
• PrimaryPhoneAreaCode(optional): string
  Maximum Length: 20

  Primary phone area code.
• PrimaryPhoneCountryCode(optional): string
  Maximum Length: 10

  Primary phone country code.
• PrimaryPhoneExtension(optional): string
  Maximum Length: 20

  Primary phone extension number of the location.
• PrimaryPhoneNumber(optional): string
  Maximum Length: 40

  Primary phone number of the location.
• PrimaryPhoneType(optional): string
  Maximum Length: 30

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

  Primary raw phone number of the location.
• PrimPhoneContactPointId(optional): integer(int64)
  Primary phone contact point identifier.
• Province(optional): string
  Maximum Length: 60

  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
  Maximum Length: 60

  Physical address state.
• Status(optional): string
  Maximum Length: 20

  Current status of the location.
• StatusMeaning(optional): string
  Maximum Length: 80

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

  State equalization board number of the business location.
• StreetName(optional): string
  Maximum Length: 240

  Street name used for parcel address searches.
• 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 agency jurisdiction.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the physical address."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the physical address."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the physical address."
        },
        "Address4":{
            "maxLength":240,
            "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 parcel address."
        },
        "AddressLocId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier of the physical 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":"Unique identifier of the agency."
        },
        "AltPhoneAreaCode":{
            "maxLength":20,
            "type":"string",
            "description":"Alternate phone area code."
        },
        "AltPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"Alternate phone contact point identifier."
        },
        "AltPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Alternate phone country code."
        },
        "AltPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Alternate phone extension number of the location."
        },
        "AltPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Alternate phone number of the location."
        },
        "AltPhoneType":{
            "maxLength":30,
            "type":"string",
            "description":"Alternate phone type of the location."
        },
        "AltRawPhoneNumber":{
            "maxLength":60,
            "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."
        },
        "Building":{
            "maxLength":240,
            "type":"string",
            "description":"Street number of the location."
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"Building type used for parcel address searches."
        },
        "BusCategory":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the type of business."
        },
        "BusStateTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"State tax ID of the business location."
        },
        "BusSubCategory":{
            "maxLength":50,
            "type":"string",
            "description":"Business subcategory."
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a business entity."
        },
        "BusinessEntityKey":{
            "format":"int64",
            "type":"integer",
            "description":"System generated unique identifier for a business entity."
        },
        "BusinessLocationId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for a business location."
        },
        "BusinessLocationKey":{
            "format":"int64",
            "type":"integer",
            "description":"System generated unique identifier for a business location."
        },
        "BusinessLocationPartyId":{
            "format":"int64",
            "type":"integer",
            "description":"Business location party ID."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address city."
        },
        "CityTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"City tax ID of the business location."
        },
        "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":{
            "maxLength":2,
            "type":"string",
            "description":"Physical address country."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address county."
        },
        "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."
        },
        "Description":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the business location."
        },
        "EOnePhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier of the primary emergency phone contact."
        },
        "ETwoPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier of the secondary emergency 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":{
            "maxLength":20,
            "type":"string",
            "description":"Primary emergency contact area code."
        },
        "EcontactPhoneAreaCodeTwo":{
            "maxLength":20,
            "type":"string",
            "description":"Secondary emergency contact area code."
        },
        "EcontactPhoneCountryOne":{
            "maxLength":10,
            "type":"string",
            "description":"Primary emergency contact country."
        },
        "EcontactPhoneCountryTwo":{
            "maxLength":10,
            "type":"string",
            "description":"Secondary emergency contact country code."
        },
        "EcontactPhoneExtensionOne":{
            "maxLength":20,
            "type":"string",
            "description":"Primary emergency contact phone extension number of the location."
        },
        "EcontactPhoneExtensionTwo":{
            "maxLength":20,
            "type":"string",
            "description":"Secondary emergency contact phone extension number of the location."
        },
        "EcontactPhoneNumberOne":{
            "maxLength":40,
            "type":"string",
            "description":"Primary emergency contact phone number of the location."
        },
        "EcontactPhoneNumberTwo":{
            "maxLength":40,
            "type":"string",
            "description":"Secondary emergency contact phone number of the location."
        },
        "EcontactPhoneTypeOne":{
            "maxLength":30,
            "type":"string",
            "description":"Phone type of the primary emergency contact for the location."
        },
        "EcontactPhoneTypeTwo":{
            "maxLength":30,
            "type":"string",
            "description":"Secondary emergency contact phone type of the location."
        },
        "EcontactRawPhoneNumberOne":{
            "maxLength":60,
            "type":"string",
            "description":"Primary emergency contact raw phone number of the location."
        },
        "EcontactRawPhoneNumberTwo":{
            "maxLength":60,
            "type":"string",
            "description":"Secondary emergency contact raw phone number of the location."
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"Effective end date of the location."
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"Effective start date of the location."
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"Email address of the location."
        },
        "EmployeesTotal":{
            "type":"number",
            "description":"Total number of employees for the business location."
        },
        "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."
        },
        "FloorNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The floor number of the physical address."
        },
        "InactiveReason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason that the business location was inactivated."
        },
        "JgzzFiscalCode":{
            "maxLength":20,
            "type":"string",
            "description":"Taxpayer identification number, often unique identifier of person or organization. Can be SSN or income taxpayer ID in US, fiscal code or NIF in Europe."
        },
        "Landmark":{
            "maxLength":200,
            "type":"string",
            "description":"Landmark for the parcel address."
        },
        "Latitude":{
            "type":"number",
            "description":"Longitude of the location."
        },
        "LineOfBusiness":{
            "maxLength":240,
            "type":"string",
            "description":"Line of business."
        },
        "Longitude":{
            "type":"number",
            "description":"Latitude of the location."
        },
        "MailAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"First line of the location mailing address."
        },
        "MailAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"Second line of the location mailing address."
        },
        "MailAddress3":{
            "maxLength":240,
            "type":"string",
            "description":"Third line of the location mailing address."
        },
        "MailAddress4":{
            "maxLength":240,
            "type":"string",
            "description":"Fourth line of the location mailing address."
        },
        "MailAddrsLocId":{
            "format":"int64",
            "type":"integer",
            "description":"Unique identifier of the mailing address for the business location."
        },
        "MailCity":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing city."
        },
        "MailCountry":{
            "maxLength":2,
            "type":"string",
            "description":"Location mailing country."
        },
        "MailCounty":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing county."
        },
        "MailPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing postal code."
        },
        "MailPostalPlusCode":{
            "maxLength":20,
            "type":"string",
            "description":"Location mailing postal plus 4 code."
        },
        "MailProvince":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing province."
        },
        "MailState":{
            "maxLength":60,
            "type":"string",
            "description":"Location mailing state."
        },
        "MobileBusinessFlag":{
            "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."
        },
        "OrgProfilesStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Organization profile status."
        },
        "OrganizationName":{
            "maxLength":360,
            "type":"string",
            "description":"Doing business as name."
        },
        "OtherTaxId":{
            "maxLength":20,
            "type":"string",
            "description":"County tax ID of the business location."
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel."
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The parcel number."
        },
        "Position":{
            "maxLength":50,
            "type":"string",
            "description":"Street direction of the location."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address postal code."
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"Physical address postal plus 4 code."
        },
        "PrimPhoneContactPointId":{
            "format":"int64",
            "type":"integer",
            "description":"Primary phone contact point identifier."
        },
        "PrimaryPhoneAreaCode":{
            "maxLength":20,
            "type":"string",
            "description":"Primary phone area code."
        },
        "PrimaryPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Primary phone country code."
        },
        "PrimaryPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"Primary phone extension number of the location."
        },
        "PrimaryPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"Primary phone number of the location."
        },
        "PrimaryPhoneType":{
            "maxLength":30,
            "type":"string",
            "description":"Primary phone type of the location."
        },
        "PrimaryRawPhoneNumber":{
            "maxLength":60,
            "type":"string",
            "description":"Primary raw phone number of the location."
        },
        "Province":{
            "maxLength":60,
            "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":"State equalization board number of the business location."
        },
        "StartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date of the business location."
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"Physical address state."
        },
        "Status":{
            "maxLength":20,
            "type":"string",
            "description":"Current status of the location."
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Current status meaning of the location."
        },
        "StreetName":{
            "maxLength":240,
            "type":"string",
            "description":"Street name used for parcel address searches."
        },
        "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 agency 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