API Results

From Developer's API

(Difference between revisions)
(→Error Data)
Line 2: Line 2:
  
 
== List Data ==
 
== List Data ==
 +
Example list response
 +
 +
<pre>
 +
<Response success="true" xmlns:xlink="http://www.w3.org/1999/xlink">
 +
    <NextRecordSet>
 +
        <LimitCount>10</LimitCount>
 +
        <LimitOffset>20</LimitOffset>
 +
        <LimitStartDate>01/01/2007</LimitStartDate>
 +
        <LimitEndDate>12/31/2007 23:59:59</LimitEndDate>
 +
        <SortColumn>SomeField</SortColumn>
 +
        <SortOrder>DESC</SortOrder>
 +
    </NextRecordSet>
 +
    <Orders>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459428">173459428</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459427">173459427</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459426">173459426</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459421">173459421</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459419">173459419</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459415">173459415</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459413">173459413</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459315">173459315</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459278">173459278</Order>
 +
        <Order xlink:href="https://localhost/API/118303/Orders/173459276">173459276</Order>
 +
    </Orders>
 +
</Response>
 +
</pre>
  
 
== Detail Data ==
 
== Detail Data ==
  
 
== Error Data ==
 
== Error Data ==
−
:Typical Error Response
+
Example error response
  
−
:<pre><Response success="false">
+
<pre>
 +
<Response success="false">
 
   <Error code="1001">No data found</Error>
 
   <Error code="1001">No data found</Error>
−
</Response></pre>
+
</Response>
 +
</pre>

Revision as of 14:09, 27 May 2008

Something here....

List Data

Example list response 

<Response success="true" xmlns:xlink="http://www.w3.org/1999/xlink">
    <NextRecordSet>
        <LimitCount>10</LimitCount>
        <LimitOffset>20</LimitOffset>
        <LimitStartDate>01/01/2007</LimitStartDate>
        <LimitEndDate>12/31/2007 23:59:59</LimitEndDate>
        <SortColumn>SomeField</SortColumn>
        <SortOrder>DESC</SortOrder>
    </NextRecordSet>
    <Orders>
        <Order xlink:href="https://localhost/API/118303/Orders/173459428">173459428</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459427">173459427</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459426">173459426</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459421">173459421</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459419">173459419</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459415">173459415</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459413">173459413</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459315">173459315</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459278">173459278</Order>
        <Order xlink:href="https://localhost/API/118303/Orders/173459276">173459276</Order>
    </Orders>
</Response>

Detail Data

Error Data

Example error response 

<Response success="false">
   <Error code="1001">No data found</Error>
</Response>
Retrieved from "http://api.1shoppingcart.com/index.php?title=API_Results"