Overview

Start to build
Do you have an account with Filer? Then log in so that Filer can show specific settings for your account. Log in
Files
Search files Download file Download file attachments Retrieve file contents Add file Modify file data Rename file Delete file File information File changes
Directories
Directory information Synchronize directory Directory content
Handshakes
Request handshake
Response handling
Success Warnings Warning codes Errors Error codes

Search files

GET https://api.bestand-zoekmachine.nl/Search/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
Search STRING Specify the search term you want to search for
FileGroups[] ARRAY (STRING) Optional Specify the file groups in which you want to search. Any other file groups will be skipped. If you do not specify file groups, the search will be carried out within all file groups The file groups must be part of the specified handshake
Limit INT Optional Enter the maximum number of results per page. This value then overwrites your default setting The specified limit must be between 5 and 250
Page INT Optional Enter the number of the page you want to load. Filer then takes the right page of your results into account
SortBy STRING Optional Specify the sorting of the results. By default, the result is sorted by relevance Relevance FileSize Date
SortOrder STRING Optional Specify the sort order of the results. By default, the result is sorted in descending order DESC ASC
ReturnFields[] ARRAY (STRING) Optional Specify the specific fields that you want to get back. If you do not specify fields, all fields will be returned Durations CustomID Name Server Path Author FileGroup Type Dimension LastModified Deleted DeletedOn Downloadable TagsFound Meta Properties Attachments Snippet Score Pagination ShownResults

Request

		
			curl -X GET -G https://api.bestand-zoekmachine.nl/Search/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "Search=Filer year:2024" \
			-d "FileGroups[]=Example group"
            -d "FileGroups[]=Info Mailbox"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"Search" => "Filer year:2024",
				"FileGroups" => array(
					"Example group",
                    "Info Mailbox"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/Search/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Results": {
        "Count": 2,
        "Files": [
            {
                "CustomID": "5883739",
                "Name": "example.xls",
                "Server": "GOF001",
                "Path": {
                    "Show": "Filer example directory",
                    "Real": "GOFSERV001\\directory"
                },
                "Author": "Filer",
                "FileGroup": "Example group",
                "Type": "FILE",
                "Dimension": {
                    "Size": 28.9,
                    "Type": "kB"
                },
                "LastModified": "2024-05-25T21:38:53Z",
                "Deleted": true,
                "DeletedOn": "2024-05-25T21:48:53Z",
                "Downloadable": true,
                "Attachments": {
                    "Count": 1,
                    "Items": [
                        {
                            "Name": "2024.png",
                            "Downloadable": true,
                            "CreationDate": "2024-05-24T20:01:53Z"
                        }
                    ]
                },
                "TagsFound": [
                    "Tag1",
                    "Tag2"
                ],
                "Meta": {
                    "extra": "test file"
                },
                "Properties": null,
                "Snippet": "example file created by <snip>Filer<\/snip> to demonstrate the API",
                "Score": 5
            },
            {
                "CustomID": "1603290513319",
                "Name": "Re: Filer - 1716664733.eml",
                "Path": [
                    "GOF001",
                    "info@filer.eu",
                    "INBOX"
                ],
                "Author": "Filer info@filer.eu",
                "FileGroup": "Info Mailbox",
                "Type": "EMAIL",
                "Dimension": {
                    "Size": 32.58,
                    "Type": "kB"
                },
                "LastModified": "2024-05-25T21:18:53Z",
                "Deleted": false,
                "DeletedOn": null,
                "Downloadable": true,
                "Attachments": {
                    "Count": 1,
                    "Items": [
                        {
                            "Name": "Filer.png",
                            "Downloadable": true,
                            "CreationDate": "2024-05-24T03:57:53Z"
                        }
                    ]
                },
                "TagsFound": [],
                "Meta": null,
                "Properties": {
                    "Message-ID": "<09382507-2db942b6-1603285058-26379944339@mail.filer.eu>",
                    "Mailbox": "INBOX",
                    "Subject": "Re: Filer",
                    "From": {
                        "Name": "Filer",
                        "Address": "info@filer.eu"
                    },
                    "To": [
                        {
                            "Name": "Filer",
                            "Address": "info@filer.eu"
                        }
                    ],
                    "CC": [],
                    "BCC": []
                },
                "Snippet": "example e-mail sent by <snip>Filer<\/snip> to demonstrate the API",
                "Score": 5
            }
        ]
    },
    "Pagination": null,
    "ShownResults": {
        "Min": 1,
        "Max": 2
    },
    "Durations": {
        "Searching": 0.1,
        "Fetching": 0.4,
        "Parsing": 0.15,
        "Total": 0.65
    }
}

