Create a user
post
/fscmRestApi/resources/11.13.18.05/userRegistrations
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AddressFour: string
Title:
Address FourMaximum Length:240The fourth line for address. -
AddressOne: string
Title:
Address OneMaximum Length:240The first line for address. -
AddressThree: string
Title:
Address ThreeMaximum Length:240The third line for address. -
AddressTwo: string
Title:
Address TwoMaximum Length:240The second line for address. -
ApprovalStatusCode: string
Title:
Approval Status CodeMaximum Length:30The status code of the approval. -
Building: string
Title:
BuildingMaximum Length:240The building name or number at a given address. -
CartHeaderId: integer
(int64)
Title:
Cart Header IDThe unique identifier for the shopping cart header of the user. -
City: string
Title:
CityMaximum Length:60The city of the address. -
CountryCode: string
Title:
Country CodeMaximum Length:2The country code from the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
CountyMaximum Length:60The county of the address. -
DateOfBirth: string
(date)
Title:
Date of BirthThe date of birth of the user. -
EmailAddress: string
Title:
Email AddressMaximum Length:320The e-mail address of the user. -
FirstName: string
Title:
First NameMaximum Length:150The first name of the user. -
FloorNumber: string
Title:
Floor NumberMaximum Length:40The floor number at a given address or in a particular building when building number is provided. -
LastName: string
Title:
Last NameMaximum Length:150The last name of the user. -
MiddleName: string
Title:
Middle NameMaximum Length:60The middle name of the user. -
NameSuffix: string
Title:
Name SuffixMaximum Length:30The suffix can be junior or senior. -
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:20The area code within a country code. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10The international country code for a phone number. For example, 33 for France. -
PhoneNumber: string
Title:
Phone NumberMaximum Length:40The phone number formatted in the local format. The number should not include area code, country code, or extension. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the address. -
Province: string
Title:
ProvinceMaximum Length:60The province of the address. -
ProxyGroupId: integer
(int64)
Title:
Proxy Group IDThe unique identifier of the managed student group to which the user should be added after the user account is created. -
RelatedPersonEmailAddress: string
Title:
Related Person Email AddressMaximum Length:320The email address of the related person. -
RelatedPersonPartyId: integer
(int64)
Title:
Related Person Party IDThe party ID of the related person. -
RelationshipCode: string
Title:
Relationship CodeMaximum Length:30The code of the relationship. -
RelationshipTypeCode: string
Title:
Relationship TypeMaximum Length:30The type of the relationship. -
ShoppingCartPayload: string
(byte)
Title:
Shopping Cart PayloadThe shopping cart payload that the cloud application creates before user sign up. -
SingleNameFlag: boolean
Title:
Single NameMaximum Length:1Default Value:falseIndicates whether the user has single name. -
StateCode: string
Title:
State CodeMaximum Length:60The state code of the address. -
StorefrontId: integer
(int64)
Title:
Storefront IDThe unique identifier for the storefront of the user. -
Username: string
Title:
User NameMaximum Length:100The user name of the user.
Response
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 FourMaximum Length:240The fourth line for address. -
AddressOne: string
Title:
Address OneMaximum Length:240The first line for address. -
AddressThree: string
Title:
Address ThreeMaximum Length:240The third line for address. -
AddressTwo: string
Title:
Address TwoMaximum Length:240The second line for address. -
ApprovalStatusCode: string
Title:
Approval Status CodeMaximum Length:30The status code of the approval. -
Building: string
Title:
BuildingMaximum Length:240The building name or number at a given address. -
CartHeaderId: integer
(int64)
Title:
Cart Header IDThe unique identifier for the shopping cart header of the user. -
City: string
Title:
CityMaximum Length:60The city of the address. -
CountryCode: string
Title:
Country CodeMaximum Length:2The country code from the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
CountyMaximum Length:60The county of the address. -
DateOfBirth: string
(date)
Title:
Date of BirthThe date of birth of the user. -
EmailAddress: string
Title:
Email AddressMaximum Length:320The e-mail address of the user. -
FirstName: string
Title:
First NameMaximum Length:150The first name of the user. -
FloorNumber: string
Title:
Floor NumberMaximum Length:40The floor number at a given address or in a particular building when building number is provided. -
LastName: string
Title:
Last NameMaximum Length:150The last name of the user. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MiddleName: string
Title:
Middle NameMaximum Length:60The middle name of the user. -
NameSuffix: string
Title:
Name SuffixMaximum Length:30The suffix can be junior or senior. -
PartyId: integer
(int64)
Title:
Party IDRead Only:trueThe unique identifier for user. -
PhoneAreaCode: string
Title:
Phone Area CodeMaximum Length:20The area code within a country code. -
PhoneCountryCode: string
Title:
Phone Country CodeMaximum Length:10The international country code for a phone number. For example, 33 for France. -
PhoneNumber: string
Title:
Phone NumberMaximum Length:40The phone number formatted in the local format. The number should not include area code, country code, or extension. -
PostalCode: string
Title:
Postal CodeMaximum Length:60The postal code of the address. -
Province: string
Title:
ProvinceMaximum Length:60The province of the address. -
ProxyGroupId: integer
(int64)
Title:
Proxy Group IDThe unique identifier of the managed student group to which the user should be added after the user account is created. -
RegistrationId: integer
(int64)
Title:
User Registration IDRead Only:trueThe unique identifier for a user registration. -
RegistrationStatusCode: string
Title:
Registration Status CodeRead Only:trueThe current status of user registration. Accepted codes are REQUEST and COMPLETE. -
RelatedPersonEmailAddress: string
Title:
Related Person Email AddressMaximum Length:320The email address of the related person. -
RelatedPersonPartyId: integer
(int64)
Title:
Related Person Party IDThe party ID of the related person. -
RelationshipCode: string
Title:
Relationship CodeMaximum Length:30The code of the relationship. -
RelationshipTypeCode: string
Title:
Relationship TypeMaximum Length:30The type of the relationship. -
ShoppingCartPayload: string
(byte)
Title:
Shopping Cart PayloadThe shopping cart payload that the cloud application creates before user sign up. -
SingleNameFlag: boolean
Title:
Single NameMaximum Length:1Default Value:falseIndicates whether the user has single name. -
StateCode: string
Title:
State CodeMaximum Length:60The state code of the address. -
StorefrontId: integer
(int64)
Title:
Storefront IDThe unique identifier for the storefront of the user. -
Username: string
Title:
User NameMaximum Length:100The user name of the user.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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: Meaning
- finder:
- PhoneCountryCodeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: PhoneCountryCode; Target Attribute: PhoneCountryCode
- Display Attribute: PhoneCountryCode, TerritoryShortName