Get a registered user
get
/fscmRestApi/resources/11.13.18.05/userRegistrations/{RegistrationId}
Request
Path Parameters
-
RegistrationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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:
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.
Root Schema : userRegistrations-item-response
Type:
Show Source
object
-
AddressFour: string
Title:
Address Four
Maximum Length:240
The fourth line for address. -
AddressOne: string
Title:
Address One
Maximum Length:240
The first line for address. -
AddressThree: string
Title:
Address Three
Maximum Length:240
The third line for address. -
AddressTwo: string
Title:
Address Two
Maximum Length:240
The second line for address. -
ApprovalStatusCode: string
Title:
Approval Status Code
Maximum Length:30
The status code of the approval. -
Building: string
Title:
Building
Maximum Length:240
The building name or number at a given address. -
CartHeaderId: integer
(int64)
Title:
Cart Header ID
The unique identifier for the shopping cart header of the user. -
City: string
Title:
City
Maximum Length:60
The city of the address. -
CountryCode: string
Title:
Country Code
Maximum Length:2
The country code from the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date of birth of the user. -
EmailAddress: string
Title:
Email Address
Maximum Length:320
The e-mail address of the user. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the user. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
The floor number at a given address or in a particular building when building number is provided. -
LastName: string
Title:
Last Name
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
Title:
Name Suffix
Maximum Length:30
The suffix can be junior or senior. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier for user. -
PhoneAreaCode: string
Title:
Phone Area Code
Maximum Length:20
The area code within a country code. -
PhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a phone number. For example, 33 for France. -
PhoneNumber: string
Title:
Phone Number
Maximum Length:40
The phone number formatted in the local format. The number should not include area code, country code, or extension. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
RegistrationId: integer
(int64)
Title:
User Registration ID
Read Only:true
The unique identifier for a user registration. -
RegistrationStatusCode: string
Title:
Registration Status Code
Read Only:true
The current status of user registration. Accepted codes are REQUEST and COMPLETE. -
RelatedPersonEmailAddress: string
Title:
Related Person Email Address
Maximum Length:320
The email address of the related person. -
RelatedPersonPartyId: integer
(int64)
Title:
Related Person Party ID
The party ID of the related person. -
RelationshipCode: string
Title:
Relationship Code
Maximum Length:30
The code of the relationship. -
RelationshipTypeCode: string
Title:
Relationship Type
Maximum Length:30
The type of the relationship. -
ShoppingCartPayload: string
(byte)
Title:
Shopping Cart Payload
The shopping cart payload that the cloud application creates before user sign up. -
SingleNameFlag: boolean
Title:
Single Name
Maximum Length:1
Default Value:false
Indicates whether the user has single name. -
StateCode: string
Title:
State Code
Maximum Length:60
The state code of the address. -
StorefrontId: integer
(int64)
Title:
Storefront ID
The unique identifier for the storefront of the user. -
Username: string
Title:
User Name
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