This request retrieves an individual account. Use this to retrieve basic information about an individual, as well as custom field data.
REST
Request
https://api.neoncrm.com/neonws/services/api/account/retrieveIndividualAccount?userSessionId=[session id]&accountId=3542
Response
{
"retrieveIndividualAccountResponse": {
"operationResult": "SUCCESS",
"responseDateTime": "2013-01-24T03:46:28.060-06:00",
"individualAccount": {
"createdDateTime": "2013-01-24T03:42:59.000-06:00",
"createdBy": "Administrator ",
"lastModifiedDateTime": "2013-01-24T03:42:59.000-06:00",
"lastModifiedBy": "Administrator ",
"accountId": 3542,
"primaryContact": {
"contactId": 5178,
"firstName": "Jason",
"lastName": "weng",
"middleName": "mid",
"prefix": "Mr.",
"suffix": "test",
"salutation": "brother",
"preferredName": "kevin",
"phone1": 422794616,
"phone1Type": "Home",
"phone2": 422794617,
"phone2Type": "Work",
"phone3": 422794618,
"phone3Type": "Mobile",
"fax": 422794620,
"dob": "1988-10-16-05:00",
"gender": {
"code": "M",
"name": "Male"
},
"email1": "kl@z2systems.com",
"email2": "email2@z2systems.com",
"email3": "email3@z2systems.com",
"deceased": false,
"addresses": {
"address": [
{
"addressId": 3436,
"isPrimaryAddress": true,
"addressType": {
"id": 1,
"name": "Home"
},
"addressLine1": "street1",
"city": "city",
"state": {
"code": "AL",
"name": "ALABAMA"
},
"county": "county",
"country": {
"id": 2,
"name": "Canada"
},
"zipCode": 111,
"zipCodeSuffix": 222,
"startDate": "2012-01-01-06:00",
"endDate": "2013-01-01-06:00"
},
{
"addressId": 3437,
"isPrimaryAddress": false,
"addressType": {
"id": 1,
"name": "Home"
},
"addressLine1": "aaa",
"addressLine2": "bbb",
"addressLine3": "ccc",
"addressLine4": "ddd",
"city": "city",
"state": {
"code": "AL",
"name": "ALABAMA"
},
"county": "county",
"country": {
"id": 1,
"name": "United States"
},
"zipCode": 39111,
"zipCodeSuffix": 1355,
"startDate": "1990-03-16-06:00",
"endDate": "1990-03-17-06:00"
}
]
},
"department": "dep",
"title": "SoftwareEngineer"
},
"noSolicitation": false,
"url": "www.z2systems.com",
"login": {
"username": "admin123456"
},
"customFieldDataList": {
"customFieldData": {
"fieldId": 73,
"fieldOptionId": 94
}
},
"source": {
"id": 43,
"name": "J. Starr"
},
"individualTypes": {
"individualType": {
"id": 1,
"name": "Organization"
}
}
}
}
}
SOAP
Request
<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
<soapenv:header>
<soapenv:body>
<neon:retrieveindividualaccountrequest>
<usersessionid>T1357624094982</usersessionid>
<accountid>5788</accountid>
</neon:retrieveindividualaccountrequest>
</soapenv:body>
</soapenv:header>
</soapenv:envelope>
Response
<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:body>
<ns2:retrieveindividualaccountresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
<operationresult>SUCCESS</operationresult>
<responsedatetime>2013-01-24T03:49:22.451-06:00</responsedatetime>
<individualaccount>
<createddatetime>2013-01-24T03:42:59.000-06:00</createddatetime>
<createdby>Administrator</createdby>
<lastmodifieddatetime>2013-01-24T03:42:59.000-06:00</lastmodifieddatetime>
<lastmodifiedby>Administrator</lastmodifiedby>
<accountid>3542</accountid>
<primarycontact>
<contactid>5178</contactid>
<firstname>Jason</firstname>
<lastname>weng</lastname>
<middlename>mid</middlename>
<prefix>Mr.</prefix>
<suffix>test</suffix>
<salutation>brother</salutation>
<preferredname>kevin</preferredname>
<phone1>422794616</phone1>
<phone1type>Home</phone1type>
<phone2>422794617</phone2>
<phone2type>Work</phone2type>
<phone3>422794618</phone3>
<phone3type>Mobile</phone3type>
<fax>422794620</fax>
<dob>1988-10-16-05:00</dob>
<gender>
<code>M</code>
<name>Male</name>
</gender>
<email1>kl@z2systems.com</email1>
<email2>email2@z2systems.com</email2>
<email3>email3@z2systems.com</email3>
<deceased>false</deceased>
<addresses>
<address>
<addressid>3436</addressid>
<isprimaryaddress>true</isprimaryaddress>
<addresstype>
<id>1</id>
<name>Home</name>
</addresstype>
<addressline1>street1</addressline1>
<city>city</city>
<state>
<code>AL</code>
<name>ALABAMA</name>
</state>
<county>county</county>
<country>
<id>2</id>
<name>Canada</name>
</country>
<zipcode>111</zipcode>
<zipcodesuffix>222</zipcodesuffix>
<startdate>2012-01-01-06:00</startdate>
<enddate>2013-01-01-06:00</enddate>
</address>
<address>
<addressid>3437</addressid>
<isprimaryaddress>false</isprimaryaddress>
<addresstype>
<id>1</id>
<name>Home</name>
</addresstype>
<addressline1>aaa</addressline1>
<addressline2>bbb</addressline2>
<addressline3>ccc</addressline3>
<addressline4>ddd</addressline4>
<city>city</city>
<state>
<code>AL</code>
<name>ALABAMA</name>
</state>
<county>county</county>
<country>
<id>1</id>
<name>United States</name>
</country>
<zipcode>39111</zipcode>
<zipcodesuffix>1355</zipcodesuffix>
<startdate>1990-03-16-06:00</startdate>
<enddate>1990-03-17-06:00</enddate>
</address>
</addresses>
<department>dep</department>
<title>SoftwareEngineer</title>
</primarycontact>
<nosolicitation>false</nosolicitation>
<url>www.z2systems.com</url>
<login>
<username>admin123456</username>
</login>
<customfielddatalist>
<customfielddata>
<fieldid>73</fieldid>
<fieldoptionid>94</fieldoptionid>
</customfielddata>
</customfielddatalist>
<source>
<id>43</id>
<name>J. Starr</name>
<individualtypes>
<individualtype>
<id>1</id>
<name>Organization</name>
</individualtype>
</individualtypes>
</individualaccount>
</ns2:retrieveindividualaccountresponse>
</soap:body>
</soap:envelope>
Request Parameters
| Name |
Required |
Description |
| accountId |
Yes |
Account ID |
Response Parameters
| Name |
Required |
Description |
| individualAccount.accountId |
Yes |
Account ID to be updated. |
| individualAccount.primaryContact.contactId |
Yes |
Contact ID to be updated. This is necessary for using the Update Individual Account method. |
| individualAccount.primaryContact.firstName |
Yes |
|
| individualAccount.primaryContact.lastName |
Yes |
|
| individualAccount.primaryContact.middleName |
|
|
| individualAccount.primaryContact.prefix |
|
Possible values come from the List Prefixes request. |
| individualAccount.primaryContact.suffix |
|
|
| individualAccount.primaryContact.preferredName |
|
|
| individualAccount.primaryContact.salutation |
|
|
| individualAccount.primaryContact.phone1 |
|
|
| individualAccount.primaryContact.phone1Type |
|
Possible values: Home, Work, Mobile |
| individualAccount.primaryContact.phone2 |
|
|
| individualAccount.primaryContact.phone2Type |
|
Possible values: Home, Work, Mobile |
| individualAccount.primaryContact.phone3 |
|
|
| individualAccount.primaryContact.phone3Type |
|
Possible values: Home, Work, Mobile |
| individualAccount.primaryContact.fax |
|
|
| individualAccount.primaryContact.dob |
|
Date format: YYYY-MM-DD |
| individualAccount.primaryContact.gender.code |
|
Possible values can be retrieved using the List Genders method. |
| individualAccount.primaryContact.gender.name |
|
Possible values can be retrieved using the List Genders method. |
| individualAccount.primaryContact.email1 |
|
|
| individualAccount.primaryContact.email2 |
|
|
| individualAccount.primaryContact.email3 |
|
|
| individualAccount.primaryContact.deceased |
|
Possible values: true, false |
| individualAccount.primaryContact.title |
|
|
| individualAccount.primaryContact.department |
|
|
| individualAccount.primaryContact.addresses.address.isPrimaryAddress |
|
Whether this address is the primary address. Possible values: true, false |
| individualAccount.primaryContact.addresses.address.addressType.id |
|
Possible values can be retrieved from the List Address Types method. |
| individualAccount.primaryContact.addresses.address.addressType.Name |
|
Possible values can be retrieved from the List Address Types method. |
| individualAccount.primaryContact.addresses.address.addressLine1 |
|
|
| individualAccount.primaryContact.addresses.address.addressLine2 |
|
|
| individualAccount.primaryContact.addresses.address.addressLine3 |
|
|
| individualAccount.primaryContact.addresses.address.addressLine4 |
|
|
| individualAccount.primaryContact.addresses.address.city |
|
|
| individualAccount.primaryContact.addresses.address.state.code |
|
Possible values can be retrieved from the List States method. |
| individualAccount.primaryContact.addresses.address.state.name |
|
Possible values can be retrieved from the List States method. |
| individualAccount.primaryContact.addresses.address.province |
|
Only used for countries other than US and Canada. Canadian provinces can be found in the States field. |
| individualAccount.primaryContact.addresses.address.county |
|
|
| individualAccount.primaryContact.addresses.address.country.id |
|
Possible values can be retrieved from the List Countries method. |
| individualAccount.primaryContact.addresses.address.country.name |
|
Possible values can be retrieved from the List Countries method. |
| individualAccount.primaryContact.addresses.address.zipCode |
|
|
| individualAccount.primaryContact.addresses.address.zipCodeSuffix |
|
|
| individualAccount.primaryContact.addresses.address.startDate |
|
Format: YYYY-MM-DD |
| individualAccount.primaryContact.addresses.address.endDate |
|
Format: YYYY-MM-DD |
| individualAccount.noSolicitation |
|
This corresponds to the Do Not Contact field. Possible values: true, false. |
| individualAccount.url |
|
|
| individualAccount.login.username |
|
If username is provided, password must also be provided. |
| individualAccount.login.password |
|
If password is provided, username must also be provided. |
| individualAccount.login.orgId |
|
|
| individualAccount.customFieldDataList.customFieldData.fieldId |
|
Retrieve possible account custom fields from the List Custom Fields request. |
| individualAccount.customFieldDataList.customFieldData.fieldValue |
|
Required if the custom field type is a text field. |
| individualAccount.customFieldDataList.customFieldData.fieldOptionId |
|
Required if the custom field type is not a text field. Possible values can be retrieved from the List Custom Fields request. |
| individualAccount.source.id |
|
Possible values can be retrieved from the List Sources method. |
| individualAccount.source.name |
|
Possible values can be retrieved from the List Sources method. |
| individualAccount.existingOrganizationId |
|
Include the Account ID of an organization account to link this individual as a company contact. |
| individualAccount.organizationName |
|
If not linked to an organization account, a name can be used. This will not link to an existing organization account. |
| individualAccount.individualTypes.individualType.id |
|
Possible values can be retrieved from the List Individual Types method. |
| individualAccount.individualTypes.individualType.name |
|
Possible values can be retrieved from the List Individual Types method. |
Error Codes
| Code |
Text |
Description |
| 10030 |
Individual account id is required. |
|
| 10031 |
Individual account id is invalid. |
|
