Administration > Administration tools > Consuming the web service directly
 

Previous Topic

Next Topic

Consuming the web service directly

Locating the WSDL

You can browse the up-to-date WSDL documentation of the DataExchange web service online at either of the following websites:

Import guidelines

Follow these steps to import data.

  1. Create an instance of ExchangeStream object and set the fields according to the specification below.

    FileName = {"Employees.xml"|"Relationships.xml"}

    FileData = [byte array, default encoding]

  2. Pass the ExchangeStream object to Import web method.
  3. The web service returns an ExchangeStream instance in the same parameter.

    FileName = "Employees.txt" or "Relationships.txt"

    FileData = [log of the operations AND/OR exception details]

  4. Check ExchangeStream.FileSuccess flag and convert ExchangeStream.FileData back to string to obtain a result.

    The input file can be broken into multiple chunks of data and each chunk then imported individually.

  5. Rival suggests that you capture and log the FileData results for each transaction for troubleshooting purposes.

Export Guidelines

Follow these steps to export data:

  1. Create an instance of ExchangeStream object and set the fields according to the specification below.

    FileName ={"Employees.xml"|"Employees.xsd"|"Relationships.xml"|"Relationships.xsd"}

    FileData = [exported xml data AND/OR exception details]

  2. Check ExchangeStream.FileSuccess flag and convert ExchangeStream.FileData back to string to obtain a result.
  3. Write the string data to an XML file.

SOAP Specifications of the Import Method

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

POST /ClientName/Subprojects/DataExchange/DataExchange.asmx HTTP/1.1

Host: humanasset.net

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://humanasset.net/Import"

<?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>

<Import xmlns="http://humanasset.net">

<UserName>string</UserName>

<Password>string</Password>

<Type>Employees or Relationships</Type>

<Op>Validate or DryRun or Import</Op>

</Import>

</soap:Body>

</soap:Envelope>

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>

<ImportResponse xmlns="http://humanasset.net">

<ImportResult>string</ImportResult>

</ImportResponse>

</soap:Body>

</soap:Envelope>

SOAP specifications of the Export Method

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

POST /ClientName/Subprojects/DataExchange/DataExchange.asmx HTTP/1.1

Host: humanasset.net

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://humanasset.net/Export"

<?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>

<Export xmlns="http://humanasset.net">

<UserName>string</UserName>

<Password>string</Password>

<Type>Employees or Relationships</Type>

<Op>Schema or Export</Op>

</Export>

</soap:Body>

</soap:Envelope>

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>

<ExportResponse xmlns="http://humanasset.net">

<ExportResult>boolean</ExportResult>

</ExportResponse>

</soap:Body>

</soap:Envelope>