Exigo Web Services API v2022.12.19.1

 Search

GetAdminWhitelist

Get List of Whitelisted IP ranges for Admin

Input Properties

GetAdminWhitelistRequest
PropertyData TypeNotes
IpRangeIDInt32Optional. Optionally provide an IpRangeID to return only that range.

Output Properties

GetAdminWhitelistResponse
PropertyData TypeNotes
WhitelistRangesAdminWhitelistResponse[]
AdminWhitelistResponse
PropertyData TypeNotes
IpRangeIDInt32
MinIPString
MaxIPString

Http Request

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

Http Response

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


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

<?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>
    <GetAdminWhitelistRequest xmlns="http://api.exigo.com/">
      <IpRangeID>int</IpRangeID>
    </GetAdminWhitelistRequest>
  </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>
    <GetAdminWhitelistResult xmlns="http://api.exigo.com/">
      <WhitelistRanges>
        <AdminWhitelistResponse>
          <IpRangeID>int</IpRangeID>
          <MinIP>string</MinIP>
          <MaxIP>string</MaxIP>
        </AdminWhitelistResponse>
      </WhitelistRanges>
    </GetAdminWhitelistResult>
  </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 GetAdminWhitelistRequest();

 

 

    //Send Request to Server and Get Response

    var res = await api.GetAdminWhitelistAsync(req);

 

    //Now examine the results:

 

    foreach (var adminWhitelist in res.WhitelistRanges)

    {

        Console.WriteLine("IpRangeID: {0}", adminWhitelist.IpRangeID);

        Console.WriteLine("MinIP: {0}", adminWhitelist.MinIP);

        Console.WriteLine("MaxIP: {0}", adminWhitelist.MaxIP);

    }

}

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

    GetAdminWhitelistRequest req = new GetAdminWhitelistRequest();

 

 

    //Send Request to Server and Get Response

    GetAdminWhitelistResponse res = api.GetAdminWhitelist(req);

 

    //Now examine the results:

 

    foreach (AdminWhitelistResponse adminWhitelist in res.WhitelistRanges)

    {

        Console.WriteLine("IpRangeID: {0}", adminWhitelist.IpRangeID);

        Console.WriteLine("MinIP: {0}", adminWhitelist.MinIP);

        Console.WriteLine("MaxIP: {0}", adminWhitelist.MaxIP);

    }

}

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

 

 

    'Send Request to Server and Get Response

    Dim res As GetAdminWhitelistResponse = api.GetAdminWhitelist(req)

 

    'Now examine the results:

 

    For Each adminWhitelist As AdminWhitelistResponse In res.WhitelistRanges

        Console.WriteLine("IpRangeID: {0}", adminWhitelist.IpRangeID)

        Console.WriteLine("MinIP: {0}", adminWhitelist.MinIP)

        Console.WriteLine("MaxIP: {0}", adminWhitelist.MaxIP)

    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.GetAdminWhitelist($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

    GetAdminWhitelistRequest req = new GetAdminWhitelistRequest();

 

 

    //Send Request to Server and Get Response

    GetAdminWhitelistResponse res = api.getExigoApiSoap().getAdminWhitelist(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.