Exigo Web Services API v2024.9.6.6

 Search

GetDestinations

Gets destinations.

Input Properties

GetDestinationsRequest
PropertyData TypeNotes
DestinationIDInt32Optional. Leave empty to fetch all.

Output Properties

GetDestinationsResponse
PropertyData TypeNotes
DestinationsDestination[]
Destination
PropertyData TypeNotes
DestinationIDInt32
NameString
EnabledBoolean
ConnectionStringString
ModifiedByString
ModifiedDateDateTime
AlertSettingsAlertSettings
ReIndexSettingsReIndexSettings

Http Request

GET https://yourcompany-api.exigo.com/3.0/destinationAuthorization: Basic base64Encoded

Http Response

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


{
  "destinations": null,
  "result": null
}

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: sandboxapi2.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetDestinations"

<?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>
    <GetDestinationsRequest xmlns="http://api.exigo.com/">
      <DestinationID>int</DestinationID>
    </GetDestinationsRequest>
  </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>
    <GetDestinationsResult xmlns="http://api.exigo.com/">
      <Destinations>
        <Destination>
          <DestinationID>int</DestinationID>
          <Name>string</Name>
          <Enabled>boolean</Enabled>
          <ConnectionString>string</ConnectionString>
          <ModifiedBy>string</ModifiedBy>
          <ModifiedDate>dateTime</ModifiedDate>
          <AlertSettings>
            <AlertOptIn>boolean</AlertOptIn>
            <AlertEmail>
              <string>string</string>
            </AlertEmail>
            <AlertPhone>
              <string>string</string>
            </AlertPhone>
          </AlertSettings>
          <ReIndexSettings>
            <ReIndexStartTime>dateTime</ReIndexStartTime>
            <ReIndexMaxDuration>int</ReIndexMaxDuration>
            <LastReIndexed>dateTime</LastReIndexed>
          </ReIndexSettings>
        </Destination>
      </Destinations>
    </GetDestinationsResult>
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new GetDestinationsRequest();

 

 

    //Send Request to Server and Get Response

    var res = await api.GetDestinationsAsync(req);

 

    //Now examine the results:

 

    foreach (var destination in res.Destinations)

    {

        Console.WriteLine("DestinationID: {0}", destination.DestinationID);

        Console.WriteLine("Name: {0}", destination.Name);

        Console.WriteLine("Enabled: {0}", destination.Enabled);

        Console.WriteLine("ConnectionString: {0}", destination.ConnectionString);

        Console.WriteLine("ModifiedBy: {0}", destination.ModifiedBy);

        Console.WriteLine("ModifiedDate: {0}", destination.ModifiedDate);

        Console.WriteLine("AlertSettings: {0}", destination.AlertSettings);

        Console.WriteLine("ReIndexSettings: {0}", destination.ReIndexSettings);

    }

}

catch (Exception ex)

{

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

}

C# Soap Client

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

    GetDestinationsRequest req = new GetDestinationsRequest();

 

 

    //Send Request to Server and Get Response

    GetDestinationsResponse res = api.GetDestinations(req);

 

    //Now examine the results:

 

    foreach (Destination destination in res.Destinations)

    {

        Console.WriteLine("DestinationID: {0}", destination.DestinationID);

        Console.WriteLine("Name: {0}", destination.Name);

        Console.WriteLine("Enabled: {0}", destination.Enabled);

        Console.WriteLine("ConnectionString: {0}", destination.ConnectionString);

        Console.WriteLine("ModifiedBy: {0}", destination.ModifiedBy);

        Console.WriteLine("ModifiedDate: {0}", destination.ModifiedDate);

        Console.WriteLine("AlertSettings: {0}", destination.AlertSettings);

        Console.WriteLine("ReIndexSettings: {0}", destination.ReIndexSettings);

    }

}

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

 

 

    'Send Request to Server and Get Response

    Dim res As GetDestinationsResponse = api.GetDestinations(req)

 

    'Now examine the results:

 

    For Each destination As Destination In res.Destinations

        Console.WriteLine("DestinationID: {0}", destination.DestinationID)

        Console.WriteLine("Name: {0}", destination.Name)

        Console.WriteLine("Enabled: {0}", destination.Enabled)

        Console.WriteLine("ConnectionString: {0}", destination.ConnectionString)

        Console.WriteLine("ModifiedBy: {0}", destination.ModifiedBy)

        Console.WriteLine("ModifiedDate: {0}", destination.ModifiedDate)

        Console.WriteLine("AlertSettings: {0}", destination.AlertSettings)

        Console.WriteLine("ReIndexSettings: {0}", destination.ReIndexSettings)

    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

 

 

    //Send Request to Server and Get Response

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

    GetDestinationsRequest req = new GetDestinationsRequest();

 

 

    //Send Request to Server and Get Response

    GetDestinationsResponse res = api.getExigoApiSoap().getDestinations(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.