Use the insertProspect operation to insert a new prospect to DataTrak. Inserting a new prospect requires a request with the following information. Note that the only required fields are clubNumber, firstName, lastName, and gender. In addition, the beginDate will default to the current date if it is not provided, so every prospect will always have a begin date. The beginDate field is the only field with a default value.
service type | SOAP |
service name | ProspectManagerService |
operation | insertProspect |
required request parameters |
|
The request has the following parameters:
Parameter Name | Required? | Format | Parent Parameter | Description |
---|---|---|---|---|
clubNumber | Y | Club Number | none | Required. The club number specified in the request URL. |
firstName | Y | string, up to 15 characters | personal | Required. The prospect's first name. |
lastName | Y | string, up to 19 characters | personal | Required. The prospect's last name. |
middleInitial | N | string, 1 character | personal | Optionall The prospect's middle initial. |
gender | Y | male | Male | MALE female | Female | FEMALE unknown | Unknown | UNKNOWN |
personal | Required. The prospect's gender. |
dateofBirth | N | YYYY-MM-DD | personal | Optional. The prospect's date of birth. |
street | N | string, up to 40 characters | contact | Optional. The prospect's street address. |
city | N | string, up to 17 characters | contact | Optional. The prospect's city. |
state | N | State Code | contact | Optional. The two-letter abbreviation for the prospect's state. |
zip | N | string, up to 10 characters | contact | Optional. The prospect's zip code. |
N | string, up to 60 characters | contact | Optional. The prospect's e-mail address. | |
primaryPhone | N | Phone Number |
contact | Optional. The prospect's home phone number. |
cellPhone | N | Phone Number | contact | Optional. The prospect's mobile phone number. |
workPhone | N | Phone Number | contact | Optional. The prospect's work phone number. |
workExtension | N | string, up to four characters | contact | Optional. The prospect's work extension number. |
issueDate | N | YYYY-MM-DD | dates | Optional. The date the agreement was issued. |
beginDate | N | YYYY-MM-DD | dates | Optional. The date the agreement began. |
expirationDate | N | YYYY-MM-DD | dates | Optional. The date the agreement will expire. |
employer | N | string, up to 50 characters | miscellaneous | Optional. The name of the prospect's employer. |
miscellaneous1 | N | string, up to 50 characters | miscellaneous | Optional. This field can be used to insert custom data. |
miscellaneous2 | N | string, up to 50 characters | miscellaneous | Optional. This field can be used to insert custom data. |
salesPerson | N | GUID | miscellaneous | Optional. The GUID of the salesperson who helped the prospect. This GUID must be associated with an employee of the selected club. See the employeeId tag in the HTTP service getEmployeeList. |
barCode | N | barcode | miscellaneous | Optional. The barcode for the prospect. |
The return value of the service contains the following tags: