Exigo Web Services API v3.4.272

GetExtendedDbSchema

Get Extended DB schema.

Input Properties

GetSchemaRequest
PropertyData TypeNotes
SchemaNameStringOptional. Optionally pull just a single schema.

Output Properties

GetSchemaResponse
PropertyData TypeNotes
SchemaSchema

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/GetExtendedDbSchema"

<?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> <GetSchemaRequest xmlns="http://api.exigo.com/"> <SchemaName>string</SchemaName> </GetSchemaRequest> </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> <GetExtendedDbSchemaResult xmlns="http://api.exigo.com/"> <Schema> <Name>string</Name> <Entities> <Entity> <SchemaName>string</SchemaName> <DbSchema>string</DbSchema> <EntityName>string</EntityName> <EntitySetName>string</EntitySetName> <Properties> <Property xsi:nil="true" /> </Properties> <Navigations> <Navigation xsi:nil="true" /> </Navigations> <SyncTypeID>int</SyncTypeID> </Entity> </Entities> </Schema> </GetExtendedDbSchemaResult> </soap:Body> </soap:Envelope>

C#

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

    GetSchemaRequest req = new GetSchemaRequest();

 

    req.SchemaName = "1";           //Optionally pull just a single schema

 

    //Send Request to Server and Get Response

    GetSchemaResponse res = api.GetExtendedDbSchema(req);

 

    //Now examine the results:

    Console.WriteLine("Schema: {0}", res.Schema);

}

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

 

    req.SchemaName = "1"

 

    'Send Request to Server and Get Response

    Dim res As GetSchemaResponse = api.GetExtendedDbSchema(req)

 

    'Now examine the results:

    Console.WriteLine("Schema: {0}", res.Schema)

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->SchemaName = "1";

 

    //Send Request to Server and Get Response

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

    GetSchemaRequest req = new GetSchemaRequest();

 

    req.setSchemaName("1");

 

    //Send Request to Server and Get Response

    GetSchemaResponse res = api.getExigoApiSoap().getExtendedDbSchema(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method supports CSV output.

HTTP Get Request:
http://api.exigo.com/3.0/csv/?method=GetExtendedDbSchema
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&SchemaName=String

Response Fields
Schema
Schema