API v1 Reference

List Catalogs

REST

Request

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

Response

{
    "ListCatalogsResponse": {
        "operationResult": "SUCCESS",
        "responseMessage": "3 records found.",
        "responseDateTime": "2013-02-17T16:35:37.435-06:00",
        "catalogs": {
            "catalog": [
                {
                    "catalogId": 28,
                    "name": "nn",
                    "status": "Active"
                },
                {
                    "catalogId": 4,
                    "code": "EVNT",
                    "name": "Event",
                    "status": "Active",
                    "displaySequence": 1
                },
                {
                    "catalogId": 27,
                    "name": "Books",
                    "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:listcatalogsrequest>
             <usersessionid>T1361786551112</usersessionid>
          </neon:listcatalogsrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listcatalogsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>3 records found.</responsemessage>
         <responsedatetime>2013-02-25T04:02:34.488-06:00</responsedatetime>
         <catalogs>
            <catalog>
               <catalogid>4</catalogid>
               <code>EVNT</code>
               <name>Event</name>
               <status>Active</status>
               <displaysequence>1</displaysequence>
            </catalog>
            <catalog>
               <catalogid>27</catalogid>
               <name>Books</name>
               <status>Active</status>
               <displaysequence>1</displaysequence>
            </catalog>
            <catalog>
               <catalogid>26</catalogid>
               <name>Blork</name>
               <status>Active</status>
               <displaysequence>2</displaysequence>
            </catalog>
         </catalogs>
      </ns2:listcatalogsresponse>
   </soap:body>
</soap:envelope>

Response Parameters

Name Required Description
catalog.catalogId
catalog.code
catalog.name
catalog.descrption
catalog.status Possible values: Active, Inactive, Deleted
catalog.displaySequence