Exigo Web Services API v2022.12.19.1

 Search

SetCustomerSocialNetworks

Deletes all existing social network(s) for the customer, then inserts the provided list of social network(s) for the customer.

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

Input Properties

SetCustomerSocialNetworksRequest
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
CustomerSocialNetworksCustomerSocialNetworkRequest[]
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
CustomerSocialNetworkRequest
PropertyData TypeNotes
SocialNetworkIDInt32
UrlString

Output Properties

SetCustomerSocialNetworksResponse
PropertyData TypeNotes

Http Request

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


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

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

<?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>
    <SetCustomerSocialNetworksRequest xmlns="http://api.exigo.com/">
      <CustomerID>int</CustomerID>
      <CustomerSocialNetworks>
        <CustomerSocialNetworkRequest>
          <SocialNetworkID>int</SocialNetworkID>
          <Url>string</Url>
        </CustomerSocialNetworkRequest>
      </CustomerSocialNetworks>
      <CustomerKey>string</CustomerKey>
    </SetCustomerSocialNetworksRequest>
  </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>
    <SetCustomerSocialNetworksResult 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 SetCustomerSocialNetworksRequest();

 

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

 

    //Add CustomerSocialNetworks

    var customersocialnetworks = new List<CustomerSocialNetworkRequest>();

 

    var customerSocialNetwork1 = new CustomerSocialNetworkRequest();

    customerSocialNetwork1.SocialNetworkID = 1;

    customerSocialNetwork1.Url = "1";

    customersocialnetworks.Add(customerSocialNetwork1);

 

    var customerSocialNetwork2 = new CustomerSocialNetworkRequest();

    customerSocialNetwork2.SocialNetworkID = 2;

    customerSocialNetwork2.Url = "2";

    customersocialnetworks.Add(customerSocialNetwork2);

 

    //Now attach the list to the request

    req.CustomerSocialNetworks = customersocialnetworks.ToArray();

    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.SetCustomerSocialNetworksAsync(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

    SetCustomerSocialNetworksRequest req = new SetCustomerSocialNetworksRequest();

 

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

 

    //Add CustomerSocialNetworks

    List<CustomerSocialNetworkRequest> customersocialnetworks = new List<CustomerSocialNetworkRequest>();

 

    CustomerSocialNetworkRequest customerSocialNetwork1 = new CustomerSocialNetworkRequest();

    customerSocialNetwork1.SocialNetworkID = 1;

    customerSocialNetwork1.Url = "1";

    customersocialnetworks.Add(customerSocialNetwork1);

 

    CustomerSocialNetworkRequest customerSocialNetwork2 = new CustomerSocialNetworkRequest();

    customerSocialNetwork2.SocialNetworkID = 2;

    customerSocialNetwork2.Url = "2";

    customersocialnetworks.Add(customerSocialNetwork2);

 

    //Now attach the list to the request

    req.CustomerSocialNetworks = customersocialnetworks.ToArray();

    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

    SetCustomerSocialNetworksResponse res = api.SetCustomerSocialNetworks(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 SetCustomerSocialNetworksRequest()

 

    req.CustomerID = 1

 

    'Add CustomerSocialNetworks

    Dim customersocialnetworks As New List(Of CustomerSocialNetworkRequest)()

 

    Dim customerSocialNetwork1 as new CustomerSocialNetworkRequest()

    customerSocialNetwork1.SocialNetworkID = 1

    customerSocialNetwork1.Url = "1"

    customersocialnetworks.Add(customerSocialNetwork1)

 

    Dim customerSocialNetwork2 as new CustomerSocialNetworkRequest()

    customerSocialNetwork2.SocialNetworkID = 2

    customerSocialNetwork2.Url = "2"

    customersocialnetworks.Add(customerSocialNetwork2)

 

    'Now attach the list to the request

    req.CustomerSocialNetworks = customersocialnetworks.ToArray()

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As SetCustomerSocialNetworksResponse = api.SetCustomerSocialNetworks(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;

 

    //Add CustomerSocialNetworks

 

    $customerSocialNetwork1->SocialNetworkID = 1;

    $customerSocialNetwork1->Url = "1";

 

    $customerSocialNetwork2->SocialNetworkID = 2;

    $customerSocialNetwork2->Url = "2";

 

    //Now attach the list to the request

    req.CustomerSocialNetworks = array(customerSocialNetwork1,customerSocialNetwork2);

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

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

    SetCustomerSocialNetworksRequest req = new SetCustomerSocialNetworksRequest();

 

    req.setCustomerID(1);

 

    //Add CustomerSocialNetworks

    ArrayOfCustomerSocialNetworkRequest customersocialnetworks = new ArrayOfCustomerSocialNetworkRequest();

 

    CustomerSocialNetworkRequest customerSocialNetwork1 = new CustomerSocialNetworkRequest();

    customerSocialNetwork1.setSocialNetworkID(1);

    customerSocialNetwork1.setUrl("1");

    customersocialnetworks.Add(customerSocialNetwork1);

 

    CustomerSocialNetworkRequest customerSocialNetwork2 = new CustomerSocialNetworkRequest();

    customerSocialNetwork2.setSocialNetworkID(2);

    customerSocialNetwork2.setUrl("2");

    customersocialnetworks.Add(customerSocialNetwork2);

 

    //Now attach the list to the request

    req.setCustomerSocialNetworks(customersocialnetworks);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    SetCustomerSocialNetworksResponse res = api.getExigoApiSoap().setCustomerSocialNetworks(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.