Exigo Web Services API v2019.7.11.2

GetFiles

Returns an array of files

Note: This request can participate in a transaction. Learn more about transactions.

Input Properties

GetFilesRequest
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exception will occur if CustomerID & CustomerKey are provided.
ParentFolderIDInt32Optional. Unique numeric identifier for folder to get files from. Defaults to customer's root.

Output Properties

GetFilesResponse
PropertyData TypeNotes
FileCountInt32Count of files returned.
ParentFolderIDInt32Unique numeric identifier of the file's parent folder.
ParentFolderNameStringName of the file's parent folder.
CustomerFileListCustomerFilesResponse[]List of files containing the FileName, FileID, and customer identifier for each file found.
CustomerFilesResponse
PropertyData TypeNotes
FileNameStringName of destination file in Customers folder (do not include path).
FileIDInt32The ID of a successfully created customer file.
CustomerIDInt32Unique numeric identifier for customer record.
CustomerKeyStringUnique alpha numeric identifier for customer record .

SOAP Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/GetFiles"

<?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> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <GetFilesRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <CustomerKey>string</CustomerKey> <ParentFolderID>int</ParentFolderID> </GetFilesRequest> </soap:Body> </soap:Envelope>

SOAP Response

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

<?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> <GetFilesResult xmlns="http://api.exigo.com/"> <FileCount>int</FileCount> <ParentFolderID>int</ParentFolderID> <ParentFolderName>string</ParentFolderName> <CustomerFileList> <CustomerFilesResponse> <FileName>string</FileName> <FileID>int</FileID> <CustomerID>int</CustomerID> <CustomerKey>string</CustomerKey> </CustomerFilesResponse> </CustomerFileList> </GetFilesResult> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    GetFilesRequest req = new GetFilesRequest();

 

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exception will occur if CustomerID & CustomerKey are provided.

    req.ParentFolderID = 1;         //Unique numeric identifier for folder to get files from. Defaults to customer's root.

 

    //Send Request to Server and Get Response

    GetFilesResponse res = api.GetFiles(req);

 

    //Now examine the results:

    Console.WriteLine("FileCount: {0}", res.FileCount);

    Console.WriteLine("ParentFolderID: {0}", res.ParentFolderID);

    Console.WriteLine("ParentFolderName: {0}", res.ParentFolderName);

 

    foreach (CustomerFilesResponse customerFiles in res.CustomerFileList)

    {

        Console.WriteLine("FileName: {0}", customerFiles.FileName);

        Console.WriteLine("FileID: {0}", customerFiles.FileID);

        Console.WriteLine("CustomerID: {0}", customerFiles.CustomerID);

        Console.WriteLine("CustomerKey: {0}", customerFiles.CustomerKey);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new GetFilesRequest()

 

    req.CustomerID = 1

    req.CustomerKey = "1"

    req.ParentFolderID = 1

 

    'Send Request to Server and Get Response

    Dim res As GetFilesResponse = api.GetFiles(req)

 

    'Now examine the results:

    Console.WriteLine("FileCount: {0}", res.FileCount)

    Console.WriteLine("ParentFolderID: {0}", res.ParentFolderID)

    Console.WriteLine("ParentFolderName: {0}", res.ParentFolderName)

 

    For Each customerFiles As CustomerFilesResponse In res.CustomerFileList

        Console.WriteLine("FileName: {0}", customerFiles.FileName)

        Console.WriteLine("FileID: {0}", customerFiles.FileID)

        Console.WriteLine("CustomerID: {0}", customerFiles.CustomerID)

        Console.WriteLine("CustomerKey: {0}", customerFiles.CustomerKey)

    Next

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->CustomerID = 1;

    $req->CustomerKey = "1";

    $req->ParentFolderID = 1;

 

    //Send Request to Server and Get Response

    $res = $api.GetFiles($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    GetFilesRequest req = new GetFilesRequest();

 

    req.setCustomerID(1);

    req.setCustomerKey("1");

    req.setParentFolderID(1);

 

    //Send Request to Server and Get Response

    GetFilesResponse res = api.getExigoApiSoap().getFiles(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.