Prospect Update Request and Response - Attribute/Value Pairs in the JSON Format
Before calling the C1-ADDPROSPERSON business service through an inbound web service, you need to ensure that the prospect update request contains the following attributes:
Attribute Name | Attribute Description | Mandatory (Yes or No) |
---|---|---|
prospectPersonId | Used to specify the prospect person for whom you want to create the update request. | Yes |
actionFlag | Used to indicate that you want to create request to update
a prospect person. The valid value is:
Note: If you do not specify the value in this attribute, the
system considers it as an ADD action.
|
Yes |
prospectPersonName | Used to specify the name of the prospect person. Note: You
should specify a person name which is already present in the system.
|
Yes |
division | Used to indicate the division to which you want to associate
the prospect person. Note: You must specify a division which is already
defined in the system.
|
Yes |
customerSegment | Used to indicate the business component using which you want
to update the prospect person. Note: You should specify only those
values which are present in the CUST_SEG_FLG lookup field.
|
No |
customerTier | Used to indicate the customer tier of the customer segment
to which you want to associate the prospect person. Note: You should
specify only those values which are present in the CUST_TIER_FLG lookup field.
|
No |
accessGroup | Used to indicate the user groups who can view and edit the
details of the prospect person. Note: You can specify only those access
groups which are associated with the division to which the prospect
belongs.
|
Yes |
emailAddress | Used to specify the email address of the prospect person. | No |
status | Used to indicate the status in which you want to create the
prospect person.
Note:
The status of the prospect person can only be set to ACTIVE while adding a prospect person. If you do not specify the value in this attribute, the system, by default sets the status of the prospect person to ACTIVE. |
Yes |
birthDate | Used to specify the date of birth of the prospect person. | No |
address1 | Used to specify the first line of the address. It may contain details, such as the house number. | No |
address2 | Used to specify the second line of the address. It may contain details, such as the apartment name. | No |
address3 | Used to specify the third line of the address. It may contain details, such as the street name. | No |
address4 | Used to specify the fourth line of the address. It may contain the landmark details. | No |
city | Used to specify the city where the prospect is located. | No |
state | Used to specify the state where the city is located. | No |
country | Used to specify the country where the state is located. | No |
postal | Used to specify the postal code of the address. | No |
prosPerIdentifierList | Used to specify a list of person identifiers for the prospect person. | No |
personIdNumber | Used to specify the value of the person identifier type. Note: If you specify the idType attribute, you need
to specify the personIdNumber attribute.
|
Yes (Conditional) Note: This data is required while specifying
the prospect person identifier.
|
persIsPrimaryId | Used to indicate whether the prospect person identifier is
primary or not. The valid values are:
|
Yes (Conditional) Note: This data is required while specifying
the prospect person identifier.
|
idType | Used to specify the identifier type using which you want
to add the prospect person in the system. Note: If you specify the personIdNumber attribute, you need to specify the idType attribute.
|
Yes (Conditional) Note: This data is required while specifying
the prospect person identifier.
|
prosChildRelationList | Used to specify a list of child persons associated with the prospect person. | No |
childPersonId | Used to specify the child person of the prospect person. | Yes (Conditional) Note: This data is required while specifying
the child person of the prospect person.
|
personRelationshipType | Used to indicate how the child person is associated with the prospect person. | Yes (Conditional) Note: This data is required while specifying
the child person of the prospect person.
|
childPerType | Used to indicate the type of the child person. | Yes (Conditional) Note: This data is required while specifying
the child person of the prospect person.
|
division | Used to indicate the division to which the child person belongs. Note:
You must specify a division which is already defined in the system. The child person must belong to the division to which the prospect person is associated. |
Yes (Conditional) Note: This data is required while specifying
the child person of the prospect person.
|
childPersonIdType | Used to specify the identifier type using which the child
person is created in the system. Note: If you specify the childPersonIdNumber attribute, you need to specify the childPersonIdType attribute.
|
Yes (Conditional) Note: This data is required while specifying
the child person of the prospect person.
|
childPersonIdNumber | Used to specify the value of the identifier type using which
the child person is created in the system. Note: If you specify the childPersonIdType attribute, you need to specify the childPersonIdNumber attribute.
|
Yes (Conditional) Note: This data is required while specifying
the child person of the prospect person.
|
endDate | Used to specify the date till when the child person is associated with the prospect person. | No |
startDate | Used to specify the date from when the child person is associated with the prospect person. | Yes (Conditional) Note: This data is required while specifying
the child person of the prospect person.
|
prosParentPerRelationList | Used to specify a list of parent persons associated with
the prospect person. Note: You can now add a prospect person or account
to an existing person in the system. In other words, the system allows
you to add a prospect person or account in an existing person’s hierarchy.
Also, you can create deals for such prospect person’s or account’s,
if required.
|
No |
parentPersonId | Used to specify the parent person of the prospect person. | Yes (Conditional) Note: This data is required while specifying
the parent person relationship of the prospect person.
|
personRelationshipType | Used to indicate how the prospect person is associated with the specified person. | Yes (Conditional) Note: This data is required while specifying
the parent person relationship of the prospect person.
|
parentPerType | Used to indicate the type of the parent person. The valid
values are:
|
Yes (Conditional) Note: This data is required while specifying
the parent person relationship of the prospect person.
|
division | Used to indicate the division to which the parent person
belongs. Note:
You must specify a division which is already defined in the system. The parent person must belong to the division to which the prospect person is associated. |
Yes (Conditional) Note: This data is required while specifying
the parent person relationship of the prospect person.
|
parentPersonIdType | Used to specify the identifier type using which the parent
person is created in the system. Note: If you specify the parentPersonIdNumber attribute, you need to specify the parentPersonIdType attribute.
|
Yes (Conditional) Note: This data is required while specifying
the parent person relationship of the prospect person.
|
parentPersonIdNumber | Used to specify the value of the identifier type using which
the parent person is created in the system. Note: If you specify the parentPersonIdType attribute, you need to specify the parentPersonIdNumber attribute.
|
Yes (Conditional) Note: This data is required while specifying
the parent person relationship of the prospect person.
|
endDate | Used to specify the date till when the prospect person is associated with the parent person. | No |
startDate | Used to specify the date from when the prospect person is associated with the parent person. | Yes (Conditional) Note: This data is required while specifying
the parent person relationship of the prospect person.
|
prosAccountList | Used to specify a list of accounts for the prospect person. | No |
personId | Used o specify the person to which the account belongs. | Yes (Conditional) Note: This data is required while adding
an account for the prospect person.
|
customerClass | Used to indicate the customer class to which the account
is associated. Note: You must specify a customer class which is associated
with the division to which the prospect account belongs.
|
Yes (Conditional) Note: This data is required while adding
an account for the prospect person.
|
accountDivision | Used to indicate the division to which the account belongs. Note: If you do not specify the value in this attribute, the system considers
the division of the person to whom the account is associated.
|
Yes (Conditional) Note: This data is required while adding
an account for the prospect person.
|
status | Used to indicate the status of the account. The valid values
are:
Note:
The status of the prospect account can only be set to ACTIVE while adding a prospect account. If you do not specify the value in this attribute, the system, by default sets the status of the prospect account to ACTIVE. |
Yes (Conditional) Note: This data is required while adding
an account for the prospect person.
|
setUpDate | Used to specify the date from when the account is available for the prospect person. | Yes (Conditional) Note: This data is required while adding
an account for the prospect person.
|
currency | Used to indicate the currency code of the account. Note: You
must specify a currency which is already defined in the system and
which is associated with the division to which the prospect account
belongs.
|
Yes |
billCycle | Used to indicate the time interval in which you want to create the bills for the account. | Yes (Conditional) Note: This data is required while adding
an account for the prospect person.
|
accountAccessGroup | Used to indicate the user group who can view and edit the
details of the account. Note: If you do not specify the value in this
attribute, the system considers the access group of the person to
whom the account belongs.
|
Yes (Conditional) Note: This data is required while adding
an account for the prospect person.
|
prosAcctCharacteristicList | Used to specify a list of characteristics for the prospect account. | No |
characteristicValue | Used to specify the value for the characteristic type. | Yes (Conditional) Note: This data is required while adding
a characteristic for the prospect account.
|
effectiveDate | Used to specify the date from when the characteristic is effective for the prospect account. | Yes (Conditional) Note: This data is required while adding
a characteristic for the prospect account.
|
characteristicType | Used to indicate the characteristic type. Note: You must specify
a characteristic type which is associated with the division to which
the prospect account belongs.
|
Yes (Conditional) Note: This data is required while adding
a characteristic for the prospect account.
|
prosAcctIdentifierList | Used to specify a list of identifiers for the prospect account. | No |
accountIdentifierType | Used to indicate the identifier type based on which you want
to define the prospect account. Note:
If you specify the accountNumber attribute, you need to specify the accountIdentifierType attribute. You must specify an identifier type which is associated with the division to which the prospect account belongs. |
Yes (Conditional) Note: This data is required while associating
an identifier with the prospect account.
|
isPrimaryId | Used to indicate whether the prospect account identifier
is primary or not. The valid values are:
Note: If you do not specify the value in this attribute, the
system considers the value as False.
|
Yes (Conditional) Note: This data is required while associating
an identifier with the prospect account.
|
accountNumber | Used to specify the prospect account to which you want to
associate the identifier. Note: If you specify the accountIdentifierType attribute, you need to specify the accountNumber attribute.
|
Yes (Conditional) Note: This data is required while associating
an identifier with the prospect account.
|
prosPerCharactersticList | Used to specify a list of characteristics for the prospect person. | No |
personcharacteristicValue | Used to specify the value for the characteristic type. | Yes (Conditional) Note: This data is required while adding
a characteristic for the prospect person.
|
personEffectiveDate | Used to specify the date from when the characteristic is effective for the prospect person. | Yes (Conditional) Note: This data is required while adding
a characteristic for the prospect person.
|
personCharType | Used to indicate the characteristic type. Note: You must specify
a characteristic type which is associated with the division to which
the prospect person belongs.
|
Yes (Conditional) Note: This data is required while adding
a characteristic for the prospect person.
|
At a time, you can edit only one prospect person through the web service.
While updating the prospect person, 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.
Once the prospect is updated, all the details of prospect are listed in the above mentioned attributes.
Related Topics
For more information on... | See... |
---|---|
Sample prospect update request and response in the JSON format | Sample Prospect Update Request and Response in the JSON Format |