Get all business locations
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessLocationLists
Request
Query Parameters
-
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 -
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:- PrimaryKey: Finds the business locations that match the primary key criteria specified.
Finder Variables:- BusinessLocationKey; integer; System generated unique identifier for a business location.
- simpleSearchFinder: Finds the business locations that match the search criteria specified.
Finder Variables:- value; string; The value used to search for business locations.
- PrimaryKey: Finds the business locations that match the primary key criteria specified.
-
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.
-
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 -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- Address; string; The complete physical address.
- Address1; string; First line of the physical address.
- Address2; string; Second line of the physical address.
- Address3; string; Third line of the physical address.
- Address4; string; Fourth line of the physical address.
- BusinessEntityId; string; The unique identifier for a business entity.
- BusinessEntityKey; integer; System generated unique identifier for a business entity.
- BusinessLicenses; number; Number of licenses associated with a location.
- BusinessLocationId; string; The unique identifier for a business location.
- BusinessLocationKey; integer; System generated unique identifier for a business location.
- City; string; Physical address city.
- Country; string; Physical address country.
- County; string; Physical address county.
- Description; string; Description of the business location.
- MailAddress; string; The complete mailing address.
- MailAddress1; string; First line of the location mailing address.
- MailAddress2; string; Second line of the location mailing address.
- MailAddress3; string; Third line of the location mailing address.
- MailAddress4; string; Fourth line of the location mailing address.
- MailCity; string; Location mailing city.
- MailCountry; string; Location mailing country.
- MailCounty; string; Location mailing county.
- MailPostalCode; string; Location mailing postal code.
- MailProvince; string; Location mailing province.
- MailState; string; Location mailing state.
- MobileBusinessFlag; string; Indicates whether the business is a mobile product or provides mobile service.
- OrganizationName; string; The doing business as name for a business entity.
- PostalCode; string; Physical address postal code.
- PostalPlus4Code; string; Physical address postal plus 4 code.
- Province; string; Physical address province.
- RenewCount; number; License renew count.
- State; string; Physical address state.
- Status; string; The current status of the location.
- StatusMeaning; string; The current status meaning of the location.
- WithinJurisdictionFlag; string; Indicates whether the business is located within the agency's jurisdiction.
-
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".
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 : publicSectorBusinessLocationLists
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessLocationLists-item-response
Type:
Show Source
object
-
Address: string
Title:
Address
Read Only:true
Maximum Length:1271
The complete physical address. -
Address1: string
Read Only:
true
Maximum Length:240
First line of the physical address. -
Address2: string
Read Only:
true
Maximum Length:240
Second line of the physical address. -
Address3: string
Read Only:
true
Maximum Length:240
Third line of the physical address. -
Address4: string
Read Only:
true
Maximum Length:240
Fourth line of the physical address. -
BusinessEntityId: string
Title:
Business
Read Only:true
Maximum Length:50
The unique identifier for a business entity. -
BusinessEntityKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business entity. -
BusinessLicenses: number
Title:
Business License Count
Read Only:true
Number of licenses associated with a location. -
BusinessLocationId: string
Title:
Location ID
Read Only:true
Maximum Length:255
The unique identifier for a business location. -
BusinessLocationKey: integer
(int64)
Read Only:
true
System generated unique identifier for a business location. -
City: string
Read Only:
true
Maximum Length:60
Physical address city. -
Country: string
Read Only:
true
Maximum Length:2
Physical address country. -
County: string
Read Only:
true
Maximum Length:60
Physical address county. -
Description: string
Title:
Description
Read Only:true
Maximum Length:2000
Description of the business location. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MailAddress: string
Read Only:
true
Maximum Length:4000
The complete mailing address. -
MailAddress1: string
Read Only:
true
Maximum Length:240
First line of the location mailing address. -
MailAddress2: string
Read Only:
true
Maximum Length:240
Second line of the location mailing address. -
MailAddress3: string
Read Only:
true
Maximum Length:240
Third line of the location mailing address. -
MailAddress4: string
Read Only:
true
Maximum Length:240
Fourth line of the location mailing address. -
MailCity: string
Read Only:
true
Maximum Length:60
Location mailing city. -
MailCountry: string
Read Only:
true
Maximum Length:2
Location mailing country. -
MailCounty: string
Read Only:
true
Maximum Length:60
Location mailing county. -
MailPostalCode: string
Read Only:
true
Maximum Length:60
Location mailing postal code. -
MailProvince: string
Read Only:
true
Maximum Length:60
Location mailing province. -
MailState: string
Read Only:
true
Maximum Length:60
Location mailing state. -
MobileBusinessFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the business is a mobile product or provides mobile service. -
OrganizationName: string
Title:
Doing Business As
Read Only:true
Maximum Length:360
The doing business as name for a business entity. -
PostalCode: string
Read Only:
true
Maximum Length:60
Physical address postal code. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:20
Physical address postal plus 4 code. -
Province: string
Read Only:
true
Maximum Length:60
Physical address province. -
RenewCount: number
Read Only:
true
License renew count. -
State: string
Read Only:
true
Maximum Length:60
Physical address state. -
Status: string
Read Only:
true
Maximum Length:20
The current status of the location. -
StatusMeaning: string
Read Only:
true
Maximum Length:80
The current status meaning of the location. -
WithinJurisdictionFlag: string
Title:
Within Jurisdiction
Read Only:true
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.