Update a user registration request
patch
/fscmRestApi/resources/11.13.18.05/userRegistrations/{RegistrationId}
Request
Path Parameters
-
RegistrationId(required): integer(int64)
The unique identifier for a user registration.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ApprovalStatusCode: string
Maximum Length:
30
The status code of the approval.
Response
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 : userRegistrations-item-response
Type:
Show Source
object
-
AddressFour: string
Maximum Length:
240
The fourth line for address. -
AddressOne: string
Maximum Length:
240
The first line for address. -
AddressThree: string
Maximum Length:
240
The third line for address. -
AddressTwo: string
Maximum Length:
240
The second line for address. -
ApprovalStatusCode: string
Maximum Length:
30
The status code of the approval. -
Building: string
Maximum Length:
240
The building name or number at a given address. -
CartHeaderId: integer
(int64)
The unique identifier for the shopping cart header of the user.
-
City: string
Maximum Length:
60
The city of the address. -
CountryCode: string
Maximum Length:
2
The country code from the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Maximum Length:
60
The county of the address. -
DateOfBirth: string
(date)
The date of birth of the user.
-
EmailAddress: string
Maximum Length:
320
The e-mail address of the user. -
FirstName: string
Maximum Length:
150
The first name of the user. -
FloorNumber: string
Maximum Length:
40
The floor number at a given address or in a particular building when building number is provided. -
LastName: string
Maximum Length:
150
The last name of the user. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the user. -
NameSuffix: string
Maximum Length:
30
The suffix can be junior or senior. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier for user. -
PhoneAreaCode: string
Maximum Length:
20
The area code within a country code. -
PhoneCountryCode: string
Maximum Length:
10
The international country code for a telephone number. For example, 33 for France. -
PhoneNumber: string
Maximum Length:
40
The telephone number formatted in the local format. The number should not include area code, country code, or extension. -
PostalCode: string
Maximum Length:
60
The postal code of the address. -
Province: string
Maximum Length:
60
The province of the address. -
RegistrationId: integer
(int64)
Read Only:
true
The unique identifier for a user registration. -
RegistrationStatusCode: string
Read Only:
true
The current status of user registration. Accepted codes are REQUEST and COMPLETE. -
RelatedPersonEmailAddress: string
Maximum Length:
320
The email address of the related person. -
RelatedPersonPartyId: integer
(int64)
The party ID of the related person.
-
RelationshipCode: string
Maximum Length:
30
The code of the relationship. -
RelationshipTypeCode: string
Maximum Length:
30
The type of the relationship. -
ShoppingCartPayload: string
(byte)
The shopping cart payload that the cloud application creates before user sign up.
-
SingleNameFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the user has single name. -
StateCode: string
Maximum Length:
60
The state code of the address. -
StorefrontId: integer
(int64)
The unique identifier for the storefront of the user.
-
Username: string
Maximum Length:
100
The user name of the user.
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.
Links
- ApprovalStatusCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_PROXY_MBR_APV_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: ApprovalStatusCode; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- PhoneCountryCodeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName