GetHistoryExport

API Overview
Updated on
 
Delivers a list of all export processes carried out (export history) for the stated program
and the tracking type.

Input

<GetHistoryExport xmlns="http://services.zanox.com/erp">
    <programid>10</programid>
    <trackingtype>3</trackingtype>
    <rowcount>20></rowcount>
</GetHistoryExport>

 

Object Data type Description Mandatory?
<programid> int
ID of the program whose history will
be retrieved
 x
<trackingtype> unsignedbyte
ID of the tracking type for which the
data will be retrieved
 x
<rowcount> int
Number of displayed entries (with 0, all
will be displayed)
  

 

Output

<GetHistoryExportResponse xmlns="http://services.zanox.com/erp">
    <historydata>
        <history id="10424020" trackingtype="3" programid="10" xmlns="http://services.zanox.com/erp/Export">
            <created>2005-05-01T12:05:33+02:00</created>
            <records>1234</records>
            <filteredby>
                <period from="2004-12-01T00:00:00+02:00"
                        to="2004-12-31T23:00:00+02:00"/>
                <reviewstate negate="1">1</reviewstate>
                <categoryid>TestKat</categoryid>
                <orderid>22</orderid>
            </filteredby>
        </history>
        ...
    </historydata>
</GetHistoryExportResponse>

 

Object Data type Description
<historydata>   Contains n elements <history> as children
<history>    
id int ID of the export process
programid int
ID of the program for which the export was
executed
trackingtype unsignedbyte Tracking type for which the dataset was tracked
<created> datetime Time stamp of the export
<records> int Number of exported datasets
<filteredby>  
Filter criteria, which were applied during the
export
<period>    
from datetime Most recent time stamp of the dataset
to datetime Oldest possible time stamp of the dataset
<reviewstate>  
Review status of the dataset (only stated if the
history entry was created via GetPps or GetPpl)
negate boolean
Criterion <reviewstate> was
• 0 = not be negated
• 1 = negated
<categoryid> normalizedstring Category ID of the dataset (only stated if the
history entry was created via GetPps or GetPpl)
negate boolean
Criterion <categoryid> was
• 0 = not be negated
• 1 = negated
<orderid> normalizedstring Order ID of the dataset (only stated if the
history entry was created via GetPps or GetPpl)
negate boolean
Criterion <orderid> was
• 0 = not be negated
• 1 = negated
 
If the value of the "negate" attribute of the <reviewstate>, <categoryid> or <orderid>
elements is "1", all datasets that did not correspond with the condition will be exported.

 

Resource Information

Rate Limited? No
Requests per rate limit window N/A
Authentication Requires Authentication
Response Formats xml
Resource family historydata
Response Object history
API Version 3.0.1.1