Exigo Web Services API v2022.12.19.1

 Search

CreateResourceSetBannerItem

Adds a ResourceSet Banner Item to the ResourceSet

Input Properties

CreateResourceSetBannerItemRequest
PropertyData TypeNotes
TitleStringThe main header message for your banner.
DescriptionStringThe sub-header message for your banner.
BannerImageBase64StringThe Base64 representation of the image for your banner.
BannerHoverTextStringResourceBanner field.
BannerURLStringThe URL the user is navigated to when clicking the banner.
BannerClickEvent BannerClickEventHow the url attached to the banner is navigated to when the banner is clicked.
BannerType BannerTypeBannerTypes dictate the formatting for a banner.
AssociatedDataSetsString[]List of the DataSets by ResourceName associated with this banner.
ResourceSetIDInt32
ResourceNameString
ResourceType ResourceType
CultureCodeStringOptional. Defaults to Default CultureCode.
ResourceGroupIDInt32Optional.
CommentStringOptional.
EnabledBooleanOptional. . Defaults to True.
EnabledStartDateDateTimeOptional. Value must be provided in UTC.
EnabledEndDateDateTimeOptional. Value must be provided in UTC.

Output Properties

CreateResourceSetBannerItemResponse
PropertyData TypeNotes
ResourceSetIDInt32
ResourceNameString
CultureCodeString

Http Request

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


{}

Http Response

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


{
  "resourceSetID": 1,
  "resourceName": "",
  "cultureCode": "",
  "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/CreateResourceSetBannerItem"

<?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>
    <CreateResourceSetBannerItemRequest xmlns="http://api.exigo.com/">
      <Title>string</Title>
      <Description>string</Description>
      <BannerImageBase64>string</BannerImageBase64>
      <BannerHoverText>string</BannerHoverText>
      <BannerURL>string</BannerURL>
      <BannerClickEvent>OpenInNewTab or OpenInCurrentWindow or None</BannerClickEvent>
      <BannerType>TextOnImage or ImageTop or InvalidType</BannerType>
      <AssociatedDataSets>
        <string>string</string>
      </AssociatedDataSets>
    </CreateResourceSetBannerItemRequest>
  </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>
    <CreateResourceSetBannerItemResult xmlns="http://api.exigo.com/">
      <ResourceSetID>int</ResourceSetID>
      <ResourceName>string</ResourceName>
      <CultureCode>string</CultureCode>
    </CreateResourceSetBannerItemResult>
  </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 CreateResourceSetBannerItemRequest();

 

 

    //Send Request to Server and Get Response

    var res = await api.CreateResourceSetBannerItemAsync(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

    CreateResourceSetBannerItemRequest req = new CreateResourceSetBannerItemRequest();

 

 

    //Send Request to Server and Get Response

    CreateResourceSetBannerItemResponse res = api.CreateResourceSetBannerItem(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 CreateResourceSetBannerItemRequest()

 

 

    'Send Request to Server and Get Response

    Dim res As CreateResourceSetBannerItemResponse = api.CreateResourceSetBannerItem(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

 

 

    //Send Request to Server and Get Response

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

    CreateResourceSetBannerItemRequest req = new CreateResourceSetBannerItemRequest();

 

 

    //Send Request to Server and Get Response

    CreateResourceSetBannerItemResponse res = api.getExigoApiSoap().createResourceSetBannerItem(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.