Download file

GET https://api.bestand-zoekmachine.nl/File/Download/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FilePath STRING Specify the file location of the file that you want to download
CustomID STRING Specify the unique ID of the file you want to download. The file can also be downloaded via the file location The unique ID is only used if the FilePath is not specified
FileGroup STRING Specify the file group in which you want to download the file The file group must be part of the specified handshake

Request

		
			curl -X GET -G https://api.bestand-zoekmachine.nl/File/Download/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_NbVhMn5eX8WuotQaob5gktfy9tC0NI7ktdPFOUsvcMnQDDy1o2gWvLT2Ff3ax8Joli29Ds2nEpCR2AToC7L5So8fR9GPHXB1" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_NbVhMn5eX8WuotQaob5gktfy9tC0NI7ktdPFOUsvcMnQDDy1o2gWvLT2Ff3ax8Joli29Ds2nEpCR2AToC7L5So8fR9GPHXB1",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group"
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/Download/",
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_TxXsGZGBLZX5ihM0X3q5T6OXPEG0k0yBvT3B2HMMprPXZlX4mN9DTVlrjzrRzncuGe3HvNbkF0FmlmoW8yjZRUQBTHaQ4BIJ",
    "File": {
        "LastModified": "2024-05-25T21:38:53Z",
        "Dimension": {
            "Size": 5884,
            "Type": "B"
        },
        "Base64": "QkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBmaWxlIEJBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgZmlsZSBCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGZpbGUgQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBmaWxlIEJBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgZmlsZSBCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGZpbGUgQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBmaWxlIEJBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgZmlsZSBCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGZpbGUgQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBmaWxl"
    }
}

Download file attachments

GET https://api.bestand-zoekmachine.nl/File/Download/Attachments/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FilePath STRING Specify the file location of the main file for which you want to download attachments
CustomID STRING Specify the unique ID of the main file for which you want to download attachments. The main file can also be specified via the file location The unique ID is only used if the FilePath is not specified
FileGroup STRING Specify the file group in which you want to download the attachments The file group must be part of the specified handshake
AttachmentNames ARRAY (STRING) Specify the names of the attachments you want to download

Request

		
			curl -X GET -G https://api.bestand-zoekmachine.nl/File/Download/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_NbVhMn5eX8WuotQaob5gktfy9tC0NI7ktdPFOUsvcMnQDDy1o2gWvLT2Ff3ax8Joli29Ds2nEpCR2AToC7L5So8fR9GPHXB1" \
			-d "FilePath=\\GOFSERV001\directory\example.pdf" \
			-d "FileGroup=Example group" \
			-d "AttachmentNames[]=Image001.png" \
			-d "AttachmentNames[]=Image002.png"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_NbVhMn5eX8WuotQaob5gktfy9tC0NI7ktdPFOUsvcMnQDDy1o2gWvLT2Ff3ax8Joli29Ds2nEpCR2AToC7L5So8fR9GPHXB1",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.pdf",
				"FileGroup" ="Example group",
				"AttachmentNames" => array(
					"Image001.png",
					"Image002.png"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/Download/",
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_TxXsGZGBLZX5ihM0X3q5T6OXPEG0k0yBvT3B2HMMprPXZlX4mN9DTVlrjzrRzncuGe3HvNbkF0FmlmoW8yjZRUQBTHaQ4BIJ",
    "Attachments": {
        "Image001.png": {
            "Dimension": {
                "Size": 1621,
                "Type": "B"
            },
            "Base64": "QkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAxLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMS5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDEucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAxLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMS5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDEucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAxLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMS5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDEucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAxLnBuZw=="
        },
        "Image002.png": {
            "Dimension": {
                "Size": 6327,
                "Type": "B"
            },
            "Base64": "QkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAyLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMi5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDIucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAyLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMi5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDIucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAyLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMi5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDIucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAyLnBuZw=="
        }
    }
}

