Exigo Web Services API v2022.12.19.1

 Search

GetCustomerSite

Returns the public web site info setup for a customer. Pass in CustomerID or WebAlias.

Input Properties

GetCustomerSiteRequest
PropertyData TypeNotes
WebAliasStringOptional.
CustomerIDInt32Optional. Unique numeric identifier for customer record.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

GetCustomerSiteResponse
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
WebAliasString
FirstNameString
LastNameString
CompanyString
Address1String
Address2String
CityString
State String
ZipString
Country String
EmailString
PhoneString
Phone2String
FaxString
Notes1String
Notes2String
Notes3String
Notes4String
Url1String
Url2String
Url3String
Url4String
Url5String
Url6String
Url7String
Url8String
Url9String
Url10String
Url1DescriptionString
Url2DescriptionString
Url3DescriptionString
Url4DescriptionString
Url5DescriptionString
Url6DescriptionString
Url7DescriptionString
Url8DescriptionString
Url9DescriptionString
Url10DescriptionString
Image1String
Image2String
ImageUrl1String
ImageUrl2String
CustomerKeyStringUnique alpha numeric identifier for customer record .

Http Request

GET https://yourcompany-api.exigo.com/3.0/customers/site?webAlias=1
  &customerID=1
  &customerKey=1
Authorization: Basic base64Encoded

Http Response

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


{
  "customerID": 1,
  "webAlias": "",
  "firstName": "",
  "lastName": "",
  "company": "",
  "address1": "",
  "address2": "",
  "city": "",
  "state": "",
  "zip": "",
  "country": "",
  "email": "",
  "phone": "",
  "phone2": "",
  "fax": "",
  "notes1": "",
  "notes2": "",
  "notes3": "",
  "notes4": "",
  "url1": "",
  "url2": "",
  "url3": "",
  "url4": "",
  "url5": "",
  "url6": "",
  "url7": "",
  "url8": "",
  "url9": "",
  "url10": "",
  "url1Description": "",
  "url2Description": "",
  "url3Description": "",
  "url4Description": "",
  "url5Description": "",
  "url6Description": "",
  "url7Description": "",
  "url8Description": "",
  "url9Description": "",
  "url10Description": "",
  "image1": "",
  "image2": "",
  "imageUrl1": "",
  "imageUrl2": "",
  "customerKey": "",
  "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: lifewave-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetCustomerSite"

<?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>
    <GetCustomerSiteRequest xmlns="http://api.exigo.com/">
      <WebAlias>string</WebAlias>
      <CustomerID>int</CustomerID>
      <CustomerKey>string</CustomerKey>
    </GetCustomerSiteRequest>
  </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>
    <GetCustomerSiteResult xmlns="http://api.exigo.com/">
      <CustomerID>int</CustomerID>
      <WebAlias>string</WebAlias>
      <FirstName>string</FirstName>
      <LastName>string</LastName>
      <Company>string</Company>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <City>string</City>
      <State>string</State>
      <Zip>string</Zip>
      <Country>string</Country>
      <Email>string</Email>
      <Phone>string</Phone>
      <Phone2>string</Phone2>
      <Fax>string</Fax>
      <Notes1>string</Notes1>
      <Notes2>string</Notes2>
      <Notes3>string</Notes3>
      <Notes4>string</Notes4>
      <Url1>string</Url1>
      <Url2>string</Url2>
      <Url3>string</Url3>
      <Url4>string</Url4>
      <Url5>string</Url5>
      <Url6>string</Url6>
      <Url7>string</Url7>
      <Url8>string</Url8>
      <Url9>string</Url9>
      <Url10>string</Url10>
      <Url1Description>string</Url1Description>
      <Url2Description>string</Url2Description>
      <Url3Description>string</Url3Description>
      <Url4Description>string</Url4Description>
      <Url5Description>string</Url5Description>
      <Url6Description>string</Url6Description>
      <Url7Description>string</Url7Description>
      <Url8Description>string</Url8Description>
      <Url9Description>string</Url9Description>
      <Url10Description>string</Url10Description>
      <Image1>string</Image1>
      <Image2>string</Image2>
      <ImageUrl1>string</ImageUrl1>
      <ImageUrl2>string</ImageUrl2>
      <CustomerKey>string</CustomerKey>
    </GetCustomerSiteResult>
  </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 GetCustomerSiteRequest();

 

    req.WebAlias = "1";

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

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

 

    //Send Request to Server and Get Response

    var res = await api.GetCustomerSiteAsync(req);

 

    //Now examine the results:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

}

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

    GetCustomerSiteRequest req = new GetCustomerSiteRequest();

 

    req.WebAlias = "1";

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

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

 

    //Send Request to Server and Get Response

    GetCustomerSiteResponse res = api.GetCustomerSite(req);

 

    //Now examine the results:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Console.WriteLine("CustomerKey: {0}", res.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 GetCustomerSiteRequest()

 

    req.WebAlias = "1"

    req.CustomerID = 1

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As GetCustomerSiteResponse = api.GetCustomerSite(req)

 

    'Now examine the results:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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->WebAlias = "1";

    $req->CustomerID = 1;

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

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

    GetCustomerSiteRequest req = new GetCustomerSiteRequest();

 

    req.setWebAlias("1");

    req.setCustomerID(1);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    GetCustomerSiteResponse res = api.getExigoApiSoap().getCustomerSite(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method supports CSV output.

HTTP Get Request:
https://lifewave-api.exigo.com/3.0/csv/?method=GetCustomerSite
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&WebAlias=String
&CustomerID=Nullable`1
&CustomerKey=String

Response Fields
CustomerID,WebAlias,FirstName,LastName,Company,Address1,Address2,City,State,Zip,Country,Email,Phone,Phone2,Fax,Notes1,Notes2,Notes3,Notes4,Url1,Url2,Url3,Url4,Url5,Url6,Url7,Url8,Url9,Url10,Url1Description,Url2Description,Url3Description,Url4Description,Url5Description,Url6Description,Url7Description,Url8Description,Url9Description,Url10Description,Image1,Image2,ImageUrl1,ImageUrl2,CustomerKey
Int32,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String,String