Exigo Web Services API v2022.12.19.1

 Search

GetExtendedDbSchema

Get Extended DB schema.

Input Properties

GetSchemaRequest
PropertyData TypeNotes
SchemaNameString

Output Properties

GetSchemaResponse
PropertyData TypeNotes
SchemaSchemaDataResponse
SchemaDataResponse
PropertyData TypeNotes
NameString
EntitiesEntityDataResponse[]
EntityDataResponse
PropertyData TypeNotes
EntityNameString
EntitySetNameString
SchemaNameString
IsLogBoolean
MaxLogDaysInt32
LogDateFieldString
NavigationsString[]
PropertiesPropertyDataResponse[]
PropertyDataResponse
PropertyData TypeNotes
PropertyNameString
IsKeyBoolean
IsNewBoolean
IsAutoNumberBoolean
AllowDbNullBoolean
Type PropertyType
DefaultValueString
SizeInt32
MaskTypeMaskTypeDataResponse
MaskTypeDataResponse
PropertyData TypeNotes
MaskTypeIdInt32
NameString
DescriptionString

Http Request

GET https://yourcompany-api.exigo.com/3.0/extendeddb/schema?schemaName=1
Authorization: Basic base64Encoded

Http Response

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


{
  "schema": 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/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>
          <EntityDataResponse>
            <EntityName>string</EntityName>
            <EntitySetName>string</EntitySetName>
            <SchemaName>string</SchemaName>
            <IsLog>boolean</IsLog>
            <MaxLogDays>int</MaxLogDays>
            <LogDateField>string</LogDateField>
            <Navigations>
              <string>string</string>
            </Navigations>
            <Properties>
              <PropertyDataResponse
                xsi:nil="true" />
            </Properties>
          </EntityDataResponse>
        </Entities>
      </Schema>
    </GetExtendedDbSchemaResult>
  </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 GetSchemaRequest();

 

    req.SchemaName = "1";

 

    //Send Request to Server and Get Response

    var res = await api.GetExtendedDbSchemaAsync(req);

 

    //Now examine the results:

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

}

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

    GetSchemaRequest req = new GetSchemaRequest();

 

    req.SchemaName = "1";

 

    //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 does not support csv output.