1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Self-Service Registrations

Create a self-service registration request

post

/crmRestApi/resources/11.13.18.05/selfRegistrations

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Account Key
    Maximum Length: 320
    The account key is used to locate the account of the user submitting the self-service registration request, and the default value of the account key is the value of OrganizationName. The value can be changed using the profile option SVC_CSS_ACCT_KEY_FIELD.
  • Title: Account ID
    The unique identifier of the account associated with the user submitting the self-service registration request.
  • Title: Contact ID
    The unique identifier of the contact record associated with the user submitting the self-service registration request.
  • Title: Date of Birth
    The date of birth of the self-registering user.
  • Title: Email
    Maximum Length: 320
    The email of the user submitting the self-service registration request.
  • Title: Home Phone Area Code
    Maximum Length: 20
    The area code for the work phone number of the registering user.
  • Title: Home Phone Country Code
    Maximum Length: 10
    The country code for the home phone number of the registering user.
  • Title: Home Phone Number
    Maximum Length: 40
    The home phone number of the registering user.
  • Title: Login ID
    Maximum Length: 320
    The login ID of the person registering for a user account.
  • Title: Mobile Area Code
    Maximum Length: 20
    The area code for the mobile number of the registering user.
  • Title: Mobile Country Code
    Maximum Length: 10
    The country code for the mobile number of the registering user.
  • Title: Mobile Number
    Maximum Length: 40
    The mobile number of the registering user.
  • Title: Name
    Maximum Length: 360
    The name of the person registering for a user account. The value is the concatenation of first name, middle name, and the last name of the user.
  • Title: First Name
    Maximum Length: 150
    The first name of the person registering for a user account.
  • Title: Last Name
    Maximum Length: 150
    The last name of the person registering for a user account.
  • Title: Middle Name
    Maximum Length: 60
    The middle name of the person registering for a user account.
  • Title: Primary Address Line 1
    Maximum Length: 240
    The first line for the primary address of the registering user.
  • Title: Primary Address Line 2
    Maximum Length: 240
    The second line for the primary address of the registering user.
  • Title: Primary Address Type
    Maximum Length: 30
    The type of primary address of the self-registering user. Examples include Bill To, Ship To, and so on.
  • Title: Primary City
    Maximum Length: 60
    The city for the primary address of the registering user.
  • Title: Primary Country
    Maximum Length: 2
    The country code for the primary address of the registering user.
  • Title: Primary Postal Code
    Maximum Length: 60
    The postal code for the primary address of the registering user.
  • Title: Primary Province
    Maximum Length: 60
    The province for the primary address of the registering user.
  • Title: Primary State
    Maximum Length: 60
    The state for the primary address of the registering user.
  • Title: Unformatted Home Phone Number
    Maximum Length: 60
    The unformatted home phone number of the registering user.
  • Title: Unformatted Mobile Number
    Maximum Length: 60
    The un-formatted home phone number of the registering user.
  • Title: Unformatted Work Phone Number
    Maximum Length: 60
    The un-formatted work phone number of the registering user.
  • Title: Request Type
    Maximum Length: 30
    The code indicating the type of self-service registration. A list of accepted values is defined in the lookup ORA_SVC_CSS_REQ_TYPE_CD.
  • Title: Secondary Address Line 1
    Maximum Length: 240
    The first line of the street address in the secondary address of the self-registering user.
  • Title: Secondary Address Line 2
    Maximum Length: 240
    The second line of the street address in the secondary address of the self-registering user.
  • Title: Secondary Address Type
    Maximum Length: 30
    The type of secondary address of the self-registering user. Examples include Bill To, Ship To, and so on.
  • Title: Secondary City
    Maximum Length: 60
    The city in the secondary address of the self-registering user.
  • Title: Secondary Country
    Maximum Length: 2
    The country in the secondary address of the self-registering user.
  • Title: Secondary Postal Code
    Maximum Length: 60
    The postal code in the secondary address of the self-registering user.
  • Title: Secondary Province
    Maximum Length: 60
    The province in the secondary address of the self-registering user.
  • Title: Secondary State
    Maximum Length: 60
    The state in the secondary address of the self-registering user.
  • Title: Status
    Maximum Length: 30
    The code indicating the status of the self-service registration request. A list of accepted values is defined in the lookup ORA_SVC_CSS_REG_STATUS_CD.
  • Title: Reason
    Maximum Length: 800
    The reason for approving or rejecting a self-service registration request.
  • Title: Work Phone Area Code
    Maximum Length: 20
    The area code for the work phone number of the registering user.
  • Title: Work Phone Country Code
    Maximum Length: 10
    The country code for the work phone number of the registering user.
  • Title: Work Phone Extension
    Maximum Length: 20
    The extension for the work phone number of the registering use.
  • Title: Work Phone Number
    Maximum Length: 40
    The work phone number of the registering user.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : selfRegistrations-item-response
