Get all profiles for a public user
get
/fscmRestApi/resources/11.13.18.05/publicSectorSearchProfiles
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 public user profile that matches the primary key specified.
Finder Variables:- CurrProfileId; integer; The unique identifier for a registered public user's current account profile.
- RowFinder: Finds the public user profile that matches the specified filter values.
Finder Variables:- value; string; The filter values to be applied when finding a public user profile.
- PrimaryKey: Finds the public user 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:- Address1; string; The first address line.
- Address2; string; The second address line.
- Address3; string; The third address line.
- Address4; string; The fourth address line.
- AddressFull; string; Complete address information.
- City; string; The address city.
- Country; string; The address country.
- County; string; The address county.
- CurrProfileId; integer; The unique identifier for a registered public user's current account profile.
- EmailAddress; string; The email address.
- EmailContactPointId; integer; The unique identifier for the primary email for the profile.
- IsContractor; string; Indicates whether a profile has contractor status. Valid values are Y for yes and N for no.
- JobTitle; string; The person's job title.
- OrgPartyId; number; The party ID for the business that is associated with the business profile.
- OrgPartyType; string; The party type for the business party.
- OrgPersonType; string; The type of person. The only valid value is Public for a public user.
- OrgProfileId; number; The unique identifier for a registered public user's business account profile.
- OrgProfileType; string; The business profile type. The only valid value is Business for a business profile.
- OrganizationName; string; The business name.
- PersonFirstName; string; The person's first name.
- PersonFullName; string; The person's full name.
- PersonLastName; string; The person's last name.
- PersonMiddleName; string; The person's middle name.
- PersonNameSuffix; string; The person's name suffix, for example Jr. or II.
- PersonPartyId; integer; The party ID for the person associated with the personal profile.
- PersonPartyType; string; The party type for the person party.
- PersonPreNameAdjunct; string; The salutation, for example Mr. or Mrs. used before the person's name.
- PersonProfileId; integer; The profile ID associated with the personal profile.
- PersonProfileType; string; The personal profile type. The only valid value is Personal for a personal profile.
- PersonTitle; string; The person's title.
- PersonType; string; The type of person. The only valid value is Public for a public user.
- PhoneAreaCode; string; The phone area code.
- PhoneContactPointId; integer; The unique identifier for the primary phone number for the profile.
- PhoneCountryCode; string; The phone country code.
- PhoneExtension; string; The phone extension.
- PhoneFull; string; Complete phone number.
- PhoneLineType; string; The type of phone line, such as pager, fax or mobile.
- PhoneNumber; string; The phone number.
- PhoneType; string; The type of phone number, such as office or home.
- PostalCode; string; The address postal code.
- PostalPlus4Code; string; The address postal plus four code.
- Province; string; The address province.
- PscUserId; integer; The unique identifier for a registered public user.
- RawPhoneNumber; string; The phone number without formatting.
- State; string; The address state.
- UniqueNameAlias; string; The unique name alias for the business.
-
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 : publicSectorSearchProfiles
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 : publicSectorSearchProfiles-item-response
Type:
Show Source
object
-
Address1: string
Read Only:
true
Maximum Length:240
The first address line. -
Address2: string
Read Only:
true
Maximum Length:240
The second address line. -
Address3: string
Read Only:
true
Maximum Length:240
The third address line. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth address line. -
AddressFull: string
Complete address information.
-
City: string
Read Only:
true
Maximum Length:60
The address city. -
Country: string
Read Only:
true
Maximum Length:3
The address country. -
County: string
Read Only:
true
Maximum Length:60
The address county. -
CurrProfileId: integer
(int64)
Read Only:
true
The unique identifier for a registered public user's current account profile. -
EmailAddress: string
Read Only:
true
Maximum Length:320
The email address. -
EmailContactPointId: integer
(int64)
Read Only:
true
The unique identifier for the primary email for the profile. -
IsContractor: string
Read Only:
true
Maximum Length:1
Indicates whether a profile has contractor status. Valid values are Y for yes and N for no. -
JobTitle: string
Read Only:
true
Maximum Length:60
The person's job title. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Read Only:
true
Maximum Length:360
The business name. -
OrgPartyId: number
Read Only:
true
The party ID for the business that is associated with the business profile. -
OrgPartyType: string
Read Only:
true
Maximum Length:30
The party type for the business party. -
OrgPersonType: string
Read Only:
true
Maximum Length:10
The type of person. The only valid value is Public for a public user. -
OrgProfileId: number
Read Only:
true
The unique identifier for a registered public user's business account profile. -
OrgProfileType: string
Read Only:
true
Maximum Length:20
The business profile type. The only valid value is Business for a business profile. -
PersonFirstName: string
Read Only:
true
Maximum Length:150
The person's first name. -
PersonFullName: string
Read Only:
true
Maximum Length:900
The person's full name. -
PersonLastName: string
Read Only:
true
Maximum Length:150
The person's last name. -
PersonMiddleName: string
Read Only:
true
Maximum Length:60
The person's middle name. -
PersonNameSuffix: string
Read Only:
true
Maximum Length:30
The person's name suffix, for example Jr. or II. -
PersonPartyId: integer
(int64)
Read Only:
true
The party ID for the person associated with the personal profile. -
PersonPartyType: string
Read Only:
true
Maximum Length:30
The party type for the person party. -
PersonPreNameAdjunct: string
Read Only:
true
Maximum Length:30
The salutation, for example Mr. or Mrs. used before the person's name. -
PersonProfileId: integer
(int64)
Read Only:
true
The profile ID associated with the personal profile. -
PersonProfileType: string
Read Only:
true
Maximum Length:20
The personal profile type. The only valid value is Personal for a personal profile. -
PersonTitle: string
Read Only:
true
Maximum Length:60
The person's title. -
PersonType: string
Read Only:
true
Maximum Length:10
The type of person. The only valid value is Public for a public user. -
PhoneAreaCode: string
Read Only:
true
Maximum Length:20
The phone area code. -
PhoneContactPointId: integer
(int64)
Read Only:
true
The unique identifier for the primary phone number for the profile. -
PhoneCountryCode: string
Read Only:
true
Maximum Length:10
The phone country code. -
PhoneExtension: string
Read Only:
true
Maximum Length:20
The phone extension. -
PhoneFull: string
Complete phone number.
-
PhoneLineType: string
Read Only:
true
Maximum Length:30
The type of phone line, such as pager, fax or mobile. -
PhoneNumber: string
Read Only:
true
Maximum Length:40
The phone number. -
PhoneType: string
Read Only:
true
Maximum Length:30
The type of phone number, such as office or home. -
PostalCode: string
Read Only:
true
Maximum Length:60
The address postal code. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
The address postal plus four code. -
Province: string
Read Only:
true
Maximum Length:60
The address province. -
PscUserId: integer
(int64)
Read Only:
true
The unique identifier for a registered public user. -
RawPhoneNumber: string
Read Only:
true
Maximum Length:60
The phone number without formatting. -
State: string
Read Only:
true
Maximum Length:60
The address state. -
UniqueNameAlias: string
Read Only:
true
Maximum Length:360
The unique name alias for the business.
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.