Exigo Web Services API v2022.12.19.1

GetCustomerNotes

Returns the notes field for one or more customers that match the filter critera passed in.

Input Properties

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

Output Properties

GetCustomerNotesResponse
PropertyData TypeNotes
CustomerNotesCustomerNotesResponse[]
CustomerNotesResponse
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
NotesString
CustomerKeyStringUnique alpha numeric identifier for customer record .

Http Request

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

Http Response

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

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

<?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> <GetCustomerNotesRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <CustomerKey>string</CustomerKey> </GetCustomerNotesRequest> </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> <GetCustomerNotesResult xmlns="http://api.exigo.com/"> <CustomerNotes> <CustomerNotesResponse> <CustomerID>int</CustomerID> <Notes>string</Notes> <CustomerKey>string</CustomerKey> </CustomerNotesResponse> </CustomerNotes> </GetCustomerNotesResult> </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 GetCustomerNotesRequest();

 

    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.GetCustomerNotesAsync(req);

 

    //Now examine the results:

 

    foreach (var customerNotes in res.CustomerNotes)

    {

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

        Console.WriteLine("Notes: {0}", customerNotes.Notes);

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

    GetCustomerNotesRequest req = new GetCustomerNotesRequest();

 

    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

    GetCustomerNotesResponse res = api.GetCustomerNotes(req);

 

    //Now examine the results:

 

    foreach (CustomerNotesResponse customerNotes in res.CustomerNotes)

    {

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

        Console.WriteLine("Notes: {0}", customerNotes.Notes);

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

 

    req.CustomerID = 1

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As GetCustomerNotesResponse = api.GetCustomerNotes(req)

 

    'Now examine the results:

 

    For Each customerNotes As CustomerNotesResponse In res.CustomerNotes

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

        Console.WriteLine("Notes: {0}", customerNotes.Notes)

        Console.WriteLine("CustomerKey: {0}", customerNotes.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";

 

    //Send Request to Server and Get Response

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

    GetCustomerNotesRequest req = new GetCustomerNotesRequest();

 

    req.setCustomerID(1);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    GetCustomerNotesResponse res = api.getExigoApiSoap().getCustomerNotes(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://api.exigo.com/3.0/csv/?method=GetCustomerNotes
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&CustomerID=Int32
&CustomerKey=String

Response Fields
CustomerID,Notes,CustomerKey
Int32,String,String