Prospect Creation, Modification, and View through Inbound Web Service

Oracle Revenue Management and Billing enables you to create and edit a prospect person and its accounts through a web service. It also enables you to view the details of a prospect person and its accounts through a web service. You can send the prospect person creation, modification, or view request from the external system through an inbound web service. We have shipped the following two inbound web services in this release:

  • C1-ProspectPerson - This is a SOAP based web service. You can use this web service when you want to send the prospect person creation, modification, or view request in the XML format.

  • C1-ProspectPersonREST - This is a REST based web service. You can use this web service when you want to send the prospect person creation, modification, or view request in the XML or JSON format.

Both these inbound web services call the C1-ADDPROSPERSON business service. This business service is used to do the following:

  • Create or edit a prospect person - While creating a prospect person, you can specify the following details:

    • Name, division, customer segment, customer tier, access group, date of birth, e-mail address, and residential address of the prospect person

    • Characteristics of the prospect person

    • Identifiers of the prospect person

    • Parent and child persons of the prospect person

    Note: Other prospect person can be a child of the prospect person. But, only existing person can be a parent of the prospect person.

    To add a prospect person through the web service, you must set the action flag to ADD. However, to edit a prospect person through the web service, you must set the action flag to UPD. While editing a prospect person, you need to specify the prospect person ID to identify the prospect person whose details you want to change. During the update operation, the system replaces the prospect person data instead of editing it. Therefore, you should provide all the details of prospect person including the data that you want to change. For example, if you want to update the characteristics of a prospect person through the web service, you need to provide all details of the prospect person including the new characteristics. While updating the prospect person, the system deletes the old characteristics and creates the new characteristics for the prospect person.

    At a time, you can create or edit only one prospect person through the web service. While adding a prospect person, the status of the prospect person can only be set to ACTIVE. If you do not specify the status while adding a prospect person, the system, by default sets the status of the prospect person to ACTIVE. While updating a prospect person, you can change the status of the prospect person from ACTIVE to INACTIVE. On inactivating a prospect person, the system automatically changes the status of all its prospect accounts to INACTIVE. However, while activating an inactive prospect person, the system does not automatically activates all its prospect accounts. You need to explicitly send the request for activating the required prospect accounts of the prospect person. Also, note that you cannot update the details of an inactive prospect person unless you activate it. Similarly, you cannot update the details of an inactive prospect account unless you activate the prospect person and the respective prospect account.

  • Create or edit a prospect account of a prospect person - While creating or updating a prospect person, you can create a prospect account for the prospect person. However, while updating a prospect person, you can create or edit a prospect account of the prospect person. While creating a prospect account, you can specify the following details:

    • Division, setup date, invoice currency, bill cycle, and access group of the prospect account

    • Characteristics of the prospect account

    • Identifiers of the prospect account

    Note: The division and access group of the prospect account and prospect person should be same.

    While associating the prospect person with the prospect account, the system by default sets the Main Customer flag to true, the Financially Responsible flag to true, the Relationship Type flag to Main Customer, and the Address Source flag to PER.

    While editing a prospect account, you need to specify the prospect account ID to identify the prospect account whose details you want to change. During the update operation, the system replaces the prospect account data instead of editing it.

    At a time, you can create or edit multiple prospect accounts of a prospect person through the web service. While adding a prospect account, the status of the prospect account can only be set to ACTIVE.

    If you do not specify the status while adding a prospect account, the system, by default sets the status of the prospect account to ACTIVE. While updating a prospect account, you can change the status of the prospect account from ACTIVE to INACTIVE.

    Note that you cannot update the details of an inactive prospect account unless you activate it. You cannot activate a prospect account when the main customer (i.e. prospect person) of the prospect account is inactive.

  • View the details of a prospect person - While viewing the details of a prospect person, you need to:

    • Specify the prospect person ID or the primary prospect person identifier type, primary prospect person identifier, and division to determine the prospect person whose details you want to view

    • Set the action flag to READ

    On processing the request, the system displays all details of the prospect person including the details of all its accounts in the response.