Exigo Web Services API v2022.12.19.1

 Search

GetExtendedDbEntity

Get Extended DB Entity.

Input Properties

GetEntityRequest
PropertyData TypeNotes
SchemaNameString
EntityNameString

Output Properties

GetEntityResponse
PropertyData TypeNotes
EntityEntityDataResponse
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?schemaName=1
  &entityName=1
Authorization: Basic base64Encoded

Http Response

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


{
  "entity": 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/GetExtendedDbEntity"

<?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>
    <GetEntityRequest xmlns="http://api.exigo.com/">
      <SchemaName>string</SchemaName>
      <EntityName>string</EntityName>
    </GetEntityRequest>
  </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>
    <GetExtendedDbEntityResult xmlns="http://api.exigo.com/">
      <Entity>
        <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>
            <PropertyName>string</PropertyName>
            <IsKey>boolean</IsKey>
            <IsNew>boolean</IsNew>
            <IsAutoNumber>boolean</IsAutoNumber>
            <AllowDbNull>boolean</AllowDbNull>
            <Type>Integer or DateTime2 or DateTime or Decimal or Boolean or String or StringMax or Binary or Guid</Type>
            <DefaultValue>string</DefaultValue>
            <Size>int</Size>
            <MaskType>
              <MaskTypeId>int</MaskTypeId>
              <Name>string</Name>
              <Description>string</Description>
            </MaskType>
          </PropertyDataResponse>
        </Properties>
      </Entity>
    </GetExtendedDbEntityResult>
  </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 GetEntityRequest();

 

    req.SchemaName = "1";

    req.EntityName = "1";

 

    //Send Request to Server and Get Response

    var res = await api.GetExtendedDbEntityAsync(req);

 

    //Now examine the results:

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

}

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

    GetEntityRequest req = new GetEntityRequest();

 

    req.SchemaName = "1";

    req.EntityName = "1";

 

    //Send Request to Server and Get Response

    GetEntityResponse res = api.GetExtendedDbEntity(req);

 

    //Now examine the results:

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

}

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

 

    req.SchemaName = "1"

    req.EntityName = "1"

 

    'Send Request to Server and Get Response

    Dim res As GetEntityResponse = api.GetExtendedDbEntity(req)

 

    'Now examine the results:

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

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";

    $req->EntityName = "1";

 

    //Send Request to Server and Get Response

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

    GetEntityRequest req = new GetEntityRequest();

 

    req.setSchemaName("1");

    req.setEntityName("1");

 

    //Send Request to Server and Get Response

    GetEntityResponse res = api.getExigoApiSoap().getExtendedDbEntity(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.