API Documentation for Distributed DDP Application Helix DMS

This documentation outlines the RESTful and SOAP-based APIs for the Distributed DDP application. The APIs are customizable, with endpoints unique to each installation. URLs should be updated based on your domain and deployment settings.

General Information

• Base URL: https://yourdomain.com/dms/api/

• Authentication: API calls require an authentication token (AuthToken). Generate this token using the GetAuthToken function.

• Data Format:

  • REST: JSON payloads.

  • SOAP: XML payloads.

API Endpoints

1. GetAuthToken

Generates and updates an authentication token for a user. Only one active token per user is allowed.

REST Endpoint

• POST: https://yourdomain.com/dms/api/GetAuthToken

REST Request Payload

{
  "Username": "string",
  "Password": "string"
}

SOAP Endpoint

• URL: /dms/api/endpoint.asmx

• SOAPAction: http://tempuri.org/GetAuthToken

SOAP Request

<?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>
    <GetAuthToken xmlns="http://tempuri.org/">
      <Username>string</Username>
      <Password>string</Password>
    </GetAuthToken>
  </soap:Body>
</soap:Envelope>

Response

{
  "AuthToken": "string"
}

2. EntityList

Returns a list of entities the authenticated user can access.

REST Endpoint

• POST: https://yourdomain.com/dms/api/EntityList

REST Request Payload

{
  "AuthToken": "string"
}

SOAP Endpoint

• URL: /dms/api/endpoint.asmx

• SOAPAction: http://tempuri.org/EntityList

SOAP Request

<?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>
    <EntityList xmlns="http://tempuri.org/">
      <AuthToken>string</AuthToken>
    </EntityList>
  </soap:Body>
</soap:Envelope>

Response

{
  "Entities": [
    {
      "EntityID": "string",
      "EntityName": "string"
    }
  ]
}

3. ViewList

Returns a list of views accessible to the user for a given entity.

REST Endpoint

• POST: https://yourdomain.com/dms/api/ViewList

REST Request Payload

{
  "AuthToken": "string",
  "EntityID": "string"
}

SOAP Endpoint

• URL: /dms/api/endpoint.asmx

• SOAPAction: http://tempuri.org/ViewList

SOAP Request

<?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>
    <ViewList xmlns="http://tempuri.org/">
      <AuthToken>string</AuthToken>
      <EntityID>string</EntityID>
    </ViewList>
  </soap:Body>
</soap:Envelope>

Response

{
  "Views": [
    {
      "ViewID": "string",
      "ViewName": "string"
    }
  ]
}

4. GetRecordData

Fetches all form data for a specific record.

REST Endpoint

• POST: https://yourdomain.com/dms/api/GetRecordData

REST Request Payload

{
  "AuthToken": "string",
  "EntityID": "string",
  "RecordID": "string"
}

SOAP Endpoint

• URL: /dms/api/endpoint.asmx

• SOAPAction: http://tempuri.org/GetRecordData

SOAP Request

<?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>
    <GetRecordData xmlns="http://tempuri.org/">
      <AuthToken>string</AuthToken>
      <EntityID>string</EntityID>
      <RecordID>string</RecordID>
    </GetRecordData>
  </soap:Body>
</soap:Envelope>

Response

{
  "RecordData": {
    "Field1": "Value1",
    "Field2": "Value2"
  }
}

5. UpdateRecordData

Updates a record and executes associated workflows.

REST Endpoint

• POST: https://yourdomain.com/dms/api/UpdateRecordData

REST Request Payload

{
  "AuthToken": "string",
  "EntityID": "string",
  "RecordID": "string",
  "DataString": "FieldName1=Value1&FieldName2=Value2"
}

SOAP Endpoint

• URL: /dms/api/endpoint.asmx

• SOAPAction: http://tempuri.org/UpdateRecordData

SOAP Request

<?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>
    <UpdateRecordData xmlns="http://tempuri.org/">
      <AuthToken>string</AuthToken>
      <EntityID>string</EntityID>
      <RecordID>string</RecordID>
      <DataString>FieldName1=Value1&amp;FieldName2=Value2</DataString>
    </UpdateRecordData>
  </soap:Body>
</soap:Envelope>

Response

{
  "UpdatedData": {
    "Field1": "NewValue1",
    "Field2": "NewValue2"
  }
}

6. GetViewData

Retrieves all data within a specific view.

REST Endpoint

• POST: https://yourdomain.com/dms/api/GetViewData

REST Request Payload

{
  "AuthToken": "string",
  "ViewID": "string"
}

SOAP Endpoint

• URL: /dms/api/endpoint.asmx

• SOAPAction: http://tempuri.org/GetViewData

SOAP Request

<?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>
    <GetViewData xmlns="http://tempuri.org/">
      <AuthToken>string</AuthToken>
      <ViewID>string</ViewID>
    </GetViewData>
  </soap:Body>
</soap:Envelope>

Response

{
  "ViewData": {
    "Field1": "Value1",
    "Field2": "Value2"
  }
}

7. CreateNewRecord

Creates a new record within an entity.

REST Endpoint

• POST: https://yourdomain.com/dms/api/CreateNewRecord

REST Request Payload

{
  "AuthToken": "string",
  "EntityID": "string",
  "DataString": "FieldName1=Value1&FieldName2=Value2"
}

SOAP Endpoint

• URL: /dms/api/endpoint.asmx

• SOAPAction: http://tempuri.org/CreateNewRecord

SOAP Request

<?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>
    <CreateNewRecord xmlns="http://tempuri.org/">
      <AuthToken>string</AuthToken>
      <EntityID>string</EntityID>
      <DataString>FieldName1=Value1&amp;FieldName2=Value2</DataString>
    </CreateNewRecord>
  </soap:Body>
</soap:Envelope>

Response

{
  "NewRecord": {
    "RecordID": "string",
    "Data": {
      "Field1": "Value1",
      "Field2": "Value2"
    }
  }
}

8. DeleteRecordData

Deletes a record by moving it to the recycle bin.

REST Endpoint

• POST: https://yourdomain.com/dms/api/DeleteRecordData

REST Request Payload

{
  "AuthToken": "string",
  "EntityID": "string",
  "RecordID": "string"
}

SOAP Endpoint

• URL: /dms/api/endpoint.asmx

• SOAPAction: http://tempuri.org/DeleteRecordData

SOAP Request

<?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>
    <DeleteRecordData xmlns="http://tempuri.org/">
      <AuthToken>string</AuthToken>
      <EntityID>string</EntityID>
      <RecordID>string</RecordID>
    </DeleteRecordData>
  </soap:Body>
</soap:Envelope>

Response

{
  "Message": "Record successfully deleted."
}

Notes

1. Replace placeholders in all examples with actual values.

2. Maintain the security of AuthToken at all times.

3. Ensure API accounts are used appropriately to avoid session conflicts.