Exigo Web Services API v2022.12.19.1

 Search

SetItemImage

Set Images for an Item

Input Properties

SetItemImageRequest
PropertyData TypeNotes
ItemCode String
TinyImageNameStringOptional.
TinyImageDataByte[]Optional.
SmallImageNameStringOptional.
SmallImageDataByte[]Optional.
LargeImageNameStringOptional.
LargeImageDataByte[]Optional.

Output Properties

SetItemImageResponse
PropertyData TypeNotes

Http Request

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


{
  "itemCode": "1",
  "tinyImageName": "1",
  "tinyImageData": null,
  "smallImageName": "1",
  "smallImageData": null,
  "largeImageName": "1",
  "largeImageData": null
}

Http Response

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


{
  "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/SetItemImage"

<?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>
    <SetItemImageRequest xmlns="http://api.exigo.com/">
      <ItemCode>string</ItemCode>
      <TinyImageName>string</TinyImageName>
      <TinyImageData>base64Binary</TinyImageData>
      <SmallImageName>string</SmallImageName>
      <SmallImageData>base64Binary</SmallImageData>
      <LargeImageName>string</LargeImageName>
      <LargeImageData>base64Binary</LargeImageData>
    </SetItemImageRequest>
  </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>
    <SetItemImageResult xmlns="http://api.exigo.com/" />
  </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 SetItemImageRequest();

 

    req.ItemCode = "1";

    req.TinyImageName = "1";

 

    //Add TinyImageData

    var tinyimagedata = new List<Byte>();

    tinyimagedata.Add(1);

    tinyimagedata.Add(2);

 

    //Now attach the list to the request

    req.TinyImageData = tinyimagedata.ToArray();

    req.SmallImageName = "1";

 

    //Add SmallImageData

    var smallimagedata = new List<Byte>();

    smallimagedata.Add(1);

    smallimagedata.Add(2);

 

    //Now attach the list to the request

    req.SmallImageData = smallimagedata.ToArray();

    req.LargeImageName = "1";

 

    //Add LargeImageData

    var largeimagedata = new List<Byte>();

    largeimagedata.Add(1);

    largeimagedata.Add(2);

 

    //Now attach the list to the request

    req.LargeImageData = largeimagedata.ToArray();

 

    //Send Request to Server and Get Response

    var res = await api.SetItemImageAsync(req);

 

    //Now examine the results:

}

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

    SetItemImageRequest req = new SetItemImageRequest();

 

    req.ItemCode = "1";

    req.TinyImageName = "1";

 

    //Add TinyImageData

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

    tinyimagedata.Add(1);

    tinyimagedata.Add(2);

 

    //Now attach the list to the request

    req.TinyImageData = tinyimagedata.ToArray();

    req.SmallImageName = "1";

 

    //Add SmallImageData

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

    smallimagedata.Add(1);

    smallimagedata.Add(2);

 

    //Now attach the list to the request

    req.SmallImageData = smallimagedata.ToArray();

    req.LargeImageName = "1";

 

    //Add LargeImageData

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

    largeimagedata.Add(1);

    largeimagedata.Add(2);

 

    //Now attach the list to the request

    req.LargeImageData = largeimagedata.ToArray();

 

    //Send Request to Server and Get Response

    SetItemImageResponse res = api.SetItemImage(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 SetItemImageRequest()

 

    req.ItemCode = "1"

    req.TinyImageName = "1"

 

    'Add TinyImageData

    Dim tinyimagedata As New List(Of Byte)()

    tinyimagedata.Add(1)

    tinyimagedata.Add(2)

 

    'Now attach the list to the request

    req.TinyImageData = tinyimagedata.ToArray()

    req.SmallImageName = "1"

 

    'Add SmallImageData

    Dim smallimagedata As New List(Of Byte)()

    smallimagedata.Add(1)

    smallimagedata.Add(2)

 

    'Now attach the list to the request

    req.SmallImageData = smallimagedata.ToArray()

    req.LargeImageName = "1"

 

    'Add LargeImageData

    Dim largeimagedata As New List(Of Byte)()

    largeimagedata.Add(1)

    largeimagedata.Add(2)

 

    'Now attach the list to the request

    req.LargeImageData = largeimagedata.ToArray()

 

    'Send Request to Server and Get Response

    Dim res As SetItemImageResponse = api.SetItemImage(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->ItemCode = "1";

    $req->TinyImageName = "1";

 

    //Add TinyImageData

 

 

 

    //Now attach the list to the request

    req.TinyImageData = array(tinyImageDat1,tinyImageDat2);

    $req->SmallImageName = "1";

 

    //Add SmallImageData

 

 

 

    //Now attach the list to the request

    req.SmallImageData = array(smallImageDat1,smallImageDat2);

    $req->LargeImageName = "1";

 

    //Add LargeImageData

 

 

 

    //Now attach the list to the request

    req.LargeImageData = array(largeImageDat1,largeImageDat2);

 

    //Send Request to Server and Get Response

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

    SetItemImageRequest req = new SetItemImageRequest();

 

    req.setItemCode("1");

    req.setTinyImageName("1");

 

    //Add TinyImageData

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

 

    Byte tinyImageDat1 = new Byte();

    tinyimagedata.Add(tinyImageDat1);

 

    Byte tinyImageDat2 = new Byte();

    tinyimagedata.Add(tinyImageDat2);

 

    //Now attach the list to the request

    req.setTinyImageData(tinyimagedata);

    req.setSmallImageName("1");

 

    //Add SmallImageData

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

 

    Byte smallImageDat1 = new Byte();

    smallimagedata.Add(smallImageDat1);

 

    Byte smallImageDat2 = new Byte();

    smallimagedata.Add(smallImageDat2);

 

    //Now attach the list to the request

    req.setSmallImageData(smallimagedata);

    req.setLargeImageName("1");

 

    //Add LargeImageData

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

 

    Byte largeImageDat1 = new Byte();

    largeimagedata.Add(largeImageDat1);

 

    Byte largeImageDat2 = new Byte();

    largeimagedata.Add(largeImageDat2);

 

    //Now attach the list to the request

    req.setLargeImageData(largeimagedata);

 

    //Send Request to Server and Get Response

    SetItemImageResponse res = api.getExigoApiSoap().setItemImage(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.