Exigo Web Services API v3.4.272

DeleteExtendedDbEntity

Delete Extended DB Entity.

Input Properties

DeleteEntityRequest
PropertyData TypeNotes
SchemaNameStringOptional. Name of Schema containing the Entity to delete.
EntityNameStringOptional. Name of Entity to delete.

Output Properties

DeleteEntityResponse
PropertyData TypeNotes
schemaNameString
EntityNameString

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

<?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> <DeleteEntityRequest xmlns="http://api.exigo.com/"> <SchemaName>string</SchemaName> <EntityName>string</EntityName> </DeleteEntityRequest> </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> <DeleteExtendedDbEntityResult xmlns="http://api.exigo.com/"> <schemaName>string</schemaName> <EntityName>string</EntityName> </DeleteExtendedDbEntityResult> </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

    DeleteEntityRequest req = new DeleteEntityRequest();

 

    req.SchemaName = "1";           //Name of Schema containing the Entity to delete.

    req.EntityName = "1";           //Name of Entity to delete.

 

    //Send Request to Server and Get Response

    DeleteEntityResponse res = api.DeleteExtendedDbEntity(req);

 

    //Now examine the results:

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

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

}

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

 

    req.SchemaName = "1"

    req.EntityName = "1"

 

    'Send Request to Server and Get Response

    Dim res As DeleteEntityResponse = api.DeleteExtendedDbEntity(req)

 

    'Now examine the results:

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

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

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.DeleteExtendedDbEntity($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

    DeleteEntityRequest req = new DeleteEntityRequest();

 

    req.setSchemaName("1");

    req.setEntityName("1");

 

    //Send Request to Server and Get Response

    DeleteEntityResponse res = api.getExigoApiSoap().deleteExtendedDbEntity(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=DeleteExtendedDbEntity
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&SchemaName=String
&EntityName=String

Response Fields
schemaName,EntityName
String,String