Type: object
Show Source
  • Title: Account Key
    Maximum Length: 320
    The account key is used to locate the account of the user submitting the self-service registration request, and the default value of the account key is the value of OrganizationName. The value can be changed using the profile option SVC_CSS_ACCT_KEY_FIELD.
  • Title: Account ID
    The unique identifier of the account associated with the user submitting the self-service registration request.
  • Title: Account Name
    Read Only: true
    Maximum Length: 360
    The name of the account belonging to the user submitting the self-service registration request.
  • Title: Account Party Number
    Read Only: true
    Maximum Length: 30
    The number of the account belonging to the user submitting the self-service registration.
  • Title: Status Change Date
    Read Only: true
    The date when the self-service registration record was approved or rejected.
  • Title: Approver ID
    Read Only: true
    The unique identifier of the user who approved or rejected the self-service registration record.
  • Title: Approver
    Read Only: true
    Maximum Length: 360
    The name of the user who approved or rejected the self-service registration record.
  • Title: Contact ID
    The unique identifier of the contact record associated with the user submitting the self-service registration request.
  • Title: Contact Name
    Read Only: true
    Maximum Length: 360
    The name of the user associated with the Contact Party object.
  • Title: Contact Party Number
    Read Only: true
    Maximum Length: 30
    The number of the user associated with Contact Party object.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The unique identifier of the user submitting the self-service registration request.
  • Title: Creation Date
    Read Only: true
    The date when the record was first created.
  • Title: Date of Birth
    The date of birth of the self-registering user.
  • Title: Can Delete
    Read Only: true
    Default Value: false
    Indicates if a self-service registration record can be deleted.
  • Title: Email
    Maximum Length: 320
    The email of the user submitting the self-service registration request.
  • Title: Home Phone Area Code
    Maximum Length: 20
    The area code for the work phone number of the registering user.
  • Title: Home Phone Country Code
    Maximum Length: 10
    The country code for the home phone number of the registering user.
  • Title: Home Phone Number
    Maximum Length: 40
    The home phone number of the registering user.
  • Title: Last Updated Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the self-service registration record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the self-service registration record.
  • Links
  • Title: Login ID
    Maximum Length: 320
    The login ID of the person registering for a user account.
  • Title: Mobile Area Code
    Maximum Length: 20
    The area code for the mobile number of the registering user.
  • Title: Mobile Country Code
    Maximum Length: 10
    The country code for the mobile number of the registering user.
  • Title: Mobile Number
    Maximum Length: 40
    The mobile number of the registering user.
  • Title: Name
    Maximum Length: 360
    The name of the person registering for a user account. The value is the concatenation of first name, middle name, and the last name of the user.
  • Title: First Name
    Maximum Length: 150
    The first name of the person registering for a user account.
  • Title: Last Name
    Maximum Length: 150
    The last name of the person registering for a user account.
  • Title: Middle Name
    Maximum Length: 60
    The middle name of the person registering for a user account.
  • Title: Primary Address Line 1
    Maximum Length: 240
    The first line for the primary address of the registering user.
  • Title: Primary Address Line 2
    Maximum Length: 240
    The second line for the primary address of the registering user.
  • Title: Primary Address Type
    Maximum Length: 30
    The type of primary address of the self-registering user. Examples include Bill To, Ship To, and so on.
  • Title: Primary City
    Maximum Length: 60
    The city for the primary address of the registering user.
  • Title: Primary Country
    Maximum Length: 2
    The country code for the primary address of the registering user.
  • Title: Primary Postal Code
    Maximum Length: 60
    The postal code for the primary address of the registering user.
  • Title: Primary Province
    Maximum Length: 60
    The province for the primary address of the registering user.
  • Title: Primary State
    Maximum Length: 60
    The state for the primary address of the registering user.
  • Title: Unformatted Home Phone Number
    Maximum Length: 60
    The unformatted home phone number of the registering user.
  • Title: Unformatted Mobile Number
    Maximum Length: 60
    The un-formatted home phone number of the registering user.
  • Title: Unformatted Work Phone Number
    Maximum Length: 60
    The un-formatted work phone number of the registering user.
  • Title: Registration ID
    Read Only: true
    The unique identifier of the self-service registration request.
  • Title: Request Type
    Maximum Length: 30
    The code indicating the type of self-service registration. A list of accepted values is defined in the lookup ORA_SVC_CSS_REQ_TYPE_CD.
  • Title: Secondary Address Line 1
    Maximum Length: 240
    The first line of the street address in the secondary address of the self-registering user.
  • Title: Secondary Address Line 2
    Maximum Length: 240
    The second line of the street address in the secondary address of the self-registering user.
  • Title: Secondary Address Type
    Maximum Length: 30
    The type of secondary address of the self-registering user. Examples include Bill To, Ship To, and so on.
  • Title: Secondary City
    Maximum Length: 60
    The city in the secondary address of the self-registering user.
  • Title: Secondary Country
    Maximum Length: 2
    The country in the secondary address of the self-registering user.
  • Title: Secondary Postal Code
    Maximum Length: 60
    The postal code in the secondary address of the self-registering user.
  • Title: Secondary Province
    Maximum Length: 60
    The province in the secondary address of the self-registering user.
  • Title: Secondary State
    Maximum Length: 60
    The state in the secondary address of the self-registering user.
  • Title: Status
    Maximum Length: 30
    The code indicating the status of the self-service registration request. A list of accepted values is defined in the lookup ORA_SVC_CSS_REG_STATUS_CD.
  • Title: Status Value
    Read Only: true
    Maximum Length: 80
    The user friendly meaning of the status of the self-service registration request.
  • Title: Reason
    Maximum Length: 800
    The reason for approving or rejecting a self-service registration request.
  • Title: Can Update
    Read Only: true
    Indicates if a self-service registration record can be updated. The default value is false.
  • Title: Work Phone Area Code
    Maximum Length: 20
    The area code for the work phone number of the registering user.
  • Title: Work Phone Country Code
    Maximum Length: 10
    The country code for the work phone number of the registering user.
  • Title: Work Phone Extension
    Maximum Length: 20
    The extension for the work phone number of the registering use.
  • Title: Work Phone Number
    Maximum Length: 40
    The work phone number of the registering user.
