Get a public user profile
get
/fscmRestApi/resources/11.13.18.05/publicSectorSearchProfiles/{CurrProfileId}
Request
Path Parameters
-
CurrProfileId: integer
The unique identifier for a registered public user's current account profile.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorSearchProfiles-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The first address line. -
Address2(optional):
string
Maximum Length:
240
The second address line. -
Address3(optional):
string
Maximum Length:
240
The third address line. -
Address4(optional):
string
Maximum Length:
240
The fourth address line. -
AddressFull(optional):
string
Complete address information.
-
City(optional):
string
Maximum Length:
60
The address city. -
Country(optional):
string
Maximum Length:
3
The address country. -
County(optional):
string
Maximum Length:
60
The address county. -
CurrProfileId(optional):
integer(int64)
The unique identifier for a registered public user's current account profile.
-
EmailAddress(optional):
string
Maximum Length:
320
The email address. -
EmailContactPointId(optional):
integer(int64)
The unique identifier for the primary email for the profile.
-
links(optional):
array Items
Title:
Items
Link Relations -
OrganizationName(optional):
string
Maximum Length:
360
The business name. -
OrgPartyId(optional):
number
The party ID for the business that is associated with the business profile.
-
OrgPartyType(optional):
string
Maximum Length:
30
The party type for the business party. -
OrgPersonType(optional):
string
Maximum Length:
10
The type of person. The only valid value is Public for a public user. -
OrgProfileId(optional):
number
The unique identifier for a registered public user's business account profile.
-
OrgProfileType(optional):
string
Maximum Length:
20
The business profile type. The only valid value is Business for a business profile. -
PersonFirstName(optional):
string
Maximum Length:
150
The person's first name. -
PersonFullName(optional):
string
The person's full name.
-
PersonLastName(optional):
string
Maximum Length:
150
The person's last name. -
PersonMiddleName(optional):
string
Maximum Length:
60
The person's middle name. -
PersonNameSuffix(optional):
string
Maximum Length:
30
The person's name suffix, for example Jr. or II. -
PersonPartyId(optional):
integer(int64)
The party ID for the person associated with the personal profile.
-
PersonPartyType(optional):
string
Maximum Length:
30
The party type for the person party. -
PersonPreNameAdjunct(optional):
string
Maximum Length:
30
The salutation, for example Mr. or Mrs. used before the person's name. -
PersonProfileId(optional):
integer(int64)
The profile ID associated with the personal profile.
-
PersonProfileType(optional):
string
Maximum Length:
20
The personal profile type. The only valid value is Personal for a personal profile. -
PersonTitle(optional):
string
Maximum Length:
60
The person's title. -
PersonType(optional):
string
Maximum Length:
10
The type of person. The only valid value is Public for a public user. -
PhoneAreaCode(optional):
string
Maximum Length:
20
The phone area code. -
PhoneContactPointId(optional):
integer(int64)
The unique identifier for the primary phone number for the profile.
-
PhoneCountryCode(optional):
string
Maximum Length:
10
The phone country code. -
PhoneExtension(optional):
string
Maximum Length:
20
The phone extension. -
PhoneFull(optional):
string
Complete phone number.
-
PhoneLineType(optional):
string
Maximum Length:
30
The type of phone line, such as pager, fax or mobile. -
PhoneNumber(optional):
string
Maximum Length:
40
The phone number. -
PhoneType(optional):
string
Maximum Length:
30
The type of phone number, such as office or home. -
PostalCode(optional):
string
Maximum Length:
60
The address postal code. -
PostalPlus4Code(optional):
string
Maximum Length:
10
The address postal plus four code. -
Province(optional):
string
Maximum Length:
60
The address province. -
PscUserId(optional):
integer(int64)
The unique identifier for a registered public user.
-
RawPhoneNumber(optional):
string
Maximum Length:
60
The phone number without formatting. -
State(optional):
string
Maximum Length:
60
The address state. -
UniqueNameAlias(optional):
string
Maximum Length:
360
The unique name alias for the business.
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.