Retrieve file contents

GET https://api.bestand-zoekmachine.nl/File/Content/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FilePath STRING Specify the file location of the file whose contents you want to retrieve
CustomID STRING Specify the unique ID of the file whose contents you want to retrieve. The content of the file can also be retrieved via the file location The unique ID is only used if the FilePath is not specified
FileGroup STRING Specify the file group for the file whose contents you want to retrieve The file group must be part of the specified handshake

Request

		
			curl -X GET -G https://api.bestand-zoekmachine.nl/File/Content/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group" \
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group",
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/Content/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "PUT",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Content": "This is the content for the file processed by Filer"
}

Add file

POST https://api.bestand-zoekmachine.nl/File/Add/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated You can update an existing file by submitting the file again

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FilePath STRING Specify the file location of the file that you want to add to the queue The file locatoin must be part of a specified folder within a file group
FileGroup STRING Optional Specify the file group in which you want to place the file. Possibly other file groups where the file could fall under will be skipped. If you do not specify a file group, the file will be added to all file groups with a matching file folder within the specified handshake The file group must be part of the specified handshake
Priority INT Optional Specify the priority for the file. A higher priority gives the file a priority over files with a lower priority The specified priority should be between 0 and 1000
CustomID STRING Optional Enter a unique ID to identify the file later on
ExtraContent STRING Optional Specify up to 100,000 characters to add to the content of the file
Meta JSON Optional Specify additional data with the file. Filer then ensures that this metadata is presented when requesting the file
Tags[] ARRAY (STRING) Optional Specify tags with the file so that files can be found even faster and better. A tag must consist of one word without spaces of up to 30 characters long. All tags together can not contain more than 100,000 characters During the search for files, the tags are also searched, in which search terms found in the tags have a heavier weighting than the search terms found in the contents of the file

Request

		
			curl -X POST -G https://api.bestand-zoekmachine.nl/File/Add/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group" \
			-d "CustomID=5883739" \
			-d "ExtraContent=Filer is awesome" \
			-d "Meta={\"wordcount\": 577382, \"extra\": \"example file\"}" \
			-d "Tags[]=Tag1" \
			-d "Tags[]=Tag2" \
			-d "Tags[]=Tag3"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group",
				"CustomID" => "5883739",
				"ExtraContent" => "Filer is awesome",
				"Meta" => "{\"wordcount\": 577382, \"extra\": \"example file\"}",
				"Tags" => array(
					"Tag1",
					"Tag2",
					"Tag3",
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_POST => true,
					CURLOPT_POSTFIELDS => http_build_query($params),
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/Add/",
					CURLOPT_CUSTOMREQUEST => "POST",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe"
}

Modify file data

PUT https://api.bestand-zoekmachine.nl/File/Change/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FilePath STRING Specify the file location of the file whose ExtraContent, Metadata and/or Tags you want to change
CustomID STRING Optional Specify the unique ID of the file whose ExtraContent, Metadata and/or Tags you want to change. The file can also be changed via the file location The unique ID is only used if the FilePath is not specified
FileGroup STRING Optional Specify file group in which you want to change the file. Possibly other file groups where the file could fall under will be skipped. If you do not specify a file group, the file will be changed in all file groups with a matching file folder within the specified handshake The file group must be part of the specified handshake
ExtraContent STRING Optional Specify up to 100,000 characters to add to the content of the file Specify the new data that the file needs to be updated. If you do not provide this field, the old data will be removed from this field. Note that the old data will be completely overwritten
Meta JSON Optional Specify additional data with the file. Filer then ensures that this metadata is presented when requesting the file Specify the new data that the file needs to be updated. If you do not provide this field, the old data will be removed from this field. Note that the old data will be completely overwritten
Tags[] ARRAY (STRING) Optional Specify tags with the file so that files can be found even faster and better. A tag must consist of one word without spaces of up to 30 characters long. All tags together can not contain more than 100,000 characters Specify the new data that the file needs to be updated. If you do not provide this field, the old data will be removed from this field. Note that the old data will be completely overwritten

