Get a user's reference data
get
/fscmRestApi/resources/11.13.18.05/publicSectorUserRefs/{PscUserId}
Request
Path Parameters
-
PscUserId: integer
Unique identifier for the registered user reference row.
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 : publicSectorUserRefs-item
Type:
Show Source
object
-
Address1(optional):
string
First line of the registered user's address.
-
Address2(optional):
string
Second line of the registered user's address.
-
Address3(optional):
string
Third line of the registered user's address.
-
Address4(optional):
string
Fourth line of the registered user's address.
-
BusinessName(optional):
string
Business name for the registered user's business profile.
-
City(optional):
string
City for the registered user's address.
-
Country(optional):
string
Country for the registered user's address.
-
County(optional):
string
County for the registered user's address.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the row. -
CreateUser(optional):
string
Indicates whether a registered user profile needs to be created.
-
CreationDate(optional):
string(date-time)
The date and time of the creation of the row.
-
DefaultProfile(optional):
integer(int64)
The registered user's profile that is used by default when the user signs in.
-
FirstName(optional):
string
First name of the registered user.
-
IsContractor(optional):
string
Indicates whether the registered user is a contractor.
-
IsContractorVerified(optional):
string
Indicates whether the registered user's contractor status needs to be verified.
-
IsLicenseVerified(optional):
string
Indicates whether the license of the contractor needs to be verified.
-
IsSensitiveFlagVerified(optional):
string
Indicates whether the registered user's status as a member of law enforcement or a judicial agency needs to be verified.
-
LastName(optional):
string
Last name of the registered user.
-
LastUpdateDate(optional):
string(date-time)
The date and time when the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the row. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated to the user who last updated the user row. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Version number for the registered user details.
-
PartyId(optional):
integer(int64)
Party ID for the registered user.
-
PhoneAreaCode(optional):
string
Phone area code for the registered user.
-
PhoneCountryCode(optional):
string
Phone country code for the registered user.
-
PhoneExtension(optional):
string
Phone extension for the registered user.
-
PhoneNumber(optional):
string
Phone number for the registered user.
-
PostalCode(optional):
string
Postal code of the registered user address.
-
PostalPlus4Code(optional):
string
Four digit extension to the postal code.
-
PreferredContactMethod(optional):
string
Preferred contact method for the registered user.
-
ProfileType(optional):
string
Profile type for the registered user, such as personal or business.
-
Province(optional):
string
Province for the address for the registered user.
-
PscUserId(optional):
integer(int64)
Unique identifier for the registered user reference row.
-
ReferenceExpireDate(optional):
string
Expiration date for the registered user's contractor license.
-
ReferenceId(optional):
string
License ID for the registered user's contractor license.
-
ReferenceStartDate(optional):
string
Issue date for the registered user's contractor license.
-
ReferenceType(optional):
string
License type for the registered user's contractor license.
-
Salutation(optional):
string
Salutation for the registered user.
-
SensitiveFlag(optional):
string
Indicates whether the registered user's contact information should be hidden from public view.
-
State(optional):
string
State for the registered user address.
-
TermsUseAcceptDate(optional):
string(date)
Date when the registered user accepted the terms of use.
-
TermsUseAcceptedBy(optional):
string
Maximum Length:
64
User who accepted the terms of use. -
TermsUseId(optional):
string
Maximum Length:
15
Terms of use ID accepted by the user. -
TermsUsePersonType(optional):
string
Maximum Length:
10
Indicates whether the terms of use were accepted by the registered user or by agency staff on behalf of the registered user. -
UserEmailId(optional):
string
Email address of the registered user.
-
UserName(optional):
string
User name of the registered user.
-
ValidationLastActionBy(optional):
string
Maximum Length:
64
User who last validated the registered user's status. -
ValidationLastActionDate(optional):
string(date-time)
Date that the registered user's validation status was last updated.
-
ValidationStatus(optional):
string
Maximum Length:
2
The current validation status for the registered user's status.
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.