Exigo Web Services API v2020.3.27.1

CreateResourceSet

Create a new ResourceSet

Input Properties

CreateResourceSetRequest
PropertyData TypeNotes
ClassNameStringThe class name of the new resource set. Must be unique, valid identifier.
DescriptionStringThe description of the new resource set. All characters allowed. Must be unique.
NamespaceStringThe namespace that will be used for the class file generated with the new resource set. Must be unique, valid identifier.
SubscriptionKeyStringThe reference key for the new resource set. Must be unique, valid identifier.

Output Properties

CreateResourceSetResponse
PropertyData TypeNotes
ResourceSetIDInt32The unique ID of the new resource set.
ClassNameString
DescriptionString
NamespaceString
SubscriptionKeyString

Http Request

POST https://yourcompany-api.exigo.com/3.0/resourceset 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, "className": "", "description": "", "namespace": "", "subscriptionKey": "", "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/CreateResourceSet"

<?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> <CreateResourceSetRequest xmlns="http://api.exigo.com/"> <ClassName>string</ClassName> <Description>string</Description> <Namespace>string</Namespace> <SubscriptionKey>string</SubscriptionKey> </CreateResourceSetRequest> </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> <CreateResourceSetResult xmlns="http://api.exigo.com/"> <ResourceSetID>int</ResourceSetID> <ClassName>string</ClassName> <Description>string</Description> <Namespace>string</Namespace> <SubscriptionKey>string</SubscriptionKey> </CreateResourceSetResult> </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 CreateResourceSetRequest();

 

 

    //Send Request to Server and Get Response

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

    CreateResourceSetRequest req = new CreateResourceSetRequest();

 

 

    //Send Request to Server and Get Response

    CreateResourceSetResponse res = api.CreateResourceSet(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 CreateResourceSetRequest()

 

 

    'Send Request to Server and Get Response

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

    CreateResourceSetRequest req = new CreateResourceSetRequest();

 

 

    //Send Request to Server and Get Response

    CreateResourceSetResponse res = api.getExigoApiSoap().createResourceSet(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.