Exigo Web Services API v2022.12.19.1

 Search

GetResourceSetItems

Gets ResourceSet Items

Input Properties

GetResourceSetItemsRequest
PropertyData TypeNotes
SubscriptionKeyStringOptional. Pass in either SubscriptionKey or ResourceSetID.
VersionStringOptional. If Version is null, the items in the most recent changes are returned.
CultureCodeStringOptional. If CultureCode is null, the items in the default language are returned.
ResourceSetIDInt32Optional.

Output Properties

GetResourceSetItemsResponse
PropertyData TypeNotes
ItemsResourceItem[]
ResourceItem
PropertyData TypeNotes
ResourceNameString
InvariantValueString
CommentString
EnabledBoolean
EnabledStartDateDateTime
EnabledEndDateDateTime
ModifiedDateDateTime
ResourceTypeID ResourceType
ResourceSetIDInt32
CultureCodeString
ResourceGroupIDInt32
DropDownValuesString

Http Request

GET https://yourcompany-api.exigo.com/3.0/resourceitemAuthorization: Basic base64Encoded

Http Response

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


{
  "items": null,
  "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/GetResourceSetItems"

<?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>
    <GetResourceSetItemsRequest xmlns="http://api.exigo.com/">
      <SubscriptionKey>string</SubscriptionKey>
      <Version>string</Version>
      <CultureCode>string</CultureCode>
      <ResourceSetID>int</ResourceSetID>
    </GetResourceSetItemsRequest>
  </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>
    <GetResourceSetItemsResult xmlns="http://api.exigo.com/">
      <Items>
        <ResourceItem>
          <ResourceName>string</ResourceName>
          <InvariantValue>string</InvariantValue>
          <Comment>string</Comment>
          <Enabled>boolean</Enabled>
          <EnabledStartDate>dateTime</EnabledStartDate>
          <EnabledEndDate>dateTime</EnabledEndDate>
          <ModifiedDate>dateTime</ModifiedDate>
          <ResourceTypeID>Text or Int or Decimal or Date or Boolean or DropDown or Image or Widget or Banner or DataSet or Carousel</ResourceTypeID>
          <ResourceSetID>int</ResourceSetID>
          <CultureCode>string</CultureCode>
          <ResourceGroupID>int</ResourceGroupID>
          <DropDownValues>string</DropDownValues>
        </ResourceItem>
      </Items>
    </GetResourceSetItemsResult>
  </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 GetResourceSetItemsRequest();

 

 

    //Send Request to Server and Get Response

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

    GetResourceSetItemsRequest req = new GetResourceSetItemsRequest();

 

 

    //Send Request to Server and Get Response

    GetResourceSetItemsResponse res = api.GetResourceSetItems(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 GetResourceSetItemsRequest()

 

 

    'Send Request to Server and Get Response

    Dim res As GetResourceSetItemsResponse = api.GetResourceSetItems(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.GetResourceSetItems($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

    GetResourceSetItemsRequest req = new GetResourceSetItemsRequest();

 

 

    //Send Request to Server and Get Response

    GetResourceSetItemsResponse res = api.getExigoApiSoap().getResourceSetItems(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.