Get a business location
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation/{BusinessLocationKey}
Request
Path Parameters
-
BusinessEntityKey(required): integer(int64)
System-generated identifier for a business entity.
-
BusinessLocationKey(required): integer(int64)
System-generated unique identifier for a business location.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorBusinessRegistrations-BusinessLocation-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.