API v1 Reference

List Accounts by Default

This request is used to list accounts, while displaying the default return parameters. These return parameters cannot be configured.

REST

Request

https://api.neoncrm.com/neonws/services/api/account/listAccountsByDefault?userSessionId=[session id]&accountSearchCriteria.lastName=Johnson

Response

{    "listAccountsByDefaultResponse": {
    "operationResult": "SUCCESS",
    "responseDateTime": "2012-12-29T01:21:27.260-06:00",
    "page": {
        "currentPage": 0,
        "pageSize": 10,
        "totalPage": 0,
        "totalResults": 1,
        "sortColumn": "Account Id",
        "sortDirection": "ASC"},
    "searchResults": {
        "nameValuePairs": {
            "nameValuePair": [
                { "name": "State", "value": "IL" },
                { "name": "Company Department" },
                { "name": "Salutation" },
                { "name": "City", "value": "Oak Park" },
                { "name": "Country"},
                { "name": "Fax Number", "value": "" },
                { "name": "Source" },                    
                { "name": "User Gender", "value": "" },
                { "name": "Last Name", "value": "Johnson"" },
                { "name": "Address End Date" },                    
                { "name": "DOB Month" },                    
                { "name": "Middle Name", "value": ""  },                    
                { "name": "User URL" },                    
                { "name": "Street 3" },                    
                { "name": "Phone1 Number", "value": "445-9374" },                    
                { "name": "Phone2 Number", "value": "" },                    
                { "name": "Phone3 Type" },                    
                { "name": "User Email 3" },                    
                { "name": "First Name", "value": "Elaine" },                    
                { "name": "DOB Year" },                    
                { "name": "Account Login Name" },                    
                { "name": "County" },                    
                { "name": "Phone2 Type" },                    
                { "name": "Deceased", "value": "No" },                    
                { "name": "User Prefix", "value": "Ms." },                    
                { "name": "Address Type" },                    
                { "name": "User Suffix", "value": "" },                    
                { "name": "Zip Code", "value": 60302 },                    
                { "name": "DOB Day" },                    
                { "name": "Street 4" },                    
                { "name": "Province" },                    
                { "name": "Account Id", "value": 1683 },                    
                { "name": "Zip Suffix" },                   
                { "name": "Phone3 Number", "value": "" },                    
                { "name": "Street 1", "value": "431 Wisconsin" },                    
                { "name": "Phone1 Type" },                    
                { "name": "User Email 2" },                    
                { "name": "Company Title", "value": "" },                    
                { "name": "Street 2", "value": "2S" },                    
                { "name": "User Email 1", "value": "robotconnect@sbcglobal.net.z2" },                    
                { "name": "User Preferred Name" },                    
                { "name": "Address Start Date"  }                
                ]            
            }
        }
    }
}

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:listaccountsbydefaultrequest>
             <usersessionid>T1357624094982</usersessionid>
             <accountsearchcriteria>
                <firstname>john</firstname>
                <lastname>doe</lastname>
             </accountsearchcriteria>
             <page>
                <pagesize>10</pagesize>
             </page>
          </neon:listaccountsbydefaultrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listaccountsbydefaultresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsedatetime>2013-01-08T00:28:28.218-06:00</responsedatetime>
         <page>
            <currentpage>1</currentpage>
            <pagesize>10</pagesize>
            <totalpage>1</totalpage>
            <totalresults>4</totalresults>
         </page>
         <searchresults>
            <namevaluepairs>
               <namevaluepair>
                  <name>State</name>
                  <value>IL</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Company Department</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Salutation</name>
               </namevaluepair>
               <namevaluepair>
                  <name>City</name>
                  <value>Chicago</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Country</name>
                  <value>United States</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Fax Number</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Source</name>
               </namevaluepair>
               <namevaluepair>
                  <name>User Gender</name>
                  <value>Male</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Last Name</name>
                  <value>Doe</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Address End Date</name>
               </namevaluepair>
               <namevaluepair>
                  <name>DOB Month</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Middle Name</name>
               </namevaluepair>
               <namevaluepair>
                  <name>User URL</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Street 3</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Phone1 Number</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Phone2 Number</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Phone3 Type</name>
               </namevaluepair>
               <namevaluepair>
                  <name>User Email 3</name>
               </namevaluepair>
               <namevaluepair>
                  <name>First Name</name>
                  <value>John</value>
               </namevaluepair>
               <namevaluepair>
                  <name>DOB Year</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Account Login Name</name>
               </namevaluepair>
               <namevaluepair>
                  <name>County</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Phone2 Type</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Deceased</name>
                  <value>No</value>
               </namevaluepair>
               <namevaluepair>
                  <name>User Prefix</name>
                  <value>Mr.</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Address Type</name>
                  <value>1</value>
               </namevaluepair>
               <namevaluepair>
                  <name>User Suffix</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Zip Code</name>
                  <value>60601</value>
               </namevaluepair>
               <namevaluepair>
                  <name>DOB Day</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Street 4</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Province</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Account Id</name>
                  <value>5781</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Zip Suffix</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Phone3 Number</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Street 1</name>
                  <value>unit 3, 26 Hercules Street</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Phone1 Type</name>
               </namevaluepair>
               <namevaluepair>
                  <name>User Email 2</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Company Title</name>
               </namevaluepair>
               <namevaluepair>
                  <name>Street 2</name>
               </namevaluepair>
               <namevaluepair>
                  <name>User Email 1</name>
               </namevaluepair>
               <namevaluepair>
                  <name>User Preferred Name</name>
                  <value>John</value>
               </namevaluepair>
               <namevaluepair>
                  <name>Address Start Date</name>
               </namevaluepair>
            </namevaluepairs>
            ...
         </searchresults>
      </ns2:listaccountsbydefaultresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
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.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
nameValuePair.name The name of the field.
nameValuePair.value The value of the field.