Update a user's reference data
patch
/fscmRestApi/resources/11.13.18.05/publicSectorUserRefs/{PscUserId}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
PscUserId: integer
Unique identifier for the registered user reference row.
The following table describes the body parameters in the request 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.
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.