Get all business profiles of a registered public user
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessProfiles
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 profile that matches the primary key specified.
Finder Variables:- ProfileId; integer; The unique identifier of a registered public user's business profile.
- PrimaryKey: Finds the business profile that matches the primary key 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:- BusinessName; string; The business name for a registered public user account business profile.
- BusinessType; string; The business type for a registered public user account business profile.
- CntrctrVerificationStatus; string; The verification status of a registered public user's standing as a contractor.
- IsContractor; string; Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no.
- JobTitle; string; The person's job title.
- ProfileId; integer; The unique identifier for a registered public user account profile.
- ProfileName; string; The registered public user account profile name.
- ProfileStatus; string; The profile status. Valid values are A for active and I for inactive.
- PscUserId; integer; The unique identifier for a registered public user reference row.
-
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 : publicSectorBusinessProfiles
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 : publicSectorBusinessProfiles-item-response
Type:
Show Source
object
-
BusinessName: string
Maximum Length:
60
The business name for a registered public user account business profile. -
BusinessType: string
Maximum Length:
30
The business type for a registered public user account business profile. -
CntrctrVerificationStatus: string
Maximum Length:
2
The verification status of a registered public user's standing as a contractor. -
IsContractor: string
Maximum Length:
1
Default Value:N
Indicates whether a profile has a contractor status. Valid values are Y for yes and N for no. -
JobTitle: string
Maximum Length:
60
The person's job title. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileContactPointEmail: array
Profile Emails
Title:
Profile Emails
The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile. -
ProfileContactPointPhone: array
Profile Phones
Title:
Profile Phones
The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile. -
ProfileId: integer
(int64)
The unique identifier for a registered public user account profile.
-
ProfileLocation: array
Profile Locations
Title:
Profile Locations
The profile locations resource is used to view, create, or modify addresses for a registered public user account profile. -
ProfileName: string
Maximum Length:
60
The registered public user account profile name. -
ProfileStatus: string
Maximum Length:
1
Default Value:A
The profile status. Valid values are A for active and I for inactive. -
PscUserId: integer
(int64)
The unique identifier for a registered public user reference row.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Profile Emails
Type:
array
Title:
Profile Emails
The profile emails resource is used to view, create, or modify email contact points for a registered public user account profile.
Show Source
Nested Schema : Profile Phones
Type:
array
Title:
Profile Phones
The profile phones resource is used to view, create, or modify phone contact points for a registered public user account profile.
Show Source
Nested Schema : Profile Locations
Type:
array
Title:
Profile Locations
The profile locations resource is used to view, create, or modify addresses for a registered public user account profile.
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.
Nested Schema : publicSectorBusinessProfiles-ProfileContactPointEmail-item-response
Type:
Show Source
object
-
ContactPointPurpose: string
Title:
Type
The email type. Valid values are BUSINESS for work and PERSONAL for home. -
ContactPtId: integer
(int64)
The unique identifier for the email contact point.
-
EmailAddress: string
Title:
Email
The email address for the email contact point. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates whether an email is the primary email for the profile. Valid values are Y for yes and N for no. -
ProfileId: integer
(int64)
The unique identifier for the profile that is associated with the email contact point.
-
Status: string
The status of the email contact point. Valid values are A for active and I for inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessProfiles-ProfileContactPointPhone-item-response
Type:
Show Source
object
-
ContactPointPurpose: string
Title:
Type
The phone type. Valid values are BUSINESS for work and PERSONAL for home. -
ContactPtId: integer
(int64)
The unique identifier for the phone contact point.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneAreaCode: string
The phone area code.
-
PhoneCountryCode: string
The phone country code.
-
PhoneExtension: string
The phone extension.
-
PhoneFull: string
Read Only:
true
The full formatted phone number. -
PhoneNumber: string
The phone number.
-
PhoneType: string
Title:
Type
The phone type. Valid values are WORK, HOME, and MOBILE. -
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates whether a phone is the primary phone for the profile. Valid values are Y for yes and N for no. -
ProfileId: integer
(int64)
The unique identifier for the profile that is associated with the phone contact point.
-
Status: string
The status of the phone contact point. Valid values are A for active and I for inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorBusinessProfiles-ProfileLocation-item-response
Type:
Show Source
object
-
Address1: string
The first line of the address.
-
Address2: string
The second line of the address.
-
Address3: string
The third line of the address.
-
Address4: string
The fourth line of the address.
-
AddressFull: string
Read Only:
true
The full address for a profile address. -
City: string
The city of the address.
-
Country: string
The country of the address.
-
County: string
The county of the address.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationSiteId: integer
(int64)
The unique identifier for a profile address.
-
OnlineFlag: string
Maximum Length:
1
Indicates whether this location has a website. Valid values are Y for yes and N for no. -
PostalCode: string
The postal code of the address.
-
PrimaryFlag: string
Title:
Primary
Maximum Length:1
Indicates whether an address is the primary address for the profile. Valid values are Y for yes and N for no. -
ProfileId: integer
(int64)
The unique identifier for the profile that is associated with the address.
-
SiteUseType: string
Title:
Type
The address type. Valid values are BUSINESS for business and HOME for home. -
State: string
The state for the address.
-
Status: string
The status of the address. Valid values are A for active and I for inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source