Update a self-service registration request
patch
/crmRestApi/resources/11.13.18.05/selfRegistrations/{RegistrationId}
Request
Path Parameters
-
RegistrationId(required): integer(int64)
The unique identifier of the self-service registration 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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account associated with the user submitting the self-service registration request. -
Name: string
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. -
StatusCd: string
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. -
StatusMsg: string
Title:
Reason
Maximum Length:800
The reason for approving or rejecting a self-service registration request.
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 : selfRegistrations-item-response
Type:
Show Source
object
-
AccountKey: string
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. -
AccountPartyId: integer
(int64)
Title:
Account ID
The unique identifier of the account associated with the user submitting the self-service registration request. -
AccountPartyName: string
Title:
Account Name
Read Only:true
Maximum Length:360
The name of the account belonging to the user submitting the self-service registration request. -
AccountPartyNumber: string
Title:
Account Party Number
Read Only:true
Maximum Length:30
The number of the account belonging to the user submitting the self-service registration. -
ApproveActionDate: string
(date-time)
Title:
Status Change Date
Read Only:true
The date when the self-service registration record was approved or rejected. -
ApproverPartyId: string
Title:
Approver ID
Read Only:true
The unique identifier of the user who approved or rejected the self-service registration record. -
ApproverPartyName: string
Title:
Approver
Read Only:true
Maximum Length:360
The name of the user who approved or rejected the self-service registration record. -
ContactPartyId: integer
(int64)
Title:
Contact ID
The unique identifier of the contact record associated with the user submitting the self-service registration request. -
ContactPartyName: string
Title:
Contact Name
Read Only:true
Maximum Length:360
The name of the user associated with the Contact Party object. -
ContactPartyNumber: string
Title:
Contact Party Number
Read Only:true
Maximum Length:30
The number of the user associated with Contact Party object. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The unique identifier of the user submitting the self-service registration request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was first created. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date of birth of the self-registering user. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Default Value:false
Indicates if a self-service registration record can be deleted. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email of the user submitting the self-service registration request. -
HomePhoneAreaCode: string
Title:
Home Phone Area Code
Maximum Length:20
The area code for the work phone number of the registering user. -
HomePhoneCountryCode: string
Title:
Home Phone Country Code
Maximum Length:10
The country code for the home phone number of the registering user. -
HomePhoneNumber: string
Title:
Home Phone Number
Maximum Length:40
The home phone number of the registering user. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the self-service registration record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the self-service registration record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoginId: string
Title:
Login ID
Maximum Length:320
The login ID of the person registering for a user account. -
MobileAreaCode: string
Title:
Mobile Area Code
Maximum Length:20
The area code for the mobile number of the registering user. -
MobileCountryCode: string
Title:
Mobile Country Code
Maximum Length:10
The country code for the mobile number of the registering user. -
MobileNumber: string
Title:
Mobile Number
Maximum Length:40
The mobile number of the registering user. -
Name: string
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. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The first name of the person registering for a user account. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The last name of the person registering for a user account. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person registering for a user account. -
PrimaryAddressLine1: string
Title:
Primary Address Line 1
Maximum Length:240
The first line for the primary address of the registering user. -
PrimaryAddressLine2: string
Title:
Primary Address Line 2
Maximum Length:240
The second line for the primary address of the registering user. -
PrimaryAddressTypeCd: string
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. -
PrimaryCity: string
Title:
Primary City
Maximum Length:60
The city for the primary address of the registering user. -
PrimaryCountry: string
Title:
Primary Country
Maximum Length:2
The country code for the primary address of the registering user. -
PrimaryPostalCode: string
Title:
Primary Postal Code
Maximum Length:60
The postal code for the primary address of the registering user. -
PrimaryProvince: string
Title:
Primary Province
Maximum Length:60
The province for the primary address of the registering user. -
PrimaryState: string
Title:
Primary State
Maximum Length:60
The state for the primary address of the registering user. -
RawHomePhoneNumber: string
Title:
Unformatted Home Phone Number
Maximum Length:60
The unformatted home phone number of the registering user. -
RawMobileNumber: string
Title:
Unformatted Mobile Number
Maximum Length:60
The un-formatted home phone number of the registering user. -
RawWorkPhoneNumber: string
Title:
Unformatted Work Phone Number
Maximum Length:60
The un-formatted work phone number of the registering user. -
RegistrationId: integer
(int64)
Title:
Registration ID
Read Only:true
The unique identifier of the self-service registration request. -
RequestTypeCd: string
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. -
SecondaryAddressLine1: string
Title:
Secondary Address Line 1
Maximum Length:240
The first line of the street address in the secondary address of the self-registering user. -
SecondaryAddressLine2: string
Title:
Secondary Address Line 2
Maximum Length:240
The second line of the street address in the secondary address of the self-registering user. -
SecondaryAddressTypeCd: string
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. -
SecondaryCity: string
Title:
Secondary City
Maximum Length:60
The city in the secondary address of the self-registering user. -
SecondaryCountry: string
Title:
Secondary Country
Maximum Length:2
The country in the secondary address of the self-registering user. -
SecondaryPostalCode: string
Title:
Secondary Postal Code
Maximum Length:60
The postal code in the secondary address of the self-registering user. -
SecondaryProvince: string
Title:
Secondary Province
Maximum Length:60
The province in the secondary address of the self-registering user. -
SecondaryState: string
Title:
Secondary State
Maximum Length:60
The state in the secondary address of the self-registering user. -
StatusCd: string
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. -
StatusCdMeaning: string
Title:
Status Value
Read Only:true
Maximum Length:80
The user friendly meaning of the status of the self-service registration request. -
StatusMsg: string
Title:
Reason
Maximum Length:800
The reason for approving or rejecting a self-service registration request. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if a self-service registration record can be updated. The default value is false. -
WorkPhoneAreaCode: string
Title:
Work Phone Area Code
Maximum Length:20
The area code for the work phone number of the registering user. -
WorkPhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
The country code for the work phone number of the registering user. -
WorkPhoneExtension: string
Title:
Work Phone Extension
Maximum Length:20
The extension for the work phone number of the registering use. -
WorkPhoneNumber: string
Title:
Work Phone Number
Maximum Length:40
The work phone number of the registering 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
- 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
- finder:
- 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
- finder:
Examples
Example of Request Header
The following shows an example of the request header.
PATCH crmRestApi/resources/11.13.18.05/selfRegistrations/300100095855333 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.
{ "StatusCd": "ORA_CSS_APPROVED", "StatusMsg": "Congrats" }
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": "CSS ABCS Test 1", "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" } ] }