Request

		
			curl -X PUT -G https://api.bestand-zoekmachine.nl/File/Change/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group" \
			-d "CustomID=5883739" \
			-d "ExtraContent=Filer is even more awesome" \
			-d "Meta={\"wordcount\": 577382, \"extra\": \"example file which has been changed\"}" \
			-d "Tags[]=Tag1_changed" \
			-d "Tags[]=Tag2_changed" \
			-d "Tags[]=Tag3_changed"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group",
				"CustomID" => "5883739",
				"ExtraContent" => "Filer is even more awesome",
				"Meta" => "{\"wordcount\": 577382, \"extra\": \"example file which has been changed\"}",
				"Tags" => array(
					"Tag1_changed",
					"Tag2_changed",
					"Tag3_changed",
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/Change/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "PUT",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe"
}

Rename file

PUT https://api.bestand-zoekmachine.nl/File/Rename/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FilePath STRING Specify the file location of the file that you want to rename
CustomID STRING Specify the unique ID of the file you want to rename. The file can also be renamed via the file location The unique ID is only used if the FilePath is not specified
FilePathNew STRING Specify the new file location of the file
FileGroup STRING Optional Specify the file group in which you want to rename the file. Any other file groups that include the file will also be skipped. If you do not specify a file group, the file will be renamed within all the file groups that this file is part of The file group must be part of the specified handshake

Request

		
			curl -X PUT -G https://api.bestand-zoekmachine.nl/File/Rename/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FilePathNew=\\GOFSERV001\directory\example_new.xls" \
			-d "FileGroup=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FilePathNew" => "\\\\GOFSERV001\\directory\\example_new.xls",
				"FileGroup" => "Example group"
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/Rename/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "PUT",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_TxXsGZGBLZX5ihM0X3q5T6OXPEG0k0yBvT3B2HMMprPXZlX4mN9DTVlrjzrRzncuGe3HvNbkF0FmlmoW8yjZRUQBTHaQ4BIJ"
}

Delete file

DELETE https://api.bestand-zoekmachine.nl/File/Delete/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FilePath STRING Specify the file location of the file you want to delete. The file can also be deleted via the unique ID
CustomID STRING Optional Specify the unique ID of the file you want to delete. The file can also be deleted via the file location The unique ID is only used if the FilePath is not specified. When a file is deleted with the CustomID, the file is immediately forced to be deleted, regardless of your backup settings within the file group
FileGroup STRING Optional Specify the file group in which you want to delete the file. Any other file groups that include the file will also be skipped. If you do not specify a file group, the file will be deleted within all the file groups that this file is part of The file group must be part of the specified handshake
Forced BOOL Optional Specify whether the file should be deleted immediately, regardless of your backup settings within the file group

Request

		
			curl -X DELETE -G https://api.bestand-zoekmachine.nl/File/Delete/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group"
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/Delete/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "DELETE",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_TxXsGZGBLZX5ihM0X3q5T6OXPEG0k0yBvT3B2HMMprPXZlX4mN9DTVlrjzrRzncuGe3HvNbkF0FmlmoW8yjZRUQBTHaQ4BIJ"
}

File information

GET https://api.bestand-zoekmachine.nl/File/Information/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FilePath STRING Specify the file location of the file you want to retrieve
CustomID STRING Optional Specify the unique ID of the file you want to retrieve. The file can also be retrieved via the file location The unique ID is only used if the FilePath is not specified
FileGroups[] ARRAY (STRING) Optional Specify the file groups in which you want to retrieve the files. Possibly other file groups where the file could fall under will be skipped. If you do not specify file groups, the files will be requested within all file groups with a matching file folder The file groups must be part of the specified handshake

