Retrieve detailed information about the contacts for a specific organization account.
REST
Request
https://api.neoncrm.com/neonws/services/api/account/listOrganizationContacts?userSessionId=[session id]&organizationAccountId=3481
Response
{
"listOrganizationContactsResponse": {
"operationResult": "SUCCESS",
"responseMessage": "2 contact(s) found.",
"responseDateTime": "2013-01-27T19:40:49.494-06:00",
"organizationContacts": {
"organizationContact": [
{
"isPrimaryContact": true,
"contact": {
"contactId": 5183,
"firstName": "Jason",
"lastName": "Weng",
"prefix": "Mr.",
"preferredName": "Jason",
"dob": "1985-10-13-05:00",
"gender": {
"code": "M",
"name": "Male"
},
"email1": "aaa@itree.com.au",
"addresses": {
"address": {
"addressId": 3440,
"isPrimaryAddress": true,
"isShippingAddress": false,
"addressType": {
"id": 1,
"name": "Home"
},
"addressLine1": "14/29 mars ST link 2",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"city": "cheng",
"state": {
"code": "AL",
"name": "ALABAMA"
},
"country": {
"id": 1,
"name": "United States"
},
"zipCode": 6489,
"zipCodeSuffix": 1,
"startDate": "2012-12-23-06:00",
"endDate": "2013-04-21-05:00"
}
},
"department": "dev.0021",
"title": "some title"
}
},
{
"accountId": 3544,
"isPrimaryContact": false,
"contact": {
"contactId": 5181,
"firstName": "Jason",
"lastName": "Weng",
"prefix": "Mr.",
"preferredName": "Jason",
"phone1": 11111,
"phone1Type": "Home",
"gender": {
"code": "M",
"name": "Male"
},
"email1": "aaa@itree.com.au",
"addresses": {
"address": {
"addressId": 3441,
"isPrimaryAddress": false,
"isShippingAddress": false,
"addressType": {
"id": 1,
"name": "Home"
},
"addressLine1": "14/29 mars ST link 2",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"city": "cheng",
"state": {
"code": "AL",
"name": "ALABAMA"
},
"country": {
"id": 1,
"name": "United States"
},
"zipCode": 6489,
"zipCodeSuffix": 1,
"startDate": "2012-12-23-06:00",
"endDate": "2013-04-21-05:00"
}
},
"department": "dev.0021",
"title": "some title"
}
}
]
}
}
}
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:listorganizationcontactsrequest>
<usersessionid>T1359336434918</usersessionid>
<organizationaccountid>3545</organizationaccountid>
</neon:listorganizationcontactsrequest>
</soapenv:body>
</soapenv:header>
</soapenv:envelope>
Response
<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:body>
<ns2:listorganizationcontactsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
<operationresult>SUCCESS</operationresult>
<responsemessage>2 contact(s) found.</responsemessage>
<responsedatetime>2013-01-27T19:36:06.045-06:00</responsedatetime>
<organizationcontacts>
<organizationcontact>
<isprimarycontact>true</isprimarycontact>
<contact>
<contactid>5183</contactid>
<firstname>Jason</firstname>
<lastname>Weng</lastname>
<prefix>Mr.</prefix>
<preferredname>Jason</preferredname>
<dob>1985-10-13-05:00</dob>
<gender>
<code>M</code>
<name>Male</name>
</gender>
<email1>aaa@itree.com.au</email1>
<addresses>
<address>
<addressid>3440</addressid>
<isprimaryaddress>true</isprimaryaddress>
<isshippingaddress>false</isshippingaddress>
<addresstype>
<id>1</id>
<name>Home</name>
</addresstype>
<addressline1>14/29 mars ST link 2</addressline1>
<addressline2>
<addressline3>
<addressline4>
<city>cheng</city>
<state>
<code>AL</code>
<name>ALABAMA</name>
</state>
<country>
<id>1</id>
<name>United States</name>
</country>
<zipcode>6489</zipcode>
<zipcodesuffix>1</zipcodesuffix>
<startdate>2012-12-23-06:00</startdate>
<enddate>2013-04-21-05:00</enddate>
</addressline4></addressline3></addressline2></address>
</addresses>
<department>dev.0021</department>
<title>some title</title>
</contact>
</organizationcontact>
<organizationcontact>
<accountid>3544</accountid>
<isprimarycontact>false</isprimarycontact>
<contact>
<contactid>5181</contactid>
<firstname>Jason</firstname>
<lastname>Weng</lastname>
<prefix>Mr.</prefix>
<preferredname>Jason</preferredname>
<phone1>11111</phone1>
<phone1type>Home</phone1type>
<gender>
<code>M</code>
<name>Male</name>
</gender>
<email1>aaa@itree.com.au</email1>
<addresses>
<address>
<addressid>3441</addressid>
<isprimaryaddress>false</isprimaryaddress>
<isshippingaddress>false</isshippingaddress>
<addresstype>
<id>1</id>
<name>Home</name>
</addresstype>
<addressline1>14/29 mars ST link 2</addressline1>
<addressline2>
<addressline3>
<addressline4>
<city>cheng</city>
<state>
<code>AL</code>
<name>ALABAMA</name>
</state>
<country>
<id>1</id>
<name>United States</name>
</country>
<zipcode>6489</zipcode>
<zipcodesuffix>1</zipcodesuffix>
<startdate>2012-12-23-06:00</startdate>
<enddate>2013-04-21-05:00</enddate>
</addressline4></addressline3></addressline2></address>
</addresses>
<department>dev.0021</department>
<title>some title</title>
</contact>
</organizationcontact>
</organizationcontacts>
</ns2:listorganizationcontactsresponse>
</soap:body>
</soap:envelope>
Request Parameters
| Name |
Required |
Description |
| organizationAccountId |
Yes |
Account ID |
Response Parameters
| Name |
Required |
Description |
| isPrimaryContact |
Yes |
Indicates if this contact is the current primary contact in this organization. Possible values: true, false. |
| contact.contactId |
Yes |
Contact ID to be updated. This is necessary for using the Update Individual Account method. |
| contact.firstName |
|
|
| contact.lastName |
|
|
| contact.middleName |
|
|
| contact.prefix |
|
Possible values come from the List Prefixes request. |
| contact.suffix |
|
|
| contact.preferredName |
|
|
| contact.salutation |
|
|
| contact.phone1 |
|
|
| contact.phone1Type |
|
Possible values: Home, Work, Mobile |
| contact.phone2 |
|
|
| contact.phone2Type |
|
Possible values: Home, Work, Mobile |
| contact.phone3 |
|
|
| contact.phone3Type |
|
Possible values: Home, Work, Mobile |
| contact.fax |
|
|
| contact.dob |
|
Date format: YYYY-MM-DD |
| contact.gender.code |
|
Possible values can be retrieved using the List Genders method. |
| contact.gender.name |
|
Possible values can be retrieved using the List Genders method. |
| contact.deceased |
|
Possible values: true, false |
| contact.title |
|
|
| contact.department |
|
|
| contact.email1 |
|
|
| contact.addresses.address.isPrimaryAddress |
|
Whether this address is the primary address. Possible values: true, false |
| contact.addresses.address.isShippingAddress |
|
Whether this address should be considered a shipping address. Possible values: true, false |
| contact.addresses.address.addressId |
|
|
| contact.addresses.address.addressType.id |
|
Possible values can be retrieved from the List Address Types method. |
| contact.addresses.address.addressType.name |
|
Possible values can be retrieved from the List Address Types method. |
| contact.addresses.address.addressLine1 |
|
|
| contact.addresses.address.addressLine2 |
|
|
| contact.addresses.address.addressLine3 |
|
|
| contact.addresses.address.addressLine4 |
|
|
| contact.addresses.address.city |
|
|
| contact.addresses.address.state.code |
|
Possible values can be retrieved from the List States method. |
| contact.addresses.address.state.name |
|
Possible values can be retrieved from the List States method. |
| contact.addresses.address.province |
|
Only used for countries other than US and Canada. Canadian provinces can be found in the States field. |
| contact.addresses.address.county |
|
|
| contact.addresses.address.country.id |
|
Possible values can be retrieved from the List Countries method. |
| contact.addresses.address.country.name |
|
Possible values can be retrieved from the List Countries method. |
| contact.addresses.address.zipCode |
|
|
| contact.addresses.address.zipCodeSuffix |
|
|
| contact.addresses.address.startDate |
|
Format: YYYY-MM-DD |
| contact.addresses.address.endDate |
|
Format: YYYY-MM-DD |
| organizationAccount.noSolicitation |
|
This corresponds to the Do Not Contact field. Possible values: true, false. |
| organizationAccount.url |
|
|
| organizationAccount.login.username |
|
If username is provided, password must also be provided. |
| organizationAccount.login.password |
|
If password is provided, username must also be provided. |
| organizationAccount.login.orgId |
|
|
| organizationAccount.customFieldDataList.customFieldData.fieldId |
|
Retrieve possible account custom fields from the List Custom Fields request. |
| organizationAccount.customFieldDataList.customFieldData.fieldValue |
|
Required if the custom field type is a text field. |
| organizationAccount.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. |
| organizationAccount.source.id |
|
Possible values can be retrieved from the List Sources method. |
| organizationAccount.source.name |
|
Possible values can be retrieved from the List Sources method. |
| organizationAccount.existingOrganizationId |
|
Include the Account ID of an organization account to link this individual as a company contact. |
| organizationAccount.organizationTypes.organizationType.id |
|
Possible values can be retrieved from the List Organization Types method. |
| organizationAccount.organizationTypes.organizationType.name |
|
Possible values can be retrieved from the List Organization Types method. |
Error Codes
| Code |
Text |
Description |
| 10076 |
Organization account id is required. |
|
| 10077 |
Organization account id is invalid. |
|
