Exigo Web Services API v2019.7.9.1

GetCustomerFolders

Gets a list of customer folders.

Input Properties

GetCustomerFoldersRequest
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 the parent folder to fetch from. Defaults to customer's root.

Output Properties

GetCustomerFoldersResponse
PropertyData TypeNotes
FolderCountInt32Count of folders returned.
ParentFolderIDInt32Unique numeric ID of the parent folder.
ParentFolderNameStringName of the parent folder.
CustomerFolderListCustomerFoldersResponse[]List of folders containing the FolderID, FolderName, and count of SubFolders and SubFiles contained by each folder.
CustomerFoldersResponse
PropertyData TypeNotes
FolderIDInt32
FolderNameString
SubFoldersCountInt32
SubFilesCountInt32

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/GetCustomerFolders"

<?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> <GetCustomerFoldersRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <CustomerKey>string</CustomerKey> <ParentFolderID>int</ParentFolderID> </GetCustomerFoldersRequest> </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> <GetCustomerFoldersResult xmlns="http://api.exigo.com/"> <FolderCount>int</FolderCount> <ParentFolderID>int</ParentFolderID> <ParentFolderName>string</ParentFolderName> <CustomerFolderList> <CustomerFoldersResponse> <FolderID>int</FolderID> <FolderName>string</FolderName> <SubFoldersCount>int</SubFoldersCount> <SubFilesCount>int</SubFilesCount> </CustomerFoldersResponse> </CustomerFolderList> </GetCustomerFoldersResult> </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

    GetCustomerFoldersRequest req = new GetCustomerFoldersRequest();

 

 

    //Send Request to Server and Get Response

    GetCustomerFoldersResponse res = api.GetCustomerFolders(req);

 

    //Now examine the results:

}

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 GetCustomerFoldersRequest()

 

 

    'Send Request to Server and Get Response

    Dim res As GetCustomerFoldersResponse = api.GetCustomerFolders(req)

 

    'Now examine the results:

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

 

 

    //Send Request to Server and Get Response

    $res = $api.GetCustomerFolders($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

    GetCustomerFoldersRequest req = new GetCustomerFoldersRequest();

 

 

    //Send Request to Server and Get Response

    GetCustomerFoldersResponse res = api.getExigoApiSoap().getCustomerFolders(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.