Request

		
			curl -X GET -G https://api.bestand-zoekmachine.nl/File/Information/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroups[]=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroups" => array(
					"Example group"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/Information/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Information": [
        {
            "CustomID": "5883739",
            "Server": "GOF001",
            "FileGroup": "Example group",
            "Type": "FILE",
            "Author": "Filer",
            "LastModified": "2024-05-24T22:54:53Z",
            "Deleted": true,
            "DeletedOn": "2024-05-25T21:48:53Z",
            "AddedBy": "Syncer",
            "UpdatedOn": "2024-05-25T18:50:53Z",
            "Processed": 1,
            "ProcessedOn": "2024-05-25T18:51:53Z",
            "InDictionary": 1,
            "AddedToDictionaryOn": "2024-05-25T18:52:53Z",
            "InAPIQueue": 0,
            "Downloadable": 1,
            "Attachments": {
                "Count": 1,
                "Items": [
                    {
                        "Name": "2024.png",
                        "Downloadable": true,
                        "CreationDate": "2024-05-24T20:01:53Z"
                    }
                ]
            },
            "Dimension": {
                "Size": 126.47,
                "Type": "kB"
            },
            "WordCount": {
                "Total": 25783,
                "Unique": 3364
            },
            "AverageWordLength": 11,
            "ContentLength": 265564,
            "ExtraContent": "Filer is awesome",
            "Meta": "{\"extra\":\"example file\"}",
            "Tags": [
                "Tag1",
                "Tag2",
                "Tag3"
            ],
            "Properties": null
        }
    ]
}

File changes

GET https://api.bestand-zoekmachine.nl/File/List/Changes/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
FileGroups[] ARRAY (STRING) Optional Specify the file group in which you want to retrieve the modified files. Any other file groups where files have been modified will be skipped. If you do not specify a file group, the changes within all file groups will be requested The file groups must be part of the specified handshake
MinuteWindow INT Specify within which minutes-window you want to retrieve the modified files The minutes-window must be between 1 and 1440
TimeOffset DATETIME (STRING) Optional Specify from which start time you want to retrieve the files. The files from the start time to the end of the minutes window will then be retrieved If you do not specify a start time, the files will be retrieved for the past minutes within the indicated minute window Use the format: YYYY-mm-ddTHH:ii:ssZ in UTC
Limit INT Optional Specify how many modified files you want to retrieve The number of files requested must be between 1 and 10,000

Request

		
			curl -X GET -G https://api.bestand-zoekmachine.nl/File/List/Changes/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FileGroups[]=Example group" \
			-d "TimeOffset=2024-05-25T18:50:53Z"
			-d "MinuteWindow=1440" \
			-d "Limit=1"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroups" => array(
					"Example group"
					),
				"TimeOffset" => "2024-05-25T18:50:53Z",
				"MinuteWindow" => 1440,
				"Limit" => 1
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/File/List/Changes/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Files": [
        {
            "CustomID": "5883739",
            "FileGroup": "Example group",
            "FilePath": "\\\\GOFSERV001\\directory\\example.xls",
            "LastModified": "2024-05-24T22:54:53Z",
            "UpdatedOn": "2024-05-25T19:24:53Z"
        }
    ]
}

Directory information

GET https://api.bestand-zoekmachine.nl/Directory/Information/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
Directory STRING Specify the folder from which you want to retrieve it's information
FileGroups[] ARRAY (STRING) Optional Specify the file groups within which the information should be retrieved. Any other file groups will be skipped. If you do not specify file groups, the contents of all file groups will be retrieved The file groups must be part of the specified handshake

Request

		
			curl -X GET -G https://api.bestand-zoekmachine.nl/Directory/Information/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "Directory=\\GOFSERV001\subdirectory" \
			-d "FileGroups[]=Example group" \
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"Directory" => "\\\\GOFSERV001\\subdirectory",
				"FileGroups" => array(
					"Example group"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/Directory/Information/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Directories": {
        "Example group": [
            {
                "Type": "Automatically",
                "Synchronization": {
                    "Started": "2024-05-25T21:48:30Z",
                    "Completed": "2024-05-25T21:50:53Z",
                    "Duration": 143,
                    "Next": "2024-05-25T23:20:53Z",
                    "Requested": 0
                }
            }
        ]
    }
}

Synchronize directory

PUT https://api.bestand-zoekmachine.nl/Directory/Synchronize/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
Directory STRING Specify the folder from which you want to retrieve the direct content
FileGroups[] ARRAY (STRING) Optional Specify the file groups within which the synchronization must be requested. Any other file groups will be skipped. If you do not enter any file groups, the synchronization of all file groups will be requested The file groups must be part of the specified handshake

Request

		
			curl -X PUT -G https://api.bestand-zoekmachine.nl/Directory/Synchronize/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "Directory=\\GOFSERV001\subdirectory" \
			-d "FileGroups[]=Example group" \
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"Directory" => "\\\\GOFSERV001\\subdirectory",
				"FileGroups" => array(
					"Example group"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/Directory/Synchronize/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "PUT",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe"
}

