Jump to

• Request
• Response
• Examples

Get a self-service registration request

get

/crmRestApi/resources/11.13.18.05/selfRegistrations/{RegistrationId}

Request

Path Parameters

• RegistrationId(required): integer(int64)
  The unique identifier of the self-service registration request.

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: string
  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: string
  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

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

Body ()

Root Schema : selfRegistrations-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AccountKey":{
            "title":"Account Key",
            "maxLength":320,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountPartyId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account associated with the user submitting the self-service registration request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountPartyName":{
            "title":"Account Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the account belonging to the user submitting the self-service registration request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPartyNumber":{
            "title":"Account Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the account belonging to the user submitting the self-service registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApproveActionDate":{
            "title":"Status Change Date",
            "type":"string",
            "description":"The date when the self-service registration record was approved or rejected.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApproverPartyId":{
            "title":"Approver ID",
            "type":"string",
            "description":"The unique identifier of the user who approved or rejected the self-service registration record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApproverPartyName":{
            "title":"Approver",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user who approved or rejected the self-service registration record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact record associated with the user submitting the self-service registration request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the user associated with the Contact Party object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The number of the user associated with Contact Party object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the user submitting the self-service registration request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was first created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirth":{
            "title":"Date of Birth",
            "type":"string",
            "description":"The date of birth of the self-registering user.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if a self-service registration record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email of the user submitting the self-service registration request.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneAreaCode":{
            "title":"Home Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountryCode":{
            "title":"Home Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the home phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneNumber":{
            "title":"Home Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the self-service registration record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the self-service registration record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoginId":{
            "title":"Login ID",
            "maxLength":320,
            "type":"string",
            "description":"The login ID of the person registering for a user account.",
            "nullable":true,
            "x-queryable":true
        },
        "MobileAreaCode":{
            "title":"Mobile Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the mobile number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "MobileCountryCode":{
            "title":"Mobile Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the mobile number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "MobileNumber":{
            "title":"Mobile Number",
            "maxLength":40,
            "type":"string",
            "description":"The mobile number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person registering for a user account.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person registering for a user account.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the person registering for a user account.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryAddressLine1":{
            "title":"Primary Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryAddressLine2":{
            "title":"Primary Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryAddressTypeCd":{
            "title":"Primary Address Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of primary address of the self-registering user. Examples include Bill To, Ship To, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryCity":{
            "title":"Primary City",
            "maxLength":60,
            "type":"string",
            "description":"The city for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryCountry":{
            "title":"Primary Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code for the primary address of the registering user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryPostalCode":{
            "title":"Primary Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryProvince":{
            "title":"Primary Province",
            "maxLength":60,
            "type":"string",
            "description":"The province for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryState":{
            "title":"Primary State",
            "maxLength":60,
            "type":"string",
            "description":"The state for the primary address of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "RawHomePhoneNumber":{
            "title":"Unformatted Home Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The unformatted home phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "RawMobileNumber":{
            "title":"Unformatted Mobile Number",
            "maxLength":60,
            "type":"string",
            "description":"The un-formatted home phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "RawWorkPhoneNumber":{
            "title":"Unformatted Work Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The un-formatted work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "RegistrationId":{
            "title":"Registration ID",
            "type":"integer",
            "description":"The unique identifier of the self-service registration request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestTypeCd":{
            "title":"Request Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "SecondaryAddressLine1":{
            "title":"Secondary Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the street address in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryAddressLine2":{
            "title":"Secondary Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the street address in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryAddressTypeCd":{
            "title":"Secondary Address Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of secondary address of the self-registering user. Examples include Bill To, Ship To, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecondaryCity":{
            "title":"Secondary City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryCountry":{
            "title":"Secondary Country",
            "maxLength":2,
            "type":"string",
            "description":"The country in the secondary address of the self-registering user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SecondaryPostalCode":{
            "title":"Secondary Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryProvince":{
            "title":"Secondary Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryState":{
            "title":"Secondary State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the secondary address of the self-registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":80,
            "type":"string",
            "description":"The user friendly meaning of the status of the self-service registration request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StatusMsg":{
            "title":"Reason",
            "maxLength":800,
            "type":"string",
            "description":"The reason for approving or rejecting a self-service registration request.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if a self-service registration record can be updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            }
        },
        "WorkPhoneAreaCode":{
            "title":"Work Phone Area Code",
            "maxLength":20,
            "type":"string",
            "description":"The area code for the work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountryCode":{
            "title":"Work Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneExtension":{
            "title":"Work Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The extension for the work phone number of the registering use.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNumber":{
            "title":"Work Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the registering user.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

RequestTypeCdLookupLOVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

GET crmRestApi/resources/11.13.18.05/selfRegistrations/300100095827408 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.

{
  "RegistrationId": 300100095827408,
  "AccountKey": "CSS ABCS Test 3",
  "AccountPartyId": 300100091629006,
  "ContactPartyId": -1,
  "CreatedBy": "DCSTest.Appid",
  "CreationDate": "2017-03-03T13:17:11-08:00",
  "EmailAddress": "[e-mail]",
  "LastUpdateDate": "2017-03-03T13:17:13-08:00",
  "LastUpdateLogin": "49D3ACC2CB1A5257E0530E8EF50A38CE",
  "LastUpdatedBy": "DCSTest.Appid",
  "LoginId": "[e-mail]",
  "PersonFirstName": "LastNameTest",
  "PersonLastName": "Sonny-Guy",
  "PersonMiddleName": null,
  "RegistrationTypeCd": null,
  "StatusCd": "ORA_CSS_PENDING",
  "StatusMsg": null,
  "ContactPartyName": "Lisa Pickford",
  "AccountPartyName": "CSS ABCS Test 3",
  "Name": "LastNameTest Sonny-Guy",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095827408",
      "name": "selfRegistrations",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095827408",
      "name": "selfRegistrations",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095827408/lov/StatusCDLookupVO",
      "name": "StatusCDLookupVO",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/selfRegistrations/300100095827408/lov/RegistrationTypeLookupPVO",
      "name": "RegistrationTypeLookupPVO",
      "kind": "collection"
    }
  ]
}

Back to Top