Exigo Web Services API v2018.11.7.5

SetCustomerSiteImage

Setup public web site image for an existing customer.

Input Properties

SetCustomerSiteImageRequest
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
ImageNameStringThe image's file name.
ImageDataByte[]The image's data.
CustomerSiteImageType CustomerSiteImageTypeOptional. The desired image slot. Defaults to 0.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

SetCustomerSiteImageResponse
PropertyData TypeNotes

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: "http://api.exigo.com/SetCustomerSiteImage"

<?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> <SetCusotmerSiteImageRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <ImageName>string</ImageName> <ImageData>base64Binary</ImageData> <CustomerSiteImageType>Primary or Secondary</CustomerSiteImageType> <CustomerKey>string</CustomerKey> </SetCusotmerSiteImageRequest> </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> <SetCustomerSiteImageResult xmlns="http://api.exigo.com/" /> </soap:Body> </soap:Envelope>

C#

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

    SetCustomerSiteImageRequest req = new SetCustomerSiteImageRequest();

 

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

    req.ImageName = "1";            //The image's file name

 

    //Add ImageData

    List<Byte> imagedata = new List<Byte>();

    imagedata.Add(1);

    imagedata.Add(2);

 

    //Now attach the list to the request

    req.ImageData = imagedata.ToArray();

    req.CustomerSiteImageType = CustomerSiteImageType.Primary;  //The desired image slot

    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

    SetCustomerSiteImageResponse res = api.SetCustomerSiteImage(req);

 

    //Now examine the results:

}

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

 

    req.CustomerID = 1

    req.ImageName = "1"

 

    'Add ImageData

    Dim imagedata As New List(Of Byte)()

    imagedata.Add(1)

    imagedata.Add(2)

 

    'Now attach the list to the request

    req.ImageData = imagedata.ToArray()

    req.CustomerSiteImageType = CustomerSiteImageType.Primary

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As SetCustomerSiteImageResponse = api.SetCustomerSiteImage(req)

 

    'Now examine the results:

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

 

    //Add ImageData

 

 

 

    //Now attach the list to the request

    req.ImageData = array(imageDat1,imageDat2);

    $req->CustomerSiteImageType = 1;

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

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

    SetCustomerSiteImageRequest req = new SetCustomerSiteImageRequest();

 

    req.setCustomerID(1);

    req.setImageName("1");

 

    //Add ImageData

    ArrayOfSystem.Byte imagedata = new ArrayOfSystem.Byte();

 

    Byte imageDat1 = new Byte();

    imagedata.Add(imageDat1);

 

    Byte imageDat2 = new Byte();

    imagedata.Add(imageDat2);

 

    //Now attach the list to the request

    req.setImageData(imagedata);

    req.setCustomerSiteImageType(1);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    SetCustomerSiteImageResponse res = api.getExigoApiSoap().setCustomerSiteImage(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.