Exigo Web Services API v2021.6.7.1

UpdateExtendedDbEntity

Update Extended DB Entity.

Input Properties

UpdateEntityRequest
PropertyData TypeNotes
EntityEntityUpdated record object.
EntityNameStringOptional. Name of record to update.

Output Properties

UpdateEntityResponse
PropertyData TypeNotes
EntityEntity

Http Request

PATCH https://yourcompany-api.exigo.com/3.0/extendeddb HTTP/1.1
Content-Type: application/json
Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword)

{ "entity": null, "entityName": "1" }

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

<?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> <UpdateEntityRequest xmlns="http://api.exigo.com/"> <Entity> <SchemaName>string</SchemaName> <DbSchema>string</DbSchema> <EntityName>string</EntityName> <EntitySetName>string</EntitySetName> <Properties> <Property> <Name>string</Name> <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 Binary or Guid</Type> <DefaultName>string</DefaultName> <DefaultValue>string</DefaultValue> <Size>int</Size> <AutoGenerate>string</AutoGenerate> </Property> </Properties> <Navigations> <Navigation> <Name>string</Name> </Navigation> </Navigations> <NavigationList> <KeyValuePairOfStringString /> </NavigationList> <SyncTypeID>int</SyncTypeID> <IsLog>boolean</IsLog> <MaxLogDays>int</MaxLogDays> <LogDateField>string</LogDateField> <ArchiveEnabled>boolean</ArchiveEnabled> <ArchiveDateField>string</ArchiveDateField> <DaysBeforeArchive>int</DaysBeforeArchive> </Entity> <EntityName>string</EntityName> </UpdateEntityRequest> </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> <UpdateExtendedDbEntityResult xmlns="http://api.exigo.com/"> <Entity> <SchemaName>string</SchemaName> <DbSchema>string</DbSchema> <EntityName>string</EntityName> <EntitySetName>string</EntitySetName> <Properties> <Property> <Name>string</Name> <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 Binary or Guid</Type> <DefaultName>string</DefaultName> <DefaultValue>string</DefaultValue> <Size>int</Size> <AutoGenerate>string</AutoGenerate> </Property> </Properties> <Navigations> <Navigation> <Name>string</Name> </Navigation> </Navigations> <NavigationList> <KeyValuePairOfStringString /> </NavigationList> <SyncTypeID>int</SyncTypeID> <IsLog>boolean</IsLog> <MaxLogDays>int</MaxLogDays> <LogDateField>string</LogDateField> <ArchiveEnabled>boolean</ArchiveEnabled> <ArchiveDateField>string</ArchiveDateField> <DaysBeforeArchive>int</DaysBeforeArchive> </Entity> </UpdateExtendedDbEntityResult> </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 UpdateEntityRequest();

 

    req.Entity = 1;                 //Updated record object.

    req.EntityName = "1";           //Name of record to update.

 

    //Send Request to Server and Get Response

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

    UpdateEntityRequest req = new UpdateEntityRequest();

 

    req.Entity = 1;                 //Updated record object.

    req.EntityName = "1";           //Name of record to update.

 

    //Send Request to Server and Get Response

    UpdateEntityResponse res = api.UpdateExtendedDbEntity(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 UpdateEntityRequest()

 

    req.Entity = 1

    req.EntityName = "1"

 

    'Send Request to Server and Get Response

    Dim res As UpdateEntityResponse = api.UpdateExtendedDbEntity(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->Entity = 1;

    $req->EntityName = "1";

 

    //Send Request to Server and Get Response

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

    UpdateEntityRequest req = new UpdateEntityRequest();

 

    req.setEntity(1);

    req.setEntityName("1");

 

    //Send Request to Server and Get Response

    UpdateEntityResponse res = api.getExigoApiSoap().updateExtendedDbEntity(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.