Directory content

GET https://api.bestand-zoekmachine.nl/Directory/List/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
Handshake STRING Enter your handshake to authenticate your request. See how you request a handshake
Directory STRING Specify the folder from which you want to retrieve the direct content Only files and sub-folders that are directly in this folder are returned
FileGroups[] ARRAY (STRING) Optional Specify the file groups within which the content should be retrieved. Any other file groups will be skipped. If you do not specify file groups, the contents of all file groups will be retrieved The file groups must be part of the specified handshake
LoadDeleted BOOL Optional Specify whether deleted files should be returned. By default, deleted files are not returned This parameter only affects results when the backup functionality is enabled for the requested filegroup(s)

Request

		
			curl -X GET -G https://api.bestand-zoekmachine.nl/Directory/List/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "Directory=\\GOFSERV001\subdirectory" \
			-d "FileGroups[]=Example group" \
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"Directory" => "\\\\GOFSERV001\\subdirectory",
				"FileGroups" => array(
					"Example group"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/Directory/List/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Subdirectories": {
        "Example group": [
            "\\\\GOFSERV001\\subdirectory\\subdirectory2",
            "\\\\GOFSERV001\\subdirectory\\subdirectory3"
        ]
    },
    "Files": {
        "Example group": [
            "example.xls",
            "example2.xls"
        ]
    }
}

Request handshake

POST https://api.bestand-zoekmachine.nl/Handshake/Initialize/ See the list below for all parameters to be able to execute this API request. Any optional parameters will be indicated You only need to request a handshake once via this API request. All other API requests return a new handshake upon successful completion

Parameters

CustomerID INT Enter your clientnumber to authenticate your request
SecretKey STRING Enter the hash of your SecretKey to authenticate your request. Create hash
FileGroups[] ARRAY (STRING) Specify the file groups in which the handshake may be used. File groups that are not specified will be excluded automatically

Request

		
			curl -X POST -G https://api.bestand-zoekmachine.nl/Handshake/Initialize/ \
			-d "CustomerID=2434" \
			-d "SecretKey=PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FileGroups[]=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"SecretKey" => "PWbb97DFzuQy3BvOrQ2J295HV5",
				"FileGroups" => array(
					"Example group"
					)		
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_POST => true,
					CURLOPT_POSTFIELDS => http_build_query($params),
					CURLOPT_URL => "https://api.bestand-zoekmachine.nl/Handshake/Initialize/",
					CURLOPT_CUSTOMREQUEST => "POST",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Response

A successfully handled API request returns an answer in JSON as shown below
{
    "Status": "Success",
    "Handshake": "API_XZnY1Mc1dYYaSzbCDFPYKR2U66Hk3PZbwN7xhkwKGUsiRSsehFAzeDUkJlSM82x2N3z4nvN1OFjphZSOmcMQpq86bbRhdMj0"
}

Success

See below for what answer structure you can expect with a successfully handled API request

Response

A successfully handled API request returns an answer in JSON as shown below. If extra parameters are returned with an API request, this will be stated on the corresponding API page
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe"
}

Warnings

See below what kind of response structure you can expect with a handled API request that reports alerts

Response

When an API request issues one or multiple warning, the request is successfully completed and the response is structured as shown below
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Warnings": [
        {
            "Warning": "...",
            "Code": 0
        },
        {
            "Warning": "...",
            "Code": 0
        },
        {
            "Warning": "...",
            "Code": 0
        }
    ]
}

Warning codes

All warning codes are shown below with the corresponding message
0 General warning
1 The file with the specified unique id is forced to be removed
2 The indicated file could not be found in the specified file group
3 The indicated file could not be found
4 The indicated file group not be found
5 The indicated unique id was already in use. The file will be updated
6 The indicated unique id was already in the queue
7 The indicated file location was already processed. The file will be updated
8 The specified file location was already processed at the number of locations that are indicated. The file will be updated
9 The indicated file has been updated in the queue
10 The indicated installation is currently not processing via the API. The file is not added to the queue
11 The file group already exists. The settings of the file group are updated
12 The file group doesn't exist
13 No file could be found to rename within the specified file group
14 No file could be found to rename
15 The indicated sorting is not one of the options for sorting. The results shown are sorted by relevance
16 The indicated sorting order is not one of the options. The results shown are sorted in descending order
17 The specified limit does not meet the specified minimum limit. The minimum limit has been applied
18 The specified limit does not meet the specified maximum limit. The maximum limit has been applied
19 The indicated field is not known and can not be returned
20 The requested page has no results to show
21 The specified file group is not allowed for this request because this file group is set to be processed through the API
22 The file location corresponds to the specified service within the specified filegroup, but the processing method of the service is not set to API

