Exigo Web Services API v2022.12.19.1

 Search

AppendCustomerNotes

Appends a specified value to the specified Customer's Notes record

Note: This request can participate in a transaction. Learn more about transactions.

Input Properties

AppendCustomerNotesRequest
PropertyData TypeNotes
NotesStringOptional. Value to be appended to Customer Notes.
CustomerIDInt32Unique numeric identifier for customer record.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

AppendCustomerNotesResponse
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
CustomerKeyStringUnique alpha numeric identifier for customer record .

Http Request

PATCH https://yourcompany-api.exigo.com/3.0/customers/notes HTTP/1.1
Content-Type: application/json
Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword)


{
  "customerID": 1,
  "customerKey": "1"
}

Http Response

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


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

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

 

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

 

    //Now examine the results:

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

    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

    AppendCustomerNotesRequest req = new AppendCustomerNotesRequest();

 

    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

    AppendCustomerNotesResponse res = api.AppendCustomerNotes(req);

 

    //Now examine the results:

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

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

 

    req.CustomerID = 1

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As AppendCustomerNotesResponse = api.AppendCustomerNotes(req)

 

    'Now examine the results:

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

    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->CustomerID = 1;

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

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

    AppendCustomerNotesRequest req = new AppendCustomerNotesRequest();

 

    req.setCustomerID(1);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    AppendCustomerNotesResponse res = api.getExigoApiSoap().appendCustomerNotes(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.