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

Get all self-service registration requests

get

/crmRestApi/resources/11.13.18.05/selfRegistrations

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a self-service registration request with the specified primary key.
      Finder Variables:
      • RegistrationId; integer; The unique identifier of the self-service registration request.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AccountKey; string; 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; The unique identifier of the account associated with the user submitting the self-service registration request.
    • AccountPartyName; string; The name of the account belonging to the user submitting the self-service registration request.
    • AccountPartyNumber; string; The number of the account belonging to the user submitting the self-service registration.
    • ApproveActionDate; string; The date when the self-service registration record was approved or rejected.
    • ApproverPartyId; string; The unique identifier of the user who approved or rejected the self-service registration record.
    • ApproverPartyName; string; The name of the user who approved or rejected the self-service registration record.
    • ContactPartyId; integer; The unique identifier of the contact record associated with the user submitting the self-service registration request.
    • ContactPartyNumber; string; The number of the user associated with Contact Party object.
    • CreatedBy; string; The unique identifier of the user submitting the self-service registration request.
    • CreationDate; string; The date when the record was first created.
    • DateOfBirth; string; The date of birth of the self-registering user.
    • EmailAddress; string; The email of the user submitting the self-service registration request.
    • HomePhoneAreaCode; string; The area code for the work phone number of the registering user.
    • HomePhoneCountryCode; string; The country code for the home phone number of the registering user.
    • HomePhoneNumber; string; The home phone number of the registering user.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the self-service registration record.
    • LoginId; string; The login ID of the person registering for a user account.
    • MobileAreaCode; string; The area code for the mobile number of the registering user.
    • MobileCountryCode; string; The country code for the mobile number of the registering user.
    • MobileNumber; string; The mobile number of the registering user.
    • Name; string; 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; The first name of the person registering for a user account.
    • PersonLastName; string; The last name of the person registering for a user account.
    • PrimaryAddressLine1; string; The first line for the primary address of the registering user.
    • PrimaryAddressLine2; string; The second line for the primary address of the registering user.
    • PrimaryAddressTypeCd; string; The type of primary address of the self-registering user. Examples include Bill To, Ship To, and so on.
    • PrimaryCity; string; The city for the primary address of the registering user.
    • PrimaryCountry; string; The country code for the primary address of the registering user.
    • PrimaryPostalCode; string; The postal code for the primary address of the registering user.
    • PrimaryProvince; string; The province for the primary address of the registering user.
    • PrimaryState; string; The state for the primary address of the registering user.
    • RawHomePhoneNumber; string; The unformatted home phone number of the registering user.
    • RawMobileNumber; string; The un-formatted home phone number of the registering user.
    • RawWorkPhoneNumber; string; The un-formatted work phone number of the registering user.
    • RegistrationId; integer; The unique identifier of the self-service registration request.
    • RequestTypeCd; string; 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; The first line of the street address in the secondary address of the self-registering user.
    • SecondaryAddressLine2; string; The second line of the street address in the secondary address of the self-registering user.
    • SecondaryAddressTypeCd; string; The type of secondary address of the self-registering user. Examples include Bill To, Ship To, and so on.
    • SecondaryCity; string; The city in the secondary address of the self-registering user.
    • SecondaryCountry; string; The country in the secondary address of the self-registering user.
    • SecondaryPostalCode; string; The postal code in the secondary address of the self-registering user.
    • SecondaryProvince; string; The province in the secondary address of the self-registering user.
    • SecondaryState; string; The state in the secondary address of the self-registering user.
    • StatusCd; string; 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; The reason for approving or rejecting a self-service registration request.
    • WorkPhoneAreaCode; string; The area code for the work phone number of the registering user.
    • WorkPhoneCountryCode; string; The country code for the work phone number of the registering user.
    • WorkPhoneExtension; string; The extension for the work phone number of the registering use.
    • WorkPhoneNumber; string; The work phone number of the registering user.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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.
Back to Top

Examples

Example of Request Header

The following shows an example of the request header.

GET 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 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.

{
  "items": [
    {
      "RegistrationId": 300100095843020,
      "AccountKey": "CSS ABCS Test 1",
      "AccountPartyId": 300100091492019,
      "ContactPartyId": -1,
      "CreatedBy": "FUSION",
      "CreationDate": "2017-03-06T00:49:41-08:00",
      "EmailAddress": "csstest.scn1_2579928792606602@oracle.com",
      "LastUpdateDate": "2017-03-06T00:50:05-08:00",
      "LastUpdateLogin": "4A059A679A350FE4E0530E8EF50A73F3",
      "LastUpdatedBy": "FUSION",
      "LoginId": "csstest.scn1_2579928792606602@oracle.com",
      "PersonFirstName": "Lena",
      "PersonLastName": "Loretta",
      "PersonMiddleName": null,
      "RegistrationTypeCd": null,
      "StatusCd": "ORA_CSS_PENDING",
      "StatusMsg": null,
      "ContactPartyName": "Lisa Pickford",
      "AccountPartyName": "CSS ABCS Test 1",
      "Name": "Lena Loretta",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095843020",
          "name": "selfRegistrations",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095843020",
          "name": "selfRegistrations",
          "kind": "item"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095843020/lov/StatusCDLookupVO",
          "name": "StatusCDLookupVO",
          "kind": "collection"
        },
        {
          "rel": "lov",
          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095843020/lov/RegistrationTypeLookupPVO",
          "name": "RegistrationTypeLookupPVO",
          "kind": "collection"
        }
      ]
},
{
      "RegistrationId": 300100095842994,
      "AccountKey": "CSS ABCS Test 1",
      "AccountPartyId": 300100091492019,
      "ContactPartyId": -1,
      "CreatedBy": "FUSION",
      "CreationDate": "2017-03-06T00:42:54-08:00",
      "EmailAddress": "csstest.scn1_2579519207088890@oracle.com",
      "LastUpdateDate": "2017-03-06T00:43:38-08:00",
      "LastUpdateLogin": "4A059A679A1D0FE4E0530E8EF50A73F3",
      "LastUpdatedBy": "FUSION"

. . .

}
. . .

}
}
Back to Top