Errors

See below what kind of response structure you can expect with a handled API request with an error

Response

When an API request issues an error, the response is structured as shown below
{
    "Status": "Error",
    "Error": "...",
    "Code": 0
}

Error codes

All error codes are shown below with the corresponding message
0 General error
101 You have invoked the REST-based API with a wrong method. Use the indicated method to connect to the API for this request
102 A handshake is required for the request, which has not been provided
103 A filepath is required for the request, which has not been provided
104 The specified filepath is invalid
105 The maximum length of the CustomID has been exceeded
106 The maximum length of ExtraContent has been exceeded
107 The specified Meta data must be a valid JSON object
108 The indicated tag consists of several words. A tag must consist of one word without spaces of up to 30 characters long
109 The maximum length of the Tags has been exceeded
110 The file group Filer_ALL is not allowed for this specific request
111 The specified file group couldn't be found
112 The specified unique ID is already in use by another file in the specified file group
113 The specified unique ID is already in use by another file
114 There is a problem with the database, try again
115 A name for the file group is required for the request, which has not been provided
116 Multiple directories to process are required for the request, which has not been provided
117 For the request it is mandatory to indicate whether files should be copied
118 For the request it is mandatory to indicate whether deleted files should be retained
119 For the request it is mandatory to indicate how long deleted files should be retained
120 For the request it is mandatory to indicate whether the directories in the file group have to be resynchronized
121 For the request it is mandatory to specify the name of the installation to which the file group should be linked
122 At least one folder for processing must be specified for the request
123 The number of specified folders to process does not match the folders to show
124 The specified folder is not a sub-folder of the folder to be processed
125 The specified folder is not a sub-folder of the folders to be processed
126 The specified folder is not a sub-folder of the folders to be processed
127 The file can not be renamed to the current file name
128 The handshake Filer_ALL can only be used when the handshake has been initialized with Filer_ALL
129 The request must specify either the file location or the unique ID
130 The specified file couldn't be found
131 A directory is required for the request, which has not been provided
132 The specified directory is invalid
133 The specified directory couldn't be found
134 The SecretKey is required for the request, which has not been provided
135 The specified SecretKey is invalid
136 The specified account is blocked
137 To request a handshake, at least one file group must be specified within which actions may be carried out with the requested handshake
138 The method used for the request is unknown
139 File groups are required for the request, which haven't been provided
140 No matching file groups could be found for your request
141 There are no active file groups. Make sure there is at least one active file group
142 A file group is required for the request, which has not been provided
143 No downloadable file could be found for your request
144 Multiple downloadable files were found for your request
145 The requested file is a website file and therefore may not be downloaded
146 Could not save the download of the file to the statistics. The download has been canceled
147 There is no download available for the requested file
148 No file could be found for your request
149 Downloading files is not allowed
150 A search query is required for the request, which has not been provided
151 Specify at least one of the indicated fields as fields to get back
152 Too many results were found for your search. Enter a more accurate search term
153 There are too many possibilities found for the indicated word
154 There are too many possibilities found for the indicated search query
203 The indicated file group is not part of your handshake
204 Within the specified file group no matching folder could be found where the specified file is part of
205 Within the specified file group no matching folder could be found where the file is part of
206 Several possibilities were found where the unique ID could be assigned. Make sure that there is only one option when using a unique identifier
207 The specified amount is outside the allowed range
208 The specified file group is disabled and can not be used
209 All file groups are inactive
210 The specified file group is not linked to an installation
211 The attachment names are required for the request, which have not been provided
212 The indicated tag consists of more than 30 characters. The maximum length of a tag is 30 characters and cannot contain spaces
213 Too many handshake-requests have been sent in a short time. Limit the number of requests or optimize API-usage by using handshakes from success responses