Welcome to the DocLanding developer portal!
You can use the DocLanding API to create applications that integrate with DocLanding. The DocLanding API is a collection of Web services, which gives you the freedom to create applications using any modern programming language that interact with our API.
Applications utilizing the API can perform the following functions:
- Store and retrieve files from DocLanding
- Organize files into folders and cabinets
- Create, rename, update, move, and delete files
- Search files
API
Introduction
Communication with this web service is done over HTTPS. The service currently only accepts SOAP requests and generates SOAP responses.
DocLanding's hierarchy is made up of the following four components:
| Workspace | A workspace is the root of the repository system of a specific user or company. |
| Cabinet | The cabinet represents a category of a document that has specific indices associated with it. |
| Folder | The folder represents a Windows like folder that gives the ability to group and organize files within a file cabinet. |
| File | The file is any digital content that is uploaded into a workspace. |
In order to call any function within the DocLanding API service a valid session ID and developer key is required. To obtain a valid session ID the developer must invoke the Login function. The Login function requires a valid username and password to a particular workspace. To obtain a developer key, please submit the API request form above.
Objects
Below is a list of commonly used API objects.
Workspace
| Name | Type | Description |
|---|---|---|
| Name | string | The name of the workspace. |
| string | The email associated with the workspace. | |
| DisplayName | string | The name displayed for the workspace. |
| Selected | boolean | The selected workspace when the user first signs into DocLanding. |
Record
Cabinets, Folders, and Files all Record objects. The Type field differentiates Record objects. Possible record types are Cabinet, Folder, and File.
| Name | Type | Description |
|---|---|---|
| AllowEdit | boolean | The ability for the user to edit the cabinet. |
| Type | string | The type of record it is. Can be cabinet, folder, or file. |
| Path | string | The path of the cabinet. |
| LibraryId | int | The library ID of the cabinet. |
| ParentId | string | The parent ID of the cabinet. |
| Id | string | The unique DocLanding ID associated with the cabinet. |
| Workspace | string | The name of the workspace the cabinet belongs to. |
| Name | string | The name of the cabinet. |
| ModifiedDate | string | The date the cabinet was last modified. |
| CreatedDate | string | The date the cabinet was created. |
| OriginalCreatedDate | string | The original creation date of the cabinet. |
| Locked | boolean | The value determining if the cabinet is locked. |
Functions
AddFile
The AddFile function allows your application to add a new file to a user's workspace.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| parentId | string | The ID of the cabinet or folder in which the new file will be added. |
| name | string | The file's name. |
| content | base64Binary | The content of the file. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| AddFileResult | string |
If the operation succeeded, a UUID will be returned.
If the operation failed, a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<AddFile xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<parentId>07e4373c-569e-4f5b-a47d-4fa23aeb834c</parentId>
<name>test.txt</name>
<content>base64Binary</content>
<workspace>MyWorkspace</workspace>
</AddFile>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<AddFileResponse xmlns="http://tempuri.org/">
<AddFileResult>
cae0bae2-51ef-48ae-b3ec-3211b4885169
</AddFileResult>
</AddFileResponse>
</soap:Body>
</soap:Envelope>
AddFolder
The AddFolder function allows your application to add a new folder to a user's workspace.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| parentId | string | The ID of the cabinet or folder in which the new folder will be added. |
| name | string | The name of the folder. |
| content | base64Binary | The binary content of the file. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| AddFolderResult | string |
If the operation succeeded, a UUID will be returned.
If the operation failed, a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<AddFolder xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<parentId>bb0b12f2-e7c1-4330-93ee-3c9602a18d12</parentId>
<name>MyFolder</name>
<workspace>MyWorkspace</workspace>
</AddFolder>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<AddFolderResponse xmlns="http://tempuri.org/">
<AddFolderResult>
1db2c011-89bd-4eb5-abc7-37fd7dd535ce
</AddFolderResult>
</AddFolderResponse>
</soap:Body>
</soap:Envelope>
AddNewFileVersion
The AddNewFileVersion function allows your application to create a new version of a file.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| itemId | string | The file ID. |
| name | string | The file name. |
| content | base64Binary | The binary content of the file. |
| workspace | string | The name of the user's workspace. |
| syncCreateTime | string |
Optional Specify a creation time for the new file version. |
| syncModifyTime | string |
Optional Specify a modified time for the new file version. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| AddNewFileVersionResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<AddFolder xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<itemId>ec751dd0-da74-4f0c-9ffe-2f572c692f07</itemId>
<name>MyFile.txt</name>
<content>base64Binary</content>
<workspace>MyWorkspace</workspace>
<syncCreateTime>string</syncCreateTime>
<syncModifyTime>string</syncModifyTime>
</AddFolder>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<AddFolderResponse xmlns="http://tempuri.org/">
<AddFolderResult>
1db2c011-89bd-4eb5-abc7-37fd7dd535ce
</AddFolderResult>
</AddFolderResponse>
</soap:Body>
</soap:Envelope>
AddSyncFile
The AddSyncFile function is similar to the AddFile function except that it allows you to specify
a creation time and modified time for the file being added. This helps out with applications that perform bi-directional syncs.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| parentId | string | The ID of the cabinet or folder in which the new file will be added. |
| name | string | The file name. |
| content | base64Binary | The binary content of the file. |
| workspace | string | The name of the user's workspace. |
| syncCreateTime | string | Specify a creation time. |
| syncModifyTime | string | Specify a modified time. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| AddSyncFileResult | string |
If the operation succeeded, a UUID will be returned.
If the operation failed, a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<AddSyncFile xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<parentId>bf2ab44c-da3c-4285-bb45-2958dbbe3dea</parentId>
<name>MyFile.txt</name>
<content>base64Binary</content>
<workspace>MyWorkspace</workspace>
<syncCreateTime>11/15/2011 12:00:00 AM</syncCreateTime>
<syncModifyTime>11/16/2011 4:34:00 PM</syncModifyTime>
</AddSyncFile>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<AddSyncFileResponse xmlns="http://tempuri.org/">
<AddSyncFileResult>
bf1a7cdc-930b-45ff-bdd3-2ce9994c9428
</AddSyncFileResult>
</AddSyncFileResponse>
</soap:Body>
</soap:Envelope>
AddSyncFolder
The AddSyncFolder function is similar to the AddFolder function except that it allows you to
specify a creation time and modified time for the folder being added. This helps out with applications that perform bi-directional syncs.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| parentId | string | The ID of the cabinet or folder in which the new folder will be added. |
| name | string | The folder name. |
| workspace | string | The name of the user's workspace. |
| syncCreateTime | string | Specify a creation time. |
| syncModifyTime | string | Specify a modified time. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| AddSyncFolderResult | string |
If the operation succeeded, a UUID will be returned.
If the operation failed, a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<AddSyncFolder xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<parentId>dfac627e-26c1-4e34-bde3-17c0a049c6c3</parentId>
<name>MyFolder</name>
<workspace>MyWorkspace</workspace>
<syncCreateTime>11/15/2011 12:00:00 AM</syncCreateTime>
<syncModifyTime>11/16/2011 4:34:00 PM</syncModifyTime>
</AddSyncFolder>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<AddSyncFolderResponse xmlns="http://tempuri.org/">
<AddSyncFolderResult>
0dcf1037-216c-45e6-a0ff-0872f09ae07b
</AddSyncFolderResult>
</AddSyncFolderResponse>
</soap:Body>
</soap:Envelope>
CheckIn
The CheckIn function allows your application to check in a file after a file has
been checked out by a user. This functionality is useful when your application
requires a particular file to be locked while it is being edited. In order to check
in a file, the file must be first checked out.
Every time a file is checked in, a new version is created by the system.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| content | base64Binary | The content of the file. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| CheckInResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<CheckIn xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>45b4dad5-a176-4055-b445-f3f506d4160e</id>
<content>base64Binary</content>
</CheckIn>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<CheckInResponse xmlns="http://tempuri.org/">
<CheckInResult>
true
</CheckInResult>
</CheckInResponse>
</soap:Body>
</soap:Envelope>
CheckOut
The CheckOut function allows your application to lock or create a new version of
the file. This functionality is useful when the application requires a file to be
locked while it is being edited. In order to check out a file, a user must have
modify rights. Every time a file is checked out a lock status is set on the file.
Modification or edits cannot be performed on that file until it has been checked
in.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The file ID. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| CheckOutResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<CheckOut xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>cc65a3db-bcb8-42d2-8293-30315774bb6b</id>
<content>base64Binary</content>
</CheckOut>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<CheckOutResponse xmlns="http://tempuri.org/">
<CheckOutResult>
true
</CheckOutResult>
</CheckOutResponse>
</soap:Body>
</soap:Envelope>
CopyItem
The CopyItem function allows your application to copy an item to another destination
within DocLanding. The user must have modify and create rights to the copy
destination. A copy function can span across multiple workspaces as long as the
appropriate rights have been assigned.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The ID associated with the file or folder being copied. |
| destId | string | The ID of the cabinet or folder that the item is being copied to. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| CopyItemResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<CopyItem xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>31473d62-20ff-4800-afa8-b9f6323b16f5</id>
<destId>4a8c8a62-a0aa-42d3-9dfa-389f855829ec</destId>
<workspace>MyWorkspace</workspace>
</CopyItem>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<CopyItemResponse xmlns="http://tempuri.org/">
<CopyItemResult>
true
</CopyItemResult>
</CopyItemResponse>
</soap:Body>
</soap:Envelope>
CreateAnnotations
The CreateAnnotations function allows your application to create an annotation layer
for a TIFF file.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| Data | dataset | The annotation data includes a collection of annotation objects. Each annotation object has the coordinates, background color, content text, and type of annotation. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| CreateAnnotationResult | dataset | The result will be the same dataset that was passed in with the associated unique ID for each annotation layer. |
SOAP 1.1 Request Example
<?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>
<CreateAnnotations xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<data>dataset</data>
</CreateAnnotations>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<CreateAnnotationsResponse xmlns="http://tempuri.org/">
<CreateAnnotationsResult>
dataset
</CreateAnnotationsResult>
</CreateAnnotationsResponse>
</soap:Body>
</soap:Envelope>
CreateCabinet
The CreateCabinet function allows your application to create a new cabinet in a user's workspace.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| name | string | The name of the folder. |
| workspace | string | The name of the user's workspace. |
| description | string | A description of the cabinet. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| CreateCabinetResult | string |
If the operation succeeded, a UUID will be returned.
If the operation failed, a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<CreateCabinet xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<workspace>MyWorkspace</workspace>
<name>MyCabinetName</name>
<description>A description of the cabinet.</description>
</CreateCabinet>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<CreateCabinetResponse xmlns="http://tempuri.org/">
<CreateCabinetResult>
f508ddb5-1b72-456b-b034-72e310a62b5b
</CreateCabinetResult>
</CreateCabinetResponse>
</soap:Body>
</soap:Envelope>
CreateNewAccount
The CreateNewAccount function allows your application to create a new free user
account.
Input Parameters
| Name | Type | Description |
|---|---|---|
| username | string | A username. |
| password | string | A password. Minimum 8 characters. |
| verifypassword | string | Verify the entered password. |
| string | A valid email address. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| CreateNewAccountResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<CreateNewAccount xmlns="http://tempuri.org/">
<username>Username</username>
<password>Password</password>
<verifyPassword>Password</verifyPassword>
<email>valid@email.com</email>
</CreateNewAccount>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<CreateNewAccountResponse xmlns="http://tempuri.org/">
<CreateNewAccountResult>
true
</CreateNewAccountResult>
</CreateNewAccountResponse>
</soap:Body>
</soap:Envelope>
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| itemId | string | The file ID. |
| usernameOrEmailList | string | The username or email list to share with. |
| secureShare | boolean | true or false |
| canModify | boolean | true or false |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| CreateShareResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<CreateShare xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<itemId>e8ac720c-6bf5-457b-b34c-c9e6fad693b5</itemId>
<usernameOrEmailList>username</usernameOrEmailList>
<secureShare>true</secureShare>
<canModify>false</canModify>
<workspace>MyWorkspace</workspace>
</CreateShare>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<CreateShareResponse xmlns="http://tempuri.org/">
<CreateShareResult>
true
</CreateShareResult>
</CreateShareResponse>
</soap:Body>
</soap:Envelope>
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| itemId | ArrayOfStrings | The file IDs. |
| usernameOrEmailList | string | The username or email list to share with. |
| secureShare | boolean | true or false |
| canModify | boolean | true or false |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| CreateSharesResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<CreateShares xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<itemIds>
e8ac720c-6bf5-457b-b34c-c9e6fad693b5
5915fd9f-4a6f-45bc-8c25-5524822aee4a
6a3ad87b-adc4-4a6c-865e-bf57f22c04e3
</itemIds>
<usernameOrEmailList>username</usernameOrEmailList>
<secureShare>true</secureShare>
<canModify>false</canModify>
<workspace>MyWorkspace</workspace>
</CreateShares>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<CreateSharesResponse xmlns="http://tempuri.org/">
<CreateSharesResult>
true
</CreateSharesResult>
</CreateSharesResponse>
</soap:Body>
</soap:Envelope>
DeleteAnnotation
The DeleteAnnotation function allows your application to delete an annotation layer
from any image file.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| annotationId | string | The annotation ID. |
| itemId | string | The file ID. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| DeleteAnnotationResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<DeleteAnnotation xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<annotationId>ed0017a5-687c-460d-8bac-d3767c01721d</annotationId>
<itemId>bf09337d-b3c4-4f67-8566-38e121af331f</itemId>
</DeleteAnnotation>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<DeleteAnnotationResponse xmlns="http://tempuri.org/">
<DeleteAnnotationResult>
true
</DeleteAnnotationResult>
</DeleteAnnotationResponse>
</soap:Body>
</soap:Envelope>
DeleteItem
The DeleteItem function allows your application to delete an item from a user's workspace.
In order to delete an item, the user must have been granted delete rights.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The file ID. |
| workspace | String | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| DeleteItemResult | Boolean | true or false |
SOAP 1.1 Request Example
<?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>
<DeleteItem xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>e66ae54b-a69e-4fed-bc7b-e1b54f9bb3ab</id>
<workspace>MyWorkspace</workspace>
</DeleteItem>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<DeleteItemResponse xmlns="http://tempuri.org/">
<DeleteItemResult>
true
</DeleteItemResult>
</DeleteItemResponse>
</soap:Body>
</soap:Envelope>
GetAnnotations
The GetAnnotations function allows your application to retrieve all annotation
layers associated with a document's ID.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The file ID. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetAnnotationsResult | dataset | The result will return the dataset of the annotation. |
SOAP 1.1 Request Example
<?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>
<GetAnnotations xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>463d790b-75cb-42db-9140-faac536bec84</id>
</GetAnnotations>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetAnnotationsResponse xmlns="http://tempuri.org/">
<GetAnnotationsResult>
dataset
</GetAnnotationsResult>
</GetAnnotationsResponse>
</soap:Body>
</soap:Envelope>
GetCabinets
The GetCabinets function allows your application to retrieve all cabinets for a user's workspace.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| workspace | String | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetCabinetsResult | record | If the operation was successful the result will contain a record filled with the properties of the cabinet. If the operation failed, NULL will be returned. |
SOAP 1.1 Request Example
<?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>
<GetCabinets xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<workspace>MyWorkspace</workspace>
</GetCabinets>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetCabinetsResponse xmlns="http://tempuri.org/">
<GetCabinetsResult>
<Record>
<AllowEdit>false</AllowEdit>
<AccessCount>0</AccessCount>
<CommentCount>0</CommentCount>
<LibraryId>15079</LibraryId>
<ChildCount>0</ChildCount>
<Id>6cc180c9-4ff6-4054-b01f-da9543bc54bf</Id>
<Name>Main</Name>
<Size>0</Size>
<Version>0</Version>
<ModifiedDate>7/28/2011 10:33:09 AM</ModifiedDate>
<CreatedDate>5/5/2011 10:11:14 AM</CreatedDate>
<Locked>false</Locked>
</Record>
<Record>
<AllowEdit>false</AllowEdit>
<AccessCount>0</AccessCount>
<CommentCount>0</CommentCount>
<LibraryId>16139</LibraryId>
<ChildCount>0</ChildCount>
<Id>25125709-4a3d-4a09-a451-846d297c7b98</Id>
<Name>Sync</Name>
<Size>0</Size>
<Version>0</Version>
<ModifiedDate>9/13/2011 10:05:06 AM</ModifiedDate>
<CreatedDate>8/24/2011 1:36:07 PM</CreatedDate>
<Locked>false</Locked>
</Record>
</GetCabinetsResult>
</GetCabinetsResponse>
</soap:Body>
</soap:Envelope>
GetContent
The GetContent function allows your application to retrieve the content from a file.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The file ID. |
| workspace | string | The name of the user's workspace. |
| version | integer | The version number. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetContentResult | base64Binary | If successful the result will be a binary value otherwise a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<GetContent xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>804d423b-f46b-4f40-9d7c-c0be3dd045fd</id>
<workspace>MyWorkspace</workspace>
<version>2</version>
</GetContent>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetContentResponse xmlns="http://tempuri.org/">
<GetContentResult>
base64Binary
</GetContentResult>
</GetContentResponse>
</soap:Body>
</soap:Envelope>
GetItemInfo
The GetItemInfo function allows your application to retrieve the item detail for an item.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The file ID. |
| workspace | String | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| size | long | File size in bytes. |
| libraryID | integer | The file cabinet's numeric ID |
| parentID | string | The ID of the cabinet or folder in which the item resides. |
| fileID | string | The file ID. |
| name | string | The name of the file. |
| virtualPath | string | The virtual path represents the location of the file within DocLanding workspace. |
| version | Integer | The item version number. If the version is 0 or 1 then there are no other versions for that file. |
| workspace | String | The name of the user's workspace. |
| modifiedDate | String | The date the file was last modified. |
| createdDate | String | The date the file was uploaded. |
SOAP 1.1 Request Example
<?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>
<GetItemInfo xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>97297475-bc4d-4075-b77a-af425e670220</id>
<workspace>MyWorkspace</workspace>
</GetItemInfo>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetItemInfoResponse xmlns="http://tempuri.org/">
<GetItemInfoResult>
<Size>585493</Size>
<LibraryID>16139</LibraryID>
<ParentID>10948456-98f6-4627-a0bb-6c4d032517d2</ParentID>
<FileID>9dc829ea-8ca2-4540-a63c-97fe060b58d8</FileID>
<Name>MyFile.txt</Name>
<VirtualPath>/MyCabinet/MyFile.txt</VirtualPath>
<Version>1</Version>
<Workspace>MyWorkspace</Workspace>
<ModifiedDate>9/13/2011 10:05:15 AM</ModifiedDate>
<CreatedDate>9/12/2011 3:21:03 PM</CreatedDate>
</GetItemInfoResult>
</GetItemInfoResponse>
</soap:Body>
</soap:Envelope>
GeItemVirtualPath
The GeItemVirtualPath function allows your application to retrieve an item's virtual path with a user's workspace.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| itemId | string | The file ID. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetItemVirtualPathResult | string | If successful the result will be a string containing the virtual path of the item. Otherwise a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<GetItemVirtualPath xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<workspace>MyWorkspace</workspace>
<itemId>97297475-bc4d-4075-b77a-af425e670220</itemId>
</GetItemVirtualPath>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetItemVirtualPathResponse xmlns="http://tempuri.org/">
<GetItemVirtualPathResult>
MyCabinet/MyFolder
</GetItemVirtualPathResult>
</GetItemVirtualPathResponse>
</soap:Body>
</soap:Envelope>
GetItems
The GetItems function allows your application to retrieve items from a specific cabinet or folder.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| parentId | string | The ID of the cabinet or folder. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetItemsResult | arrayOfRecords | If successful the result will be an array of records. Otherwise a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<GetItems xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<workspace>MyWorkspace</workspace>
<parentId>7531148e-02c8-4067-9b1a-8a3f879de287</parentId>
</GetItems>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetItemsResponse xmlns="http://tempuri.org/">
<GetItemsResult>
<Record>
<AllowEdit>false</AllowEdit>
<Type>File</Type>
<AccessCount>0</AccessCount>
<CommentCount>0</CommentCount>
<LibraryId>16139</LibraryId>
<VirtualPath>/MyCabinet/MyFile.txt</VirtualPath>
<ChildCount>0</ChildCount>
<Id>0986f69f-ba6e-4afa-a2a0-63b80770b524</Id>
<Name>MyFile.txt</Name>
<Size>585493</Size>
<Version>0</Version>
<Author>MyUsername</Author>
<ModifiedDate>9/13/2011 10:05:15 AM</ModifiedDate>
<CreatedDate>9/12/2011 3:21:03 PM</CreatedDate>
<Locked>false</Locked>
</Record>
<Record>
<AllowEdit>false</AllowEdit>
<Type>Folder</Type>
<AccessCount>0</AccessCount>
<CommentCount>0</CommentCount>
<LibraryId>16139</LibraryId>
<VirtualPath>/MyCabinet/MyFolder</VirtualPath>
<ChildCount>0</ChildCount>
<Id>11f25060-f7f9-4c97-9727-203a695cedec</Id>
<Name>MyFolder</Name>
<Size>0</Size>
<Version>1</Version>
<Author>MyUsername</Author>
<ModifiedDate>9/13/2011 10:35:15 AM</ModifiedDate>
<CreatedDate>9/12/2011 3:01:03 PM</CreatedDate>
<Locked>false</Locked>
</Record>
</GetItemsResult>
</GetItemsResponse>
</soap:Body>
</soap:Envelope>
GetOriginalContent
The GetOriginalContent function allows your application to retrieve the original
content of a file regardless if the file has multiple versions.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The file ID. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetOriginalContentResult | base64Binary | The binary content of the file. |
SOAP 1.1 Request Example
<?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>
<GetOriginalContent xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<Id>dab220c7-614f-4147-b7dd-37bd308628a3</Id>
<workspace>MyWorkspace</workspace>
</GetOriginalContent>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetOriginalContentResponse xmlns="http://tempuri.org/">
<GetOriginalContentResult>
base64Binary
</GetOriginalContentResult>
</GetOriginalContentResponse>
</soap:Body>
</soap:Envelope>
GetPathID
The GetPathID function allows your application to retrieve the ID of any item
given its path. This function is useful because it relieves your application from having to do expensive traversals through the user's workspace.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| pathString | string | The path to the file or folder. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetPathIDResult | string | If successful the result will be a string containing the unique ID of the item. Otherwise a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<GetPathID xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<workspace>MyWorkspace</workspace>
<pathString>/MyCabinet/MyFile.txt</pathString>
</GetPathID>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetPathIDResponse xmlns="http://tempuri.org/">
<GetPathIDResult>
9c907d34-d1f7-4f5a-883d-8bc8a1783579
</GetPathIDResult>
</GetPathIDResponse>
</soap:Body>
</soap:Envelope>
GetRecentlyAddedFiles
The GetRecentlyAddedFiles function allows your application to retrieve the recently
added files from a workspace.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetRecentlyAddedFilesResult | record[] | If successful the result will be an array of records. Otherwise a NULL value will be returned. |
SOAP 1.1 Request Example
<?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>
<GetRecentlyAddedFiles xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
</GetRecentlyAddedFiles>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetRecentlyAddedFilesResponse xmlns="http://tempuri.org/">
<GetRecentlyAddedFilesResult>
<Record>
<AllowEdit>false</AllowEdit>
<Type>File</Type>
<AccessCount>0</AccessCount>
<CommentCount>0</CommentCount>
<LibraryId>16139</LibraryId>
<VirtualPath>/MyCabinet/MyFile.txt</VirtualPath>
<ChildCount>0</ChildCount>
<Id>0986f69f-ba6e-4afa-a2a0-63b80770b524</Id>
<Name>MyFile.txt</Name>
<Size>585493</Size>
<Version>0</Version>
<Author>MyUsername</Author>
<ModifiedDate>9/13/2011 10:05:15 AM</ModifiedDate>
<CreatedDate>9/12/2011 3:21:03 PM</CreatedDate>
<Locked>false</Locked>
</Record>
<Record>
<AllowEdit>false</AllowEdit>
<Type>File</Type>
<AccessCount>0</AccessCount>
<CommentCount>0</CommentCount>
<LibraryId>16139</LibraryId>
<VirtualPath>/MyCabinet/MyFile2.txt</VirtualPath>
<ChildCount>0</ChildCount>
<Id>11f25060-f7f9-4c97-9727-203a695cedec</Id>
<Name>MyFile2.txt</Name>
<Size>0</Size>
<Version>1</Version>
<Author>MyUsername</Author>
<ModifiedDate>9/13/2011 10:35:15 AM</ModifiedDate>
<CreatedDate>9/12/2011 3:01:03 PM</CreatedDate>
<Locked>false</Locked>
</Record>
</GetRecentlyAddedFilesResult>
</GetRecentlyAddedFilesResponse>
</soap:Body>
</soap:Envelope>
GetUserDetail
The GetUserDetail function allows your application to retrieve information for a
user.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| FirstName | string | The user's first name. |
| LastName | string | The user's last name. |
| UserName | string | The user's username. |
| Type | string | The plan type associated with the user's account. |
| MaxStorage | double | The maximum amount of storage in bytes for the user's account. |
| CurrentStorage | double | The current amount of storage in bytes for the user's account. |
| string | The user's email. | |
| PromotionCode | string |
The promotion code that is linked to a user's account. For internal use only. |
| UserWorkspace | string | The user's default workspace. |
| DesktopCode | string | The DesktopCode can be 0or 1which represents whether or not the user is using our Desktop Client. |
| SyncCode | string | The SyncCode can be 0or 1which represents whether or not the user is using our Sync Client. |
| MobileCode | string | The MobileCode can be 0or 1which represents whether or not the user is using our Mobile Client. |
SOAP 1.1 Request Example
<?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>
<GetUserDetail xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
</GetUserDetail>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetUserDetailResponse xmlns="http://tempuri.org/">
<GetUserDetailResult>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<UserName>john.doe</UserName>
<Type>Personal</Type>
<MaxStorage>2</MaxStorage>
<CurrentStorage>0.5</CurrentStorage>
<Email>valid@email.com</Email>
<UserWorkspace>john.doe</UserWorkspace>
</GetUserDetailResult>
</GetUserDetailResponse>
</soap:Body>
</soap:Envelope>
GetUserWorkspaces
The GetUserWorkspaces function allows your application to retrieve all the workspaces associated with a user.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| GetUserWorkspacesResult | ArrayOfWorkspaces | An array of Workspace objects. |
SOAP 1.1 Request Example
<?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>
<GetUserWorkspaces xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
</GetUserWorkspaces>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<GetUserWorkspacesResponse xmlns="http://tempuri.org/">
<GetUserWorkspacesResult>
<Workspace>
<Name>MyWorkspace</Name>
<Email>userA@email.com</Email>
<DisplayName>My POINT</DisplayName>
<Selected>true</Selected>
</Workspace>
<Workspace>
<Name>WorkspaceB</Name>
<Email>userB@email.com</Email>
<DisplayName>Workspace B</DisplayName>
<Selected>false</Selected>
</Workspace>
</GetUserWorkspacesResult>
</GetUserWorkspacesResponse>
</soap:Body>
</soap:Envelope>
HasEditRight
The HasEditRight function allows your application to retrieve whether a user has the right to edit a specific file, folder, or cabinet.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The unique DocLanding ID for the file, folder, or cabinet. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| HasEditRightResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<HasEditRight xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>8fc1769c-04e3-42ea-ba92-ceb5477aba85</id>
<workspace>MyWorkspace</workspace>
</HasEditRight>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<HasEditRightResponse xmlns="http://tempuri.org/">
<HasEditRightResult>
true
</HasEditRightResult>
</HasEditRightResponse>
</soap:Body>
</soap:Envelope>
IsCheckOut
The IsCheckOut function allows your application to retrieve whether a file is currently checked out.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The unique DocLanding ID for the file. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| IsCheckOutResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<IsCheckOut xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>1d939c0b-c776-4451-af7a-380c76563f54</id>
</IsCheckOut>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<IsCheckOutResponse xmlns="http://tempuri.org/">
<IsCheckOutResult>
false
</IsCheckOutResult>
</IsCheckOutResponse>
</soap:Body>
</soap:Envelope>
Login
The Login function allows your application to retrieve a session ID.
Input Parameters
| Name | Type | Description |
|---|---|---|
| developerKey | string | The developer key assigned to you. |
| username | string | The user's username. |
| password | string | The user's password. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| LoginResult | string | A session ID. |
SOAP 1.1 Request Example
<?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>
<Login xmlns="http://tempuri.org/">
<username>Username</username>
<password>Password</password>
</Login>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<LoginResponse xmlns="http://tempuri.org/">
<LoginResult>
BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==
</LoginResult>
</LoginResponse>
</soap:Body>
</soap:Envelope>
MoveItem
The MoveItem function allows your application to move a file or folder to another cabinet or folder.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The unique DocLanding ID of the file or folder being moved. |
| destId | string | The unique DocLanding ID of the folder or cabinet that the file or folder is being moved to. |
| workspace | string | The name of the user's workspace. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| MoveItemResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<MoveItem xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>409c913b-32d4-44b8-b5c7-0818f622fa86</id>
<destId>6ee3cde2-c370-4606-8d27-5d1120ae6d5c</destId>
<workspace>MyWorkspace</workspace>
</MoveItem>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<MoveItemResponse xmlns="http://tempuri.org/">
<MoveItemResult>
true
</MoveItemResult>
</MoveItemResponse>
</soap:Body>
</soap:Envelope>
RenameItem
The RenameItem function allows your application to rename a cabinet, file, or folder.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| workspace | string | The name of the user's workspace. |
| id | string | The unique DocLanding ID of the file or folder being renamed. |
| newName | string | The new name of the file or folder. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| RenameItemResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<RenameItem xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<workspace>MyWorkspace</workspace>
<id>64e62e37-243a-41a7-a8c8-4c35160b887f</id>
<newName>NewName</newName>
</RenameItem>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<RenameItemResponse xmlns="http://tempuri.org/">
<RenameItemResult>
true
</RenameItemResult>
</RenameItemResponse>
</soap:Body>
</soap:Envelope>
SearchWorkspace
The SearchWorkspace function allows your application to perform a search within a user's workspace.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| workspace | string | The name of the user's workspace. |
| query | string | A query parameter can be a text value or a combination of words and phrases. Please refer to DocLanding query syntax section for more detail. |
| page | integer | The page parameter represents the page number of the search result. By default a value of 0 should be passed in when the first call is performed. |
| perPage | integer | The number of results returned per page. By default this is 100. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| SearchWorkspaceResult | ArrayOfRecords | An array of record objects. |
| total | integer | The number of hits found. |
SOAP 1.1 Request Example
<?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>
<SearchWorkspace xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<workspace>MyWorkspace</workspace>
<query>"test.txt"</query>
<page>0</page>
<perPage>100</perPage>
</SearchWorkspace>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<SearchWorkspaceResponse xmlns="http://tempuri.org/">
<SearchWorkspaceResult>
<Records>
<Record>
<AllowEdit>false</AllowEdit>
<AccessCount>0</AccessCount>
<CommentCount>0</CommentCount>
<LibraryId>15079</LibraryId>
<VirtualPath>Main test.txt</VirtualPath>
<ChildCount>0</ChildCount>
<Id>e3ff4738-c4a0-48b3-8c58-8d0697313b99</Id>
<Workspace>MyWorkspace</Workspace>
<Name>test.txt</Name>
<Size>0</Size>
<Version>0</Version>
<Author>MyUsername</Author>
<ModifiedDate>11/15/2011</ModifiedDate>
<CreatedDate>11/15/2011</CreatedDate>
<Locked>false</Locked>
</Record>
</Records>
<Total>1</Total>
</SearchWorkspaceResult>
</SearchWorkspaceResponse>
</soap:Body>
</soap:Envelope>
SyncRenameItem
The SyncRenameItem function is similar to the RenameItem function except it
allows you to specify a modified date. This helps out with applications that peform bi-directional syncs.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| workspace | string | The name of the user's workspace. |
| id | string | The unique DocLanding ID of the file or folder being renamed. |
| newName | string | The new name of the file or folder. |
| modifiedDate | string | The modified date of the item being renamed. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| SyncRenameItemResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<SyncRenameItem xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<workspace>MyWorkspace</workspace>
<id>1b2b5799-b170-47c1-bf0c-d8ba6d104244</id>
<newName>New Name</newName>
<modifiedDate>11/16/2011 4:34:00 PM</modifiedDate>
</SyncRenameItem>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<SyncRenameItemResponse xmlns="http://tempuri.org/">
<SyncRenameItemResult>
true
</SyncRenameItemResult>
</SyncRenameItemResponse>
</soap:Body>
</soap:Envelope>
UndoCheckOut
The UndoCheckOut function allows your application to undo a check out.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| workspace | string | The name of the user's workspace. |
| id | string | The unique DocLanding ID of the file or folder being renamed. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| UndoCheckOutResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<UndoCheckOut xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>0c90a754-c991-4477-9107-dcedb1f25dc1</id>
</UndoCheckOut>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<UndoCheckOutResponse xmlns="http://tempuri.org/">
<UndoCheckOutResult>
true
</UndoCheckOutResult>
</UndoCheckOutResponse>
</soap:Body>
</soap:Envelope>
UpdateAnnotations
The UpdateAnnotations function allows your application to update annotations for a file.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| data | dataset | The annotation data. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| UpdateAnnotationsResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<UpdateAnnotations xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<data>dataset</data>
</UpdateAnnotations>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<UpdateAnnotationsResponse xmlns="http://tempuri.org/">
<UpdateAnnotationsResult>
true
</UpdateAnnotationsResult>
</UpdateAnnotationsResponse>
</soap:Body>
</soap:Envelope>
UpdateContent
The UpdateContent function allows your application to update the existing file content with new content without creating a new version.
WARNING: This function will OVERRIDE the original content and is not recommended. Consider using the AddNewFileVersion function.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The file ID. |
| content | base64Binary | The binary content of the file. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| UpdateContentResult | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<UpdateContent xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>3a7b8d0d-8bf8-42d0-9020-0251c23d6ebb</id>
<content>base64Binary</content>
</UpdateContent>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<UpdateContentResponse xmlns="http://tempuri.org/">
<UpdateContentResult>
true
</UpdateContentResult>
</UpdateContentResponse>
</soap:Body>
</soap:Envelope>
ValidateTicket
The ValidateTicket function allows your application to validate an existing session ID. This function is helpful to safeguard against a stale session ID.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| PerformAction | string | The users access rights. |
| WorkspaceUserID | GUID | The workspace User ID |
| WorkspaceName | string | The name of the POINT or workspace |
| Username | string | Username |
| string | ||
| Icon | string | Binary Format Icon that the user selected. Not currently supported |
| DisplayName | string | The name that is displayed in place of the workspace name. |
| Admin | boolean | true or false |
SOAP 1.1 Request Example
<?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>
<ValidateTicket xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
</ValidateTicket>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<ValidateTicketResponse xmlns="http://tempuri.org/">
<ValidateTicketResult>
<WorkspaceUserID>
5debf973-02e3-428c-9e5c-619c0817018d
</WorkspaceUserID>
<WorkspaceName>MyWorkspaceName</WorkspaceName>
<Username>MyUsername</Username>
<Email>valid@email.com</Email>
<Admin>true</Admin>
</ValidateTicketResult>
</ValidateTicketResponse>
</soap:Body>
</soap:Envelope>
VersionNumber
The VersioNumber function allows your application to check the version number of a file.
Input Parameters
| Name | Type | Description |
|---|---|---|
| sessionId | string | The session ID obtained through the Login function. |
| developerKey | string | The developer key assigned to you. |
| id | string | The file ID. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| VersionNumberResponse | int | The version number |
SOAP 1.1 Request Example
<?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>
<VersionNumber xmlns="http://tempuri.org/">
<sessionId>BhnBUCq0jIxsxid0sziA/jBi5XBfCbAGjcLMs6f9XOg==</sessionId>
<id>7bf1b359-c909-40ed-8ff0-1a286a2005ba</id>
</VersionNumber>
</soap:Body>
</soap:Envelope>
SOAP 1.1 Response Example
<?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>
<VersionNumberResponse xmlns="http://tempuri.org/">
<VersionNumberResult>
3
</VersionNumberResult>
</VersionNumberResponse>
</soap:Body>
</soap:Envelope>
Examples
Coming soon!