Create a business location
post
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRegistrations/{BusinessEntityKey}/child/BusinessLocation
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
BusinessEntityKey: integer
System-generated identifier for a business entity.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorBusinessRegistrations-BusinessLocation-item
Type:
Show Source
object
-
AddressFour(optional):
string
Fourth line of the physical address.
-
AddressId(optional):
integer(int64)
The unique identifier for the address.
-
AddressOne(optional):
string
The first line of the location address.
-
AddressThree(optional):
string
Third line of the physical address.
-
AddressTwo(optional):
string
The second line of the location address.
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the business location.
-
AltPhoneAreaCode(optional):
string
Alternate phone area code.
-
AltPhoneContactPointId(optional):
integer(int64)
Unique identifier for the alternate phone contact.
-
AltPhoneCountryCode(optional):
string
Alternate phone country code.
-
AltPhoneExtension(optional):
string
Alternate phone extension number of the location.
-
AltPhoneNumber(optional):
string
Alternate phone number of the location.
-
AltPhoneRawPhoneNumber(optional):
string
Alternate raw phone number of the location.
-
AltPhoneType(optional):
string
Alternate phone type 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. -
BusCategory(optional):
string
Maximum Length:
50
The category for the business. -
BusDbaBusinessName(optional):
string
The operating name of the business.
-
BusDescription(optional):
string
The description of the business.
-
BusinessEntityId(optional):
string
Maximum Length:
50
The unique identifier for the business entity associated with the location. -
BusinessEntityKey(optional):
integer(int64)
System-generated identifier for a business entity.
-
BusinessLocationId(optional):
string
Maximum Length:
50
The unique identifier for the business location. -
BusinessLocationKey(optional):
integer(int64)
System-generated unique identifier for a business location.
-
BusinessLocationPartyId(optional):
integer(int64)
The unique identifier for the party associated with the business location.
-
BusStateTaxId(optional):
string
Maximum Length:
20
State tax ID of the business location. -
BusSubCategory(optional):
string
Maximum Length:
50
The subcategory for the business. -
City(optional):
string
The location address city.
-
CityTaxId(optional):
string
Maximum Length:
20
The unique tax identifier issued to the business by the city. -
Country(optional):
string
The location address country.
-
CreationDate(optional):
string(date-time)
The date that the business location was created.
-
CtyFoodSerLicExp(optional):
string(date)
Expiration date of the county food service license associated with the business location.
-
CtyFoodSerLicNum(optional):
string
Maximum Length:
30
County food service license number of the business location. -
EcontactAvailabilityOne(optional):
string
Maximum Length:
1000
Availability of the primary emergency contact. -
EcontactAvailabilityTwo(optional):
string
Maximum Length:
1000
Availability of the secondary emergency contact. -
EcontactEmailOne(optional):
string
Maximum Length:
320
Email address of the primary emergency contact. -
EcontactEmailTwo(optional):
string
Maximum Length:
320
Email address of the secondary emergency contact. -
EcontactFirstNameOne(optional):
string
Maximum Length:
150
First name of the primary emergency contact. -
EcontactFirstNameTwo(optional):
string
Maximum Length:
150
First name of the secondary emergency contact. -
EcontactLastNameOne(optional):
string
Maximum Length:
150
Last name of the primary emergency contact. -
EcontactLastNameTwo(optional):
string
Maximum Length:
150
Last name of the secondary emergency contact. -
EcontactPhoneAreaCodeone(optional):
string
Primary emergency contact area code.
-
EcontactPhoneAreaCodetwo(optional):
string
Secondary emergency contact area code.
-
EcontactPhoneCountryOne(optional):
string
Primary emergency contact country.
-
EcontactPhoneCountryTwo(optional):
string
Secondary emergency contact country code.
-
EContactPhoneExtensionOne(optional):
string
Primary emergency contact phone extension number of the location.
-
EcontactPhoneExtensionTwo(optional):
string
Secondary emergency contact phone extension number of the location.
-
EcontactPhoneNumberOne(optional):
string
Primary emergency contact phone number of the location.
-
EContactPhoneNumberTwo(optional):
string
Secondary emergency contact phone number of the location.
-
EcontactPhoneTypeOne(optional):
string
Phone type of the primary emergency contact for the location.
-
EContactPhoneTypetwo(optional):
string
Secondary emergency contact phone type of the location.
-
EcontactRawPhoneNumberOne(optional):
string
Primary emergency contact raw phone number of the location.
-
EcontactRawPhoneNumberTwo(optional):
string
Secondary emergency contact raw phone number of the location.
-
EmailAddress(optional):
string
Maximum Length:
320
Email address of the location. -
EmployeeTotal(optional):
integer(int32)
The total number of employees in the organization.
-
EnabledFlag(optional):
string
Maximum Length:
1
Indicates whether the business location has been enabled. -
EOnePhoneContactPointId(optional):
integer(int64)
The unique identifier for the primary phone contact.
-
ETwoPhoneContactPointId(optional):
integer(int64)
The unique identifier for the secondary phone contact.
-
Floor(optional):
string
The floor number of the physical address.
-
InactiveReason(optional):
string
Maximum Length:
1000
The reason that the business location was inactivated. -
LastUpdateDate(optional):
string(date-time)
The date that the business location was last updated.
-
LastUpdateLogin(optional):
string
Maximum Length:
32
The login identifier of the person who last updated the business location. -
Latitude(optional):
number
Latitude of the location.
-
links(optional):
array Items
Title:
Items
Link Relations -
Longitude(optional):
number
Longitude of the location.
-
MailingAddressOne(optional):
string
First line of the location mailing address.
-
MailingAddressThree(optional):
string
Second line of the location mailing address.
-
MailingAddressTwo(optional):
string
Third line of the location mailing address.
-
MailingCity(optional):
string
Location mailing address city.
-
MailingCountry(optional):
string
Location mailing address country.
-
MailingCounty(optional):
string
Location mailing address county.
-
MailingPostalCode(optional):
string
Location mailing address postal code.
-
MailingPostalPlusCode(optional):
string
Location mailing postal plus 4 code.
-
MailingProvince(optional):
string
Location mailing address province.
-
MailingState(optional):
string
Location mailing address state.
-
MobileBusinessFlag(optional):
string
Maximum Length:
1
Indicates whether the business is mobile and has no fixed business location. -
ObjectVersionNumber(optional):
integer(int32)
Workflow project revision number used to define the workflow.
-
OtherTaxId(optional):
string
Maximum Length:
20
The unique tax identifier issued to the business by the county. -
ParcelId(optional):
integer(int64)
The unique identifier for the parcel.
-
ParcelIdEntered(optional):
string
Maximum Length:
30
The parcel number. -
PostalCode(optional):
string
Physical address postal code.
-
PostalPlusCode(optional):
string
Physical address postal plus 4 code.
-
PrimaryPhoneAreaCode(optional):
string
Primary phone area code.
-
PrimaryPhoneCountryCode(optional):
string
Primary phone country code.
-
PrimaryPhoneExtension(optional):
string
Primary phone extension number of the location.
-
PrimaryPhoneNumber(optional):
string
Primary phone number of the location.
-
PrimaryPhoneType(optional):
string
Primary phone type of the location.
-
PrimaryRawPhoneNumber(optional):
string
Primary raw phone number of the location.
-
PrimPhoneContactPointId(optional):
integer(int64)
The unique identifier of the primary phone contact.
-
Province(optional):
string
Physical address province.
-
RentalUnitNum(optional):
integer(int64)
Number of rental units for the business location.
-
SameMailAddressFlag(optional):
string
Maximum Length:
1
Indicates whether the mailing address is same as mailing address. -
SellPerNum(optional):
string
Maximum Length:
30
Business sellers permit number of the location. -
SellPerNumExp(optional):
string(date)
Expiration date of the business sellers permit number associated with the location.
-
State(optional):
string
Physical address state.
-
Status(optional):
string
Maximum Length:
20
Current status of the location. -
StQualPerNum(optional):
string
Maximum Length:
30
The ID number issued to the business by the State Equalization Board. -
StreetDirection(optional):
string
Street direction of the location.
-
StreetNumber(optional):
string
Street number of the location.
-
TaxClass(optional):
string
Maximum Length:
30
Municipal tax class of the business location. -
Website(optional):
string
Maximum Length:
1000
Website address of the location. -
WithinJurisdictionFlag(optional):
string
Maximum Length:
1
Indicates whether the business is located within the agency's jurisdiction.
Nested Schema : link
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorBusinessRegistrations-BusinessLocation-item
Type:
Show Source
object
-
AddressFour(optional):
string
Fourth line of the physical address.
-
AddressId(optional):
integer(int64)
The unique identifier for the address.
-
AddressOne(optional):
string
The first line of the location address.
-
AddressThree(optional):
string
Third line of the physical address.
-
AddressTwo(optional):
string
The second line of the location address.
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the business location.
-
AltPhoneAreaCode(optional):
string
Alternate phone area code.
-
AltPhoneContactPointId(optional):
integer(int64)
Unique identifier for the alternate phone contact.
-
AltPhoneCountryCode(optional):
string
Alternate phone country code.
-
AltPhoneExtension(optional):
string
Alternate phone extension number of the location.
-
AltPhoneNumber(optional):
string
Alternate phone number of the location.
-
AltPhoneRawPhoneNumber(optional):
string
Alternate raw phone number of the location.
-
AltPhoneType(optional):
string
Alternate phone type 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. -
BusCategory(optional):
string
Maximum Length:
50
The category for the business. -
BusDbaBusinessName(optional):
string
The operating name of the business.
-
BusDescription(optional):
string
The description of the business.
-
BusinessEntityId(optional):
string
Maximum Length:
50
The unique identifier for the business entity associated with the location. -
BusinessEntityKey(optional):
integer(int64)
System-generated identifier for a business entity.
-
BusinessLocationId(optional):
string
Maximum Length:
50
The unique identifier for the business location. -
BusinessLocationKey(optional):
integer(int64)
System-generated unique identifier for a business location.
-
BusinessLocationPartyId(optional):
integer(int64)
The unique identifier for the party associated with the business location.
-
BusStateTaxId(optional):
string
Maximum Length:
20
State tax ID of the business location. -
BusSubCategory(optional):
string
Maximum Length:
50
The subcategory for the business. -
City(optional):
string
The location address city.
-
CityTaxId(optional):
string
Maximum Length:
20
The unique tax identifier issued to the business by the city. -
Country(optional):
string
The location address country.
-
CreationDate(optional):
string(date-time)
The date that the business location was created.
-
CtyFoodSerLicExp(optional):
string(date)
Expiration date of the county food service license associated with the business location.
-
CtyFoodSerLicNum(optional):
string
Maximum Length:
30
County food service license number of the business location. -
EcontactAvailabilityOne(optional):
string
Maximum Length:
1000
Availability of the primary emergency contact. -
EcontactAvailabilityTwo(optional):
string
Maximum Length:
1000
Availability of the secondary emergency contact. -
EcontactEmailOne(optional):
string
Maximum Length:
320
Email address of the primary emergency contact. -
EcontactEmailTwo(optional):
string
Maximum Length:
320
Email address of the secondary emergency contact. -
EcontactFirstNameOne(optional):
string
Maximum Length:
150
First name of the primary emergency contact. -
EcontactFirstNameTwo(optional):
string
Maximum Length:
150
First name of the secondary emergency contact. -
EcontactLastNameOne(optional):
string
Maximum Length:
150
Last name of the primary emergency contact. -
EcontactLastNameTwo(optional):
string
Maximum Length:
150
Last name of the secondary emergency contact. -
EcontactPhoneAreaCodeone(optional):
string
Primary emergency contact area code.
-
EcontactPhoneAreaCodetwo(optional):
string
Secondary emergency contact area code.
-
EcontactPhoneCountryOne(optional):
string
Primary emergency contact country.
-
EcontactPhoneCountryTwo(optional):
string
Secondary emergency contact country code.
-
EContactPhoneExtensionOne(optional):
string
Primary emergency contact phone extension number of the location.
-
EcontactPhoneExtensionTwo(optional):
string
Secondary emergency contact phone extension number of the location.
-
EcontactPhoneNumberOne(optional):
string
Primary emergency contact phone number of the location.
-
EContactPhoneNumberTwo(optional):
string
Secondary emergency contact phone number of the location.
-
EcontactPhoneTypeOne(optional):
string
Phone type of the primary emergency contact for the location.
-
EContactPhoneTypetwo(optional):
string
Secondary emergency contact phone type of the location.
-
EcontactRawPhoneNumberOne(optional):
string
Primary emergency contact raw phone number of the location.
-
EcontactRawPhoneNumberTwo(optional):
string
Secondary emergency contact raw phone number of the location.
-
EmailAddress(optional):
string
Maximum Length:
320
Email address of the location. -
EmployeeTotal(optional):
integer(int32)
The total number of employees in the organization.
-
EnabledFlag(optional):
string
Maximum Length:
1
Indicates whether the business location has been enabled. -
EOnePhoneContactPointId(optional):
integer(int64)
The unique identifier for the primary phone contact.
-
ETwoPhoneContactPointId(optional):
integer(int64)
The unique identifier for the secondary phone contact.
-
Floor(optional):
string
The floor number of the physical address.
-
InactiveReason(optional):
string
Maximum Length:
1000
The reason that the business location was inactivated. -
LastUpdateDate(optional):
string(date-time)
The date that the business location was last updated.
-
LastUpdateLogin(optional):
string
Maximum Length:
32
The login identifier of the person who last updated the business location. -
Latitude(optional):
number
Latitude of the location.
-
links(optional):
array Items
Title:
Items
Link Relations -
Longitude(optional):
number
Longitude of the location.
-
MailingAddressOne(optional):
string
First line of the location mailing address.
-
MailingAddressThree(optional):
string
Second line of the location mailing address.
-
MailingAddressTwo(optional):
string
Third line of the location mailing address.
-
MailingCity(optional):
string
Location mailing address city.
-
MailingCountry(optional):
string
Location mailing address country.
-
MailingCounty(optional):
string
Location mailing address county.
-
MailingPostalCode(optional):
string
Location mailing address postal code.
-
MailingPostalPlusCode(optional):
string
Location mailing postal plus 4 code.
-
MailingProvince(optional):
string
Location mailing address province.
-
MailingState(optional):
string
Location mailing address state.
-
MobileBusinessFlag(optional):
string
Maximum Length:
1
Indicates whether the business is mobile and has no fixed business location. -
ObjectVersionNumber(optional):
integer(int32)
Workflow project revision number used to define the workflow.
-
OtherTaxId(optional):
string
Maximum Length:
20
The unique tax identifier issued to the business by the county. -
ParcelId(optional):
integer(int64)
The unique identifier for the parcel.
-
ParcelIdEntered(optional):
string
Maximum Length:
30
The parcel number. -
PostalCode(optional):
string
Physical address postal code.
-
PostalPlusCode(optional):
string
Physical address postal plus 4 code.
-
PrimaryPhoneAreaCode(optional):
string
Primary phone area code.
-
PrimaryPhoneCountryCode(optional):
string
Primary phone country code.
-
PrimaryPhoneExtension(optional):
string
Primary phone extension number of the location.
-
PrimaryPhoneNumber(optional):
string
Primary phone number of the location.
-
PrimaryPhoneType(optional):
string
Primary phone type of the location.
-
PrimaryRawPhoneNumber(optional):
string
Primary raw phone number of the location.
-
PrimPhoneContactPointId(optional):
integer(int64)
The unique identifier of the primary phone contact.
-
Province(optional):
string
Physical address province.
-
RentalUnitNum(optional):
integer(int64)
Number of rental units for the business location.
-
SameMailAddressFlag(optional):
string
Maximum Length:
1
Indicates whether the mailing address is same as mailing address. -
SellPerNum(optional):
string
Maximum Length:
30
Business sellers permit number of the location. -
SellPerNumExp(optional):
string(date)
Expiration date of the business sellers permit number associated with the location.
-
State(optional):
string
Physical address state.
-
Status(optional):
string
Maximum Length:
20
Current status of the location. -
StQualPerNum(optional):
string
Maximum Length:
30
The ID number issued to the business by the State Equalization Board. -
StreetDirection(optional):
string
Street direction of the location.
-
StreetNumber(optional):
string
Street number of the location.
-
TaxClass(optional):
string
Maximum Length:
30
Municipal tax class of the business location. -
Website(optional):
string
Maximum Length:
1000
Website address of the location. -
WithinJurisdictionFlag(optional):
string
Maximum Length:
1
Indicates whether the business is located within the agency's jurisdiction.
Nested Schema : link
Type:
Show Source
object
-
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.