Links
RequestTypeCdLookupLOVVO
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CSS_REQ_TYPE_CD
The list of values indicating the type of self-service registration request. The lookup type is ORA_SVC_CSS_REQ_TYPE_CD.

The following properties are defined on the LOV link relation:
  • Source Attribute: RequestTypeCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
StatusCDLookupVO
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CSS_REG_STATUS_CD
The list of values indicating the status self-service registration request, such as Pending, Approved, or Rejected. The lookup type is ORA_SVC_CSS_REG_STATUS_CD.

The following properties are defined on the LOV link relation:
  • Source Attribute: StatusCd; Target Attribute: LookupCode
  • Display Attribute: Meaning
Back to Top

Examples

Example of Request Header

The following shows an example of the request header.

POST  crmRestApi/resources/11.13.18.05/selfRegistrations HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "AccountKey": "Pinnacle Account",
  "EmailAddress": "pinnacle.account@oracle.com",
  "LoginId": "Pinnacle",
  "PersonFirstName": "Debra",
  "PersonLastName": "Kim",
  "PersonMiddleName": null
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "RegistrationId": 300100095855333,
  "AccountKey": "Pinnacle Account",
  "AccountPartyId": 300100091492019,
  "ContactPartyId": 300100095857524,
  "CreatedBy": "FUSION",
  "CreationDate": "2017-03-06T18:44:59-08:00",
  "EmailAddress": "csstest.scn1_3196500861526535@oracle.com",
  "LastUpdateDate": "2017-03-07T02:42:56-08:00",
  "LastUpdateLogin": "4A217430FE441110E0530E8EF50AC384",
  "LastUpdatedBy": "css_dev_user@oracle.com",
  "LoginId": "csstest.scn1_3196500861526535@oracle.com",
  "PersonFirstName": "Debra",
  "PersonLastName": "Kim",
  "PersonMiddleName": null,
  "RegistrationTypeCd": null,
  "StatusCd": "ORA_CSS_APPROVED",
  "StatusMsg": "Congrats",
  "ContactPartyName": "Lisa Pickford",
  "AccountPartyName": "CSS ABCS Test 1",
  "Name": "Debra Kim",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333",
      "name": "selfRegistrations",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333",
      "name": "selfRegistrations",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333/lov/StatusCDLookupVO",
      "name": "StatusCDLookupVO",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333/lov/RegistrationTypeLookupPVO",
      "name": "RegistrationTypeLookupPVO",
      "kind": "collection"
    }
  ]
}
Back to Top