List Accounts by Search Criteria (Deprecated)

Deprecation Warning: Support for this method has been deprecated. Use List Accounts instead.

This is a simplified and faster version of listAccounts. It has pre-set output columns and a limited set of search criteria, shown below.

REST

Request

https://api.neoncrm.com/neonws/services/api/account/listAccountsBySearchCriteria?userSessionId=[session id]&accountSearchCriteria.userType=Individual&accountSearchCriteria.FirstName=joe

Response

{
    "listAccountsBySearchCriteriaResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2014-04-10T16:37:22.338+08:00",
        "accountSearchResults": {
            "accountSearchResult": [
                {
                    "accountId": 99748,
                    "firstName": "Hudson, Joe (Leon)",
                    "userType": "Individual"
                },
                {
                    "accountId": 99752,
                    "firstName": "Hyde, Joe",
                    "userType": "Individual"
                },
                {
                    "accountId": 115659,
                    "firstName": "Joe",
                    "lastName": "",
                    "userType": "Individual"
                },
                {
                    "accountId": 115693,
                    "firstName": "Joey",
                    "lastName": "",
                    "userType": "Individual"
                },
                {
                    "accountId": 98406,
                    "firstName": "Joe",
                    "lastName": "Armstrong",
                    "email": "support@z2systems.com.z2",
                    "userType": "Individual"
                },
                {
                    "accountId": 101432,
                    "firstName": "Joe",
                    "lastName": "Average",
                    "organizationName": "The Example Foundation",
                    "email": "joe@example.org.z2",
                    "userType": "Individual"
                },
                {
                    "accountId": 97814,
                    "firstName": "Joe",
                    "lastName": "B",
                    "email": "",
                    "userType": "Individual"
                },
                {
                    "accountId": 98654,
                    "firstName": "Joe",
                    "lastName": "B",
                    "email": "",
                    "userType": "Individual"
                }
            ]
        },
        "page": {
            "currentPage": 1,
            "pageSize": 10,
            "totalPage": 7,
            "totalResults": 63
        }
    }
}

Request Parameters

Name	Required	Description
accountSearchCriteria.userType	Yes	Search for either individual accounts or organization accounts. Possible values: Individual, Organization.
accountSearchCriteria.accountId		Search for accounts by their Account ID.
accountSearchCriteria.firstName		Search for accounts by their First Name.
accountSearchCriteria.lastName		Search for accounts by their Last Name.
accountSearchCriteria.organizationName		Search for accounts by their Organization Name.
accountSearchCriteria.email		Search for accounts by their Email.
page.currentPage		Request a specific page of results.
page.pageSize		Specify the number of results in this page.
page.sortColumn		Sort results by the specified column (see response parameters for options).
page.sortDirection		Possible values: ASC, DESC.

Response Parameters

Name	Required	Description
accountSearchResult.userType	Yes	Individual or Organization
accountSearchResult.accountId	Yes
accountSearchResult.firstName
accountSearchResult.lastName
accountSearchResult.organizationName
accountSearchResult.email
page.currentPage
page.pageSize
page.totalPage
page.totalResults
page.sortColumn
page.sortDirection

Error Codes

Code	Text	Description
10231	User type is invalid.	User type must be Individual or Organization.
10232	User type is required.	You must supply a user type in your request.
10230	Account search criteria is required.	Your request must include at least one criterion. This could be account ID, first name, last name, or email.