Prospect View Request and Response - Attribute/Value Pairs in the JSON Format

Note: We recommend you to refer the topics Prospect View Request in the JSON Format and Prospect View Response in the JSON Format in parallel while understanding the below mentioned attributes. This will help you to understand how the attribute/value pairs are structured in the JSON format.

Before calling the C1-ADDPROSPERSON business service through an inbound web service, you need to ensure that the prospect view request contains the following attributes:

Attribute Name Attribute Description Mandatory (Yes or No)
prospectPersonId Used to specify the prospect for which you want to create the view request.
Note: If you do not specify the value in the prospectPersonId attribute, you have to specify the personIdNumber and idType attributes.
 Yes (Conditional)
Note: This data is required for creating view request for a particular prospect.
actionFlag Used to indicate that you want to create request to view a prospect. The valid value is:

  • READ

Note: If you do not specify the value in this attribute, the system considers it as an ADD action.
 Yes
personIdNumber Used to specify the value of the person identifier type using which you want to create the view request for a prospect.
Note:

If you specify the idType attribute, you need to specify the personIdNumber attribute.

 Yes (Conditional)
Note: This data is required for creating view request for a prospect using its person identifier details.
idType Used to specify the identifier type using which you want to create the view request for a prospect.
Note:

If you specify the personIdNumber attribute, you need to specify the idType attribute.

The data in this attribute is required if you do not specify the value in the prospectPersonId attribute.

You should specify an identifier type which is associated with the division to which the prospect belongs.

 Yes (Conditional)
Note: This data is required for creating view request for a prospect using its person identifier details.
division Used to specify the division of the identifier type using which you want to create the view request for a prospect.
Note:

If you specify the personIdNumber and idType attributes, you need to specify the division attribute.

You must specify a division which is already defined in the system.

 Yes (Conditional)
Note: This data is required for creating view request for a prospect using its person identifier details.

Once the view request is created for the prospect, all the details of prospect are listed in the above mentioned attributes along with the following attributes:

Attribute Name Attribute Description
prospectPersonName Displays the name of the prospect person.
division Display the division to which the prospect person belongs.
customerSegment Indicates the business component using which the prospect person is created in the system.
customerTier Indicates the customer tier of the customer segment to which the prospect person is associated.
accessGroup Indicates the user groups who can view and edit the details of the prospect person.
emailAddress Displays the email address of the prospect person.
status Indicates the current status of the prospect. The valid values are:

  • ACTIVE

  • INACTIVE
birthDate Displays the date of birth of the prospect person.
address1 Displays the first line of the address. It may contain details, such as the house number.
address2 Displays the second line of the address. It may contain details, such as the apartment name.
address3 Displays the third line of the address. It may contain details, such as the street name.
address4 Displays the fourth line of the address. It may contain the landmark details.
city Displays the city where the prospect person is located.
state Displays the state where the city is located.
country Displays the country where the state is located.
postal Displays the postal code of the address.
prosPerIdentifierList Displays a list of person identifiers for the prospect.
personIdNumber Displays the value of the person identifier type.
persIsPrimaryId Indicates whether the prospect person identifier is primary or not. The valid values are:

  • True

  • False
idType Displays the identifier type using which the prospect person is created in the system.
prosChildRelationList Displays the list of child persons associated with the prospect person.
childPersonId Displays the child person of the prospect person.
personRelationshipType Indicates how the child person is associated with the prospect person.
childPerType Indicates the type of the child person.
division Indicates the division to which the child person belongs.
childPersonIdType Indicates the identifier type using which the child person is created in the system.
childPersonIdNumber Displays the value of the identifier type using which the child person is created in the system.
endDate Displays the date till when the child person is associated with the prospect person.
startDate Displays the date from when the child person is associated with the prospect person.
prosParentPerRelationList Displays the list of parent persons associated with the prospect person.
parentPersonId Displays the parent person of the prospect person.
personRelationshipType Indicates how the parent person is associated with the prospect person.
parentPerType Indicates the type of the parent person.
division Indicates the division to which the parent person belongs.
parentPersonIdType Indicates the identifier type using which the parent person is created in the system.
parentPersonIdNumber Displays the value of the identifier type using which the parent person is created in the system.
endDate Displays the date till when the prospect person is associated with the parent person.
startDate Displays the date from when the prospect person is associated with the parent person.
prosAccountList Displays the list of accounts for the prospect person.
personId Displays the prospect person identification value.
prospectAccountId Displays the account identification value that is generated for the prospect person.
customerClass Indicates the customer class to which the account is associated.
accountDivision Indicate the division to which the account belongs.
status Indicates the status of the account. The valid values are:

  • ACTIVE

  • INACTIVE
setUpDate Displays the date from when the account is available for the prospect person.
currency Indicates the currency code of the account.
billCycle Indicates the time interval in which the bills are created for the account.
accountAccessGroup Indicates the user group who can view and edit the details of the account.
prosAcctCharacteristicList Displays the list of characteristics for the prospect account.
characteristicValue Displays the value of the characteristic type.
effectiveDate Displays the date from when the characteristic is effective for the account.
characteristicType Indicates the characteristic type.
prosAcctIdentifierList Displays the list of identifiers for the prospect account.
accountIdentifierType Indicates the identifier type based on which the account is defined.
isPrimaryId Indicates whether the prospect account identifier is primary or not. The valid values are:

  • True

  • False
accountNumber Displays the account to which the identifier is associated.
prosPerCharactersticList Displays the list of characteristics defined for the prospect person.
personcharacteristicValue Displays the value of the characteristic type.
personEffectiveDate Displays the date from when the characteristic is effective for the prospect person.
personCharType Indicates the characteristic type.

Related Topics

For more information on... See...
Sample prospect view request and response in the JSON format Sample Prospect View Request and Response in the JSON Format