Exigo Web Services API v2020.3.27.1

GetReleases

Gets Resource Set releases

Input Properties

GetReleasesRequest
PropertyData TypeNotes
ResourceSetIDInt32The unique numerical ID of the resource to fetch releases from.

Output Properties

GetReleasesResponse
PropertyData TypeNotes
ReleasesResourceSetRelease[]
ResourceSetRelease
PropertyData TypeNotes
ResourceSetIDInt32
VersionString
ReleaseDateDateTime

Http Request

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

Http Response

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

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

<?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> <GetReleasesRequest xmlns="http://api.exigo.com/"> <ResourceSetID>int</ResourceSetID> </GetReleasesRequest> </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> <GetReleasesResult xmlns="http://api.exigo.com/"> <Releases> <ResourceSetRelease> <ResourceSetID>int</ResourceSetID> <Version>string</Version> <ReleaseDate>dateTime</ReleaseDate> </ResourceSetRelease> </Releases> </GetReleasesResult> </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 GetReleasesRequest();

 

 

    //Send Request to Server and Get Response

    var res = await api.GetReleasesAsync(req);

 

    //Now examine the results:

 

    foreach (var resourceSetRelease in res.Releases)

    {

        Console.WriteLine("ResourceSetID: {0}", resourceSetRelease.ResourceSetID);

        Console.WriteLine("Version: {0}", resourceSetRelease.Version);

        Console.WriteLine("ReleaseDate: {0}", resourceSetRelease.ReleaseDate);

    }

}

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

    GetReleasesRequest req = new GetReleasesRequest();

 

 

    //Send Request to Server and Get Response

    GetReleasesResponse res = api.GetReleases(req);

 

    //Now examine the results:

 

    foreach (ResourceSetRelease resourceSetRelease in res.Releases)

    {

        Console.WriteLine("ResourceSetID: {0}", resourceSetRelease.ResourceSetID);

        Console.WriteLine("Version: {0}", resourceSetRelease.Version);

        Console.WriteLine("ReleaseDate: {0}", resourceSetRelease.ReleaseDate);

    }

}

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

 

 

    'Send Request to Server and Get Response

    Dim res As GetReleasesResponse = api.GetReleases(req)

 

    'Now examine the results:

 

    For Each resourceSetRelease As ResourceSetRelease In res.Releases

        Console.WriteLine("ResourceSetID: {0}", resourceSetRelease.ResourceSetID)

        Console.WriteLine("Version: {0}", resourceSetRelease.Version)

        Console.WriteLine("ReleaseDate: {0}", resourceSetRelease.ReleaseDate)

    Next

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.GetReleases($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

    GetReleasesRequest req = new GetReleasesRequest();

 

 

    //Send Request to Server and Get Response

    GetReleasesResponse res = api.getExigoApiSoap().getReleases(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.