Peoplevox
Submit an Idea

Exporting Data

The following article provides information on the two methods used together to export data from the WMS.

Note: We generally recommend using Event Subscriptions wherever possible and considering these as methods of last resort.

GetData

The GetData method is used to export data from the Warehouse Management System (WMS). The page number and number of items per page parameters are used to repeat the same method to return pages of information. If you wish to receive all data in one call set ItemsPerPage value to 0.

Parameters:

GetRequest object

Return value:

IntegrationResponse object.

  • ResponseId , 0 if call has succeeded, -1 if failed

  • Detail: Contains data in CSV format if the call has succeeded, otherwise it will contain the error detail.

  • TotalCount: Total number of records available in the WMS system. For example, if you call the GetData for the item types template, it will return the total number of item types you have in WMS System.

Placeholders string and int need to be replaced by actual values:

POST /clientid/Resources/IntegrationServicev4.asmx HTTP/1.1
Host: string
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.peoplevox.net/GetData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<UserSessionCredentials xmlns="http://www.peoplevox.net/">
<UserId>int</UserId>
<clientId>string</clientId>
<SessionId>string</SessionId>
</UserSessionCredentials>
</soap:Header>
<soap:Body>
<GetData xmlns="http://www.peoplevox.net/">
<getRequest>
<TemplateName>string</TemplateName>
<PageNo>int</PageNo>
<ItemsPerPage>int</ItemsPerPage>
<SearchClause>string</SearchClause>
</getRequest>
</GetData>
</soap:Body>
</soap:Envelope>

POST /clientid/Resources/IntegrationServicev4.asmx HTTP/1.1
Host: string  
Content-Type: text/xml; charset=utf-8 
SOAPAction: "http://www.peoplevox.net/GetData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
  <UserSessionCredentials xmlns="http://www.peoplevox.net/">
   <UserId>int</UserId>
   <clientId>string</clientId>
   <SessionId>string</SessionId>
  </UserSessionCredentials>
</soap:Header>
<soap:Body>
  <GetData xmlns="http://www.peoplevox.net/"> 
   <getRequest>
    <TemplateName>string</TemplateName>
    <PageNo>int</PageNo>
    <ItemsPerPage>int</ItemsPerPage>
    <SearchClause>string</SearchClause>
   </getRequest>
  </GetData>
</soap:Body>
</soap:Envelope> 


The WMS will send back a response as follows:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
  <GetDataResponse xmlns="http://www.peoplevox.net/">
   <GetDataResult>
    <ResponseId>int</ResponseId>
    <TotalCount>int</TotalCount>
    <Detail>string</Detail>
   </GetDataResult>
  </GetDataResponse>
</soap:Body>
</soap:Envelope> 


C# Example

var response = service.GetData(new GetRequest
{
    ItemsPerPage = 0,
    PageNo = 1,
    SearchClause = "Barcode.StartsWith("1")",
    TemplateName = "Item types"
});


GetReportData

The GetReportData method can be used to export data from the Warehouse Management System (WMS) using a system report template. The page number and number of items per page parameters are used to repeat the same method to return pages of information. The benefits are that you can export information over many database tables whereas the GetData method will only export information in one table.

If you wish to receive all data in one call set ItemsPerPage value to 0.

Parameters:

Return value:

IntegrationResponse object.

  • ResponseId , 0 if call has succeeded, -1 if failed

  • Detail: Contains data in CSV format if the call has succeeded, otherwise it will contain the error detail.

  • TotalCount: Total number of records available in the WMS system. For example, if you call the GetData for the item types template, it will return the total number of item types you have in WMS System.

  • Statuses: Provides a status of “Error” or “Success” for any references in the report to other tables.

Placeholders string and int need to be replaced by actual values:

POST /clientid/resources/integrationservicev4.asmx HTTP/1.1 Host: peoplevox.net
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://www.peoplevox.net/GetReportData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
  <UserSessionCredentials xmlns="http://www.peoplevox.net/">
   <UserId>int</UserId>
   <ClientId>string</ClientId>
   <SessionId>string</SessionId>
  </UserSessionCredentials>
</soap:Header>
<soap:Body>
  <GetReportData xmlns="http://www.peoplevox.net/">
   <getReportRequest>
    <TemplateName>string</TemplateName>
    <SearchClause>string</SearchClause>
    <ItemsPerPage>int</ItemsPerPage>
    <FilterClause>string</FilterClause>
    <OrderBy>string</OrderBy>
    <Columns>string</Columns>
   </getReportRequest>
  </GetReportData>
</soap:Body>
</soap:Envelope> 


The WMS will send back a response as follows:

HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
  <GetReportDataResponse xmlns="http://www.peoplevox.net/">
   <GetReportDataResult>
    <ResponseId>int</ResponseId>
    <TotalCount>int</TotalCount>
    <Detail>string</Detail>
    <Statuses>
     <IntegrationStatusResponse>
      <Reference>string</Reference>
      <Status>Error or Success</Status>
     </IntegrationStatusResponse>
     <IntegrationStatusResponse>
      <Reference>string</Reference>
      <Status>Error or Success</Status>
     </IntegrationStatusResponse>
    </Statuses>
   </GetReportDataResult>
  </GetReportDataResponse>
</soap:Body>
</soap:Envelope> 


C# Example

var response = service.GetReportData(new GetReportRequest
{
    TemplateName = "Item movement history",
    PageNo = 1,
    ItemsPerPage = 0,
    OrderBy = "[Date timestamp]",
    Columns = "[Item code],[Date timestamp],[From],[To],[Quantity],[Comments]",
    SearchClause = "([Date timestamp] > DateTime(" +
    searchStockTime.ToString("yyyy,MM,dd,HH,mm,ss") + "))"
};); 


Back to Top