Company and User Registration
Service to register a company and its users. Users can belong to partner or B2B companies, or could be B2C users in the future.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/crmSelfService/common/customer/publicModel/registration/}RegistrationService
Service WSDL URL: https://servername/crmService/RegistrationService?WSDL
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
Relationship Type | Object or Service |
---|---|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
Trading Community Organization Contact Additional Information |
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
Trading Community Original System Mapping Identifier Additional Information |
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
|
Handles |
Trading Community Organization Profile Additional Information |
Handles |
|
Handles |
|
Handles |
Operations
isUserNameAvailable
Checks the availability of a username. This operation takes username as a parameter and returns a boolean value indicating whether the username is duplicate.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
userName |
string |
The username that needs to be validated for existence in the enterprise. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
string |
If the return value is true, then the username already exists in the enterprise. |
createPartnerCompanyAndAdministrator
Creates partner company and admin records. This operation takes organization party, person party, location and partner profile objects as parameters and returns the party id of newly created partner company.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
organizationParty |
Trading Community Organization Details |
Organization SDO containing organization details of the registering partner company. |
personParty |
Trading Community Person Details |
Person SDO containing administrator details who is registering the partner company. |
location |
Location Details |
Location SDO containing address of the registering partner company. |
partnerProfile |
Partner |
Partner SDO containing partner specific information of the registering partner company. |
userLanguage |
string |
The string containing language information for the method createPartnerCompanyAndAdministrator. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
long |
The Organization PARTY_ID created for the registering partner company is returned. |
createPartnerWithUserProvisioning
Creates partner company and admin records along with user provisioning. This operation takes organization party, person party, location and partner profile objects as parameters and returns the party id of newly created partner company.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
organizationParty |
Trading Community Organization Details |
Organization SDO containing organization details of the registering partner company. |
personParty |
Trading Community Person Details |
Person SDO containing administrator details who is registering the partner company. |
location |
Location Details |
Location SDO containing address of the registering partner company. |
partnerProfile |
Partner |
Partner SDO containing partner specific information of the registering partner company. |
userLanguage |
string |
The string containing language information for the method createPartnerWithUserProvisioning. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
long |
The Organization PARTY_ID created for the registering partner company is returned. |
getDfltObjAttrHints
Retrieves user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.
Life Cycle Status: Active
Request Payload
Element Name | Type | Description |
---|---|---|
viewName |
string |
The service displays an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload. |
localeName |
string |
The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format. |
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
The label and user interface hints for the specified service data object and its attributes in a name-value pair format. |
getServiceLastUpdateTime
Returns the date and time when the schema files referenced in the service definition last changed.
Life Cycle Status: Active
Request Payload
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time when the service definition was last updated. The parameter is present in ISO 8601 format. |
getEntityList
Gets the list of service data objects defined on this service.
Life Cycle Status: Active
Request Payload
Response Payload
Element Name | Type | Description |
---|---|---|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
A list of service data objects defined on this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object. |
Security
The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.
Service Operations to Privileges Mapping
Operation Name | Privilege Code | Privilege Name | Privilege Description |
---|---|---|---|
isUserNameAvailable |
CRM_ANONYMOUS_SELFREGISTER_PRIV_PRIV |
Create Self Service Partner Registration |
Allows access to register Partner Company and also request for username |
isUserNameAvailable |
ZPM_CREATE_PARTNER_USER_PRIV |
Create Partner User |
Allows provisioning of partner members to sign into the vendor partner network. |
createPartnerCompanyAndAdministrator |
CRM_ANONYMOUS_SELFREGISTER_PRIV_PRIV |
Create Self Service Partner Registration |
Allows access to register Partner Company and also request for username |
createPartnerCompanyAndAdministrator |
ZPM_CREATE_PARTNER_USER_PRIV |
Create Partner User |
Allows provisioning of partner members to sign into the vendor partner network. |
createPartnerWithUserProvisioning |
CRM_ANONYMOUS_SELFREGISTER_PRIV_PRIV |
Create Self Service Partner Registration |
Allows access to register Partner Company and also request for username |
createPartnerWithUserProvisioning |
ZPM_CREATE_PARTNER_USER_PRIV |
Create Partner User |
Allows provisioning of partner members to sign into the vendor partner network. |
Privileges to Duty Roles Mapping
Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
---|---|---|---|
ZPM_CREATE_PARTNER_USER_PRIV |
ORA_ZPM_PARTNER_ACCOUNT_MAINTENANCE_DUTY |
Partner Account Maintenance |
Maintains a partner account, including managing members and partner profile information. This role is for members of the partner account team and their management chain. |
ZPM_CREATE_PARTNER_USER_PRIV |
ORA_ZPM_PARTNER_ACCOUNT_ADMINISTRATION_DUTY |
Partner Account Administration |
Maintains a partner account, including managing members and partner profile information. |
ZPM_CREATE_PARTNER_USER_PRIV |
ORA_ZPM_PARTNER_MANAGMENT_AS_PARTNER_DUTY |
Partner Management as Partner Administrator |
Manages the partner account for their partner organization, including managing members, users, and profile information. This role is for the partner administrator. |
CRM_ANONYMOUS_SELFREGISTER_PRIV_PRIV |
ORA_FND_ANONYMOUS_USER_ABSTRACT |
Anonymous User |
Maps to OPSS system Anonymous Role |