API v1 Reference

List Categories

REST

Request

https://api.neoncrm.com/neonws/services/api/store/listCategories?userSessionId=[session id]

Response

{
    "ListCategoriesResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "3 records found.",
        "responseDateTime": "2013-02-17T19:52:58.305-06:00",
        "categories": {
            "category": [
                {
                    "categoryId": 13,
                    "code": "AAA",
                    "name": "Listting",
                    "description": "",
                    "status": "Active"
                },
                {
                    "categoryId": 12,
                    "code": "sta",
                    "name": "Stationery",
                    "description": "things needed for writing, such as paper, pens, pencils and envelopes",
                    "status": "Active"
                },
                {
                    "categoryId": 11,
                    "code": "AI",
                    "name": "Auction Items 2008",
                    "description": "",
                    "status": "Active",
                    "displaySequence": 1
                }
            ]
        }
    }
}

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:listcategoriesrequest>
             <usersessionid>T1361786551112</usersessionid>
          </neon:listcategoriesrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listcategoriesresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>3 records found.</responsemessage>
         <responsedatetime>2013-02-25T04:05:08.657-06:00</responsedatetime>
         <categories>
            <category>
               <categoryid>12</categoryid>
               <code>sta</code>
               <name>Stationery</name>
               <description>things needed for writing, such as paper, pens, pencils and envelopes</description>
               <status>Active</status>
            </category>
            <category>
               <categoryid>11</categoryid>
               <code>AI</code>
               <name>Auction Items 2008</name>
               <description>
               <status>Active</status>
               <displaysequence>1</displaysequence>
            </description></category>
            <category>
               <categoryid>1</categoryid>
               <code>BK</code>
               <name>Book</name>
               <description>
               <status>Active</status>
               <displaysequence>2</displaysequence>
            </description></category>
         </categories>
      </ns2:listcategoriesresponse>
   </soap:body>
</soap:envelope>

Response Parameters

Name Required Description
category.categoryId Yes
category.name
category.code
category.description
category.status
category.displaySequence