About foxdox client API
Prerequisites
Notices on the support for API programming
Menü der Dokumentation
API methods
Retrieve general information from the interface
Retrieve API version
With this method the current version of the foxdox client API can be retrieved.
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | Version (String) Current version number |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/info/version HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: en
Answer
{
"Version": "1.x.x.x",
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve list of the supported countries
URL | ||||
|---|---|---|---|---|
Method | POST | |||
Parameter | none | |||
Return | Items (Array) List of country-elements
| |||
Status (Integer) see Status codes | ||||
StatusMsg (String) Localized description of the error | ||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/info/supportedcountries HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: en
Answer
{
"Items": [
{
"Code": "056",
"NameDe": "Belgien",
"NameEn": "Belgium"
},{
"Code": "100",
"NameDe": "Bulgarien",
"NameEn": "Bulgaria"
},{
"code": "208",
"NameDe": "Dänemark",
"NameEn": "Denmark"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}List of the supported file formats
URL | ||
|---|---|---|
Method | POST | |
Parameter | none | |
Return | Items (Array) List of format elements
| |
Status (Integer) see Status codes | ||
StatusMsg (String) Localized description of the error | ||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/info/supportedfileformats HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: en
Answer
{
"Items": [
{"Extension": ".txt"},
{"Extension": ".pdf"},
{"Extension": ".doc"},
{"Extension": ".docx"},
{"Extension": ".xls"},
{"Extension": ".xlsx"},
{"Extension": ".ppt"},
{"Extension": ".pptx"},
{"Extension": ".jpg"},
{"Extension": ".png"},
{"Extension": ".gif"},
{"Extension": ".tif"},
{"Extension": ".bmp"},
{"Extension": ".jpeg"}
],
"Status": 200,
"StatusMsg": "",
"Error":0
}List of the supported and forbidden file formats
Basically, files can be sent to foxdox in any formats . But there is a differentiation between supported, not supported and forbidden file formats. Forbidden file formats will be rejected. Supported file formats will be processed in the next step (PDF-conversion, OCR, etc.). Only for these documents full-text search, preview graphics or page graphics are possible. All other file formats will be accepted but not processed and thus are only available to download.
URL | ||
|---|---|---|
Method | POST | |
Parameter | none | |
Return | Supported (Array) List of supported file formats
| |
Forbidden (Array) List of forbidden file formats
| ||
Status (Integer) see Status codes | ||
StatusMsg (String) Localized description of the error | ||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/info/fileformats HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: en
Answer
{
"Supported": [
{"Extension": ".txt"},
{"Extension": ".pdf"},
{"Extension": ".doc"},
{"Extension": ".docx"},
{"Extension": ".xls"},
{"Extension": ".xlsx"},
{"Extension": ".ppt"},
{"Extension": ".pptx"},
{"Extension": ".jpg"},
{"Extension": ".png"},
],
"Forbidden": [
{"Extension": ".lnk"},
{"Extension": ".exe"}
],
"Status": 200,
"StatusMsg": "",
"Error":0
}Retrieve list of the supported languages
URL | |||||
|---|---|---|---|---|---|
Method | POST | ||||
Parameter | none | ||||
Return | Items (Array) List of language elements
| ||||
Status (Integer) see Status codes | |||||
StatusMsg (String) Localized description of the error | |||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/info/supportedlanguages HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: en
Answer
{
"Items":[
{
"Code":"de",
"NameDe":"Deutsch",
"NameEn":"German",
"NameNl":"Duitse"
},
{
"Code":"en",
"NameDe":"Englisch",
"NameEn":"English",
"NameNl":"Engels"
},
{
"Code":"nl",
"NameDe":"Niederländisch",
"NameEn":"Dutch",
"NameNl":"Nederlands"
}
],
"Status":200,
"StatusMsg":"",
"Error":0
}User
Register user account
URL | |
|---|---|
Method | POST |
Parameter | username (String) The desired user name. |
password (String) The password. | |
emailaddress (String) The e-mail address. | |
firstName (String, optional) The first name. | |
lastName (String, optional) The last name. | |
countryCode (String, optional) The numeric country code with preceding zeros, based on ISO 3166. S ee Country codes. | |
acceptTac (Boolean; optional) Flag, that the user accepts the foxdox Terms and Conditions of service. | |
title (Integer, optional) The title of the user (0 = Not specified, 1 = Ms, 2 = Mr, 3 = Company). | |
providerShortname (String, optional) The short name of the provider, in which context the account will be registered. | |
language (String, optional) The language code (de, en, etc). | |
Return | Status (Integer) See Status codes. |
StatusMsg (String) The localized description of the error. | |
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/user/register HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 176 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de username=m.mustermann&password=verysecurepw&emailAddress=m.mustermann%40contoso.de&firstName=Max&lastName=Mustermann&country=276&acceptTac=true&title=2&providerShortname=&language=en
Answer
{
"Status": 200,
"StatusMsg": "",
"Error":0
}Register user account (business account)
URL | |
|---|---|
Method | POST |
Parameter | username (String) The desired user name. |
password (String) The password. | |
emailaddress (String) The e-mail address. | |
firstName (String, optional) The first name | |
lastName (String, optional) The last name. | |
countryCode (String, optional) The numeric country code with preceding zeros, based on ISO 3166. See Country codes | |
acceptTac (Boolean; optional) Flag, that the user accepts the foxdox Terms and Conditions of Service. | |
title (Integer, optional) The title of the user (0 = Not specified, 1 = Ms, 2 = Mr, 3 = Company). | |
providerShortname (String, optional) The short name of the provider, in which context the account will be registered. | |
language (String, optional) The language code (de, en, etc). | |
Return | Status (Integer) See Status codes |
StatusMsg (String) The localized description of the error. | |
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/user/register HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 176 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de username=m.mustermann&password=verysecurepw&emailAddress=m.mustermann%40contoso.de&firstName=Max&lastName=Mustermann&country=276&acceptTac=true&title=2&providerShortname=&language=en
Answer
{
"Status": 200,
"StatusMsg": "",
"Error":0
}Confirm registration
URL | |
|---|---|
Method | POST |
Parameter | key (String)The activation key, was delivered by e-mail |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/confirmregister HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 13 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de key=abcdefg0123456
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Request activation key
URL | |
|---|---|
Method | POST |
Parameter | emailAddress (String) The e-mail address of the foxdox account. |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/sendactivation HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 38 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] emailaddress=m.mustermann%40contoso.de
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Amend registration information for provider-initial-account
URL | |
|---|---|
Method | POST |
Parameter | emailAddress (String) The e-mail address |
firstName (String, optional) First name | |
lastName (String, optional) Last name | |
userName (String, optional) Username | |
password (String, optional) Password | |
country (String, optional) Numeric country code with leading zeros based on ISO 3166. See country codes | |
language (String, optional) Language code (de, en, etc) | |
acceptTac (Boolean; optional) Flag, that the user accepts the Terms and Conditions of Service. The user needs to accept the Terms and Conditions of Service, else a registration is not possible. | |
acceptPP (Boolean, optional) Flag, that the user accepts the Privacy Policy. The user needs to accept the Privacy Policy, else a registration is not possible. | |
title (Integer, optional) The title of the user (0 = Not specified, 1 = Ms, 2 = Mr, 3 = Company) | |
keyName (String, optional) Name for a new personal key. If keyName and keyPassword are present, a personal key will be created. All existing keys will be deleted. | |
keyPassword (String, optional) Password for a new personal key. If keyName and keyPassword are present, a personal key will be created. All existing keys will be deleted. | |
keyHint (String, optional) Hint for the password of the new created personal key. | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/complete HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 117 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] emailaddress=m.mustermann%40contoso.de&firstname=Max&lastname=Mustermann&userName=m.mustermann&password=mmustermann&country=276&language=en&accepttac=true&acceptpp=true
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Login
If the password was entered incorrectly five times, the account will be blocked for five minutes. During this time a login with the correct password is not possible either.
URL | |
|---|---|
Method | POST |
Header | X-Brand-Host (String) Use this header to tell the API which brand you are using. This only takes place in requests for users with activated 2FA. |
Parameter | username (String) The user name or e-mail address. |
password (String) The password. | |
Return | Token (String) The authentication token. This value must be transmitted in the HTTP-header X-TOKEN. |
Ttl (Integer) The validity period for the token in seconds. | |
SID (String) The SID of the currently logged in user. | |
UserName (String) The user name of the currently logged in d.3 user. | |
Status (Integer) See Status codes. | |
StatusMsg (String) Localized description of the error. | |
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/auth/requesttoken HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 37 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-Brand-Host: postbox.foxdox.de X-APPVER: 0.1 X-LANG: de username=m.mustermann&password=foxdox
Answer
{
"Token": "[...]",
"Ttl": 86400,
"SID": "U-dab9df31-edd5-471c-a662-f3099228ca99",
"UserName": "m.mustermann",
"Status": 200,
"StatusMsg": "",
"Error": 0
} Logout
URL | |
|---|---|
Method | POST |
Parameter | None |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/auth/deletetoken HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...]
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Keep login alive
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/auth/keepalive HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...]
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
} Find user
URL | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||||
Parameter | search (String) The keyword | ||||||||||||||||||
Return | Items (Array) List of search results
| ||||||||||||||||||
Status (Integer) see Status codes | |||||||||||||||||||
StatusMsg (String) Localized description of the error | |||||||||||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/find HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 13 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] search=foxdox
Answer
{
"Items": [
{
"UserName": "foxdox_demo2",
"IsTrusted": false,
"EmailAddress": "foxdox_demo2@contoso.de",
"Telephone": "",
"CellPhone": "",
"CompanyName": "Contoso",
"FirstName": "Fritz",
"LastName": "Fuchs",
"Address": "",
"ZipCode": "",
"City": "Sample city",
"Province": "",
"Country": "",
"Birthday":"",
"About": "",
"ContactStatus": 0,
"SID": ""
}
],
"Status": 200,
"StatusMsg": "",
"Error":0
}Retrieve own profile
URL | ||
|---|---|---|
Method | POST | |
Parameter | none | |
Return | DateCreated (String) Date and time, when the user account was created | |
IsTrusted (boolean) Flag, if the identity of the user is confirmed. | ||
Address (String) Street house number, etc. | ||
City (String) City | ||
CompanyName (String) Company | ||
Country (String) Country/Region | ||
EmailAddress (String) E-mail address | ||
FirstName (String) First name | ||
LastName (String) Last name | ||
Province (String) State/Region etc. | ||
ZipCode (String) Zip/Postal Code | ||
UserName (String) User name | ||
Documents (Long) Total number of documents | ||
Folders (Long) Total number of folders | ||
RootFolderId (String) ID of the root folder | ||
About (String) A short descriptive text of the person. | ||
Birthday (String) Date of birth | ||
Telephone (String) Phone number | ||
CellPhone (String) Telephone number of the mobile phone | ||
SID (String) The own SID | ||
Title (Integer) The title of the user (0 = Not specified, 1 = Ms, 2 = Mr, 3 = Company) | ||
Language (String) Language code of the configured language (de, en, etc) | ||
AuthMethods (Array) List of activated login methods
| ||
IsShowWelcomeTour (boolean) Flag, if user should see a welcome tour on next login | ||
Status (Integer) see Status codes | ||
StatusMsg (String) Localized description of the error | ||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/details HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...]
Answer
{
"DateCreated": "Tue, 10 Feb 2014 12:53:39 GMT",
"UserName": "m.mustermann",
"EmailAddress": "m.mustermann@contoso.de",
"Title": 2,
"CompanyName": "contoso GmbH",
"FirstName": "Max",
"LastName": "Mustermann",
"Address": "Sample street no. 1",
"ZipCode": "12345",
"City": "Sample city",
"Province": "",
"Country": "276",
"Folders": 11,
"Documents": 81,
"IsTrusted": false,
"RootFolderId": "c43541e1-a36b-4b4e-8f88-bfcae19d6f1e",
"About":"foxdox mcht Spaß",
"Birthday": "Mon, 09 Jan 1980 00:00:00 GMT",
"Telephone": "",
"CellPhone": "",
"SID": "U-c2805196-fe7b-4d00-8ea1-ba753e64be11",
"AuthMethods": [ [
{
"Name": "foxdox",
"Status": 1
}
],
"IsShowWelcomeTour": false,
"Language": "de",
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve security settings
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | emailaddress (Integer) 0 = invisible for all 1 = visible for own contacts 2 = visible for all |
telephone (Integer) Phone number | |
CellPhone (Integer) Telephone number mobile | |
companyname (Integer) Company | |
firstname (Integer) First name | |
lastname (Integer) Last name | |
address (Integer) Address | |
zipcode (Integer) Zip/Postal Code | |
city (Integer) City | |
province (Integer) State/Region | |
country (Integer) Country | |
birthday (Integer) Date of birth | |
title (Integer) Title | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/listvisibility HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...]
Answer
{
"EmailAddress": 1,
"Telephone": 0,
"CellPhone": 1,
"CompanyName": 1,
"Title": 2,
"FirstName": 2,
"LastName": 2,
"Address": 1,
"ZipCode": 1,
"City": 1,
"Province": 1,
"Country": 2,
"Birthday": 1,
"Status": 200,
"StatusMsg": "",
"Error":0
}Change name
URL | |
|---|---|
Method | POST |
Parameter | firstName (String) First name |
lastName (String) Last name | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changename HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 33 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] firstname=Max&lastname=Mustermann
Answer
{
"Status": 200,
"StatusMsg": "",
"Error":0
}Change telephone numbers
URL | |
|---|---|
Method | POST |
Parameter | telephone (String) The phone number |
cellphone (String) Telephone number of the mobile phone | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changecontact HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 58 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] telephone=%2B49+1234+56789-11&cellphone=%2B49+123+88994578
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change the company
URL | |
|---|---|
Method | POST |
Parameter | companyName (String) Company name |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changecompany HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 24 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] companyname=Contoso+GmbH
Answer
{
"Status": 200,
"StatusMsg": "",
"Error":0
} Change address
URL | |
|---|---|
Method | POST |
Parameter | address (String) Street with house number |
ZipCode (String) Zip/Postal Code | |
city (String) City | |
province (String) State/Region etc. | |
country (String) Country | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changeaddress HTTP/1.1 Host: api.foxdox-staging.de Connection: keep-alive Content-Length: 83 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] address=Musterstra%C3%9Fe+5&zipcode=12345&city=Musterstadt&province=NRW&country=276
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change the date of birth
URL | |
|---|---|
Method | POST |
Parameter | birthday (String) Date of birth |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changebirthday HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 47 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] birthday=Wed%2C+09+Jan+1980%2C+00%3A00%3A00+GMT
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change personal descriptive text
URL | |
|---|---|
Method | POST |
Parameter | about (String) Personal descriptive text |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changeabout HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 63 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] about=I+am+Max.+And+I+save+my+documents+in+foxdox!
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change visibility settings
URL | |
|---|---|
Method | POST |
Parameter | item (String)Setting to be changed (emailaddress, telephone, cellphone, companyname, firstname, lastname, address, zipcode, city, province, countrybirthday, title) |
visibility (Integer) 1 = visible for own contacts 2 = visible for all | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changevisibility HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 30 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] item=emailaddress&visibility=2
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve user profile
URL | |
|---|---|
Method | POST |
Parameter |
|
Return | IsTrusted (boolean) Flag, if the identity of the user is confirmed. |
Address (String) Street house number, etc. | |
CellPhone (String) The telephone number of the mobile phone. | |
City (String) City | |
CompanyName (String) Company | |
Country (String) Country/Region | |
EmailAddress (String) E-mail address | |
FirstName (String) First name | |
LastName (String) Last name | |
Province (String) State/Region etc. | |
Telephone (String) The phone number | |
ZipCode (String) Zip/Postal Code | |
UserName (String) User name | |
About (String) A short descriptive text of the person. | |
Birthday (String) Date of birth | |
ContactStatus (Integer) The contact status of the found user: 0 = No contact, no open request, 1 = Contact confirmed, 2 = Waiting for confirmation, 3 = found user is waiting for confirmation | |
Title (Integer) The title of the user (0 = Not specified, 1 = Ms, 2 = Mr, 3 = Company) | |
SID (String) SID of the user | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
POST https://api.foxdox.de/user/profile HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 20 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] username=m.mustermann
Answer
{
"UserName": "m.mustermann",
"Title": 2,
"IsTrusted": false,
"EmailAddress":"m.mustermann@contoso.de",
"Telephone": "+49 1234 56789-11",
"CellPhone": "+49 123 88994578",
"CompanyName": "Contoso GmbH",
"FirstName": "Max",
"LastName": "Mustermann",
"Address": "Sample street no. 5",
"ZipCode": "12345",
"City": "Sample city",
"Province": "Sample state",
"Country": "276",
"Birthday": "Wed, 09 Jan 1980 00:00:00 GMT",
"About":"I am Max. And I save my documents in foxdox!",
"ContactStatus": 2,
"SID": "U-9798d789-253f-4817-89ea-c98b4cc36127",
"Status" :200,
"StatusMsg": "",
"Error": 0
}Change password
URL | |
|---|---|
Method | POST |
Parameter | oldPassword (String) The old password. |
newPassword (String) The new password. The password must have a minimum length of eight characters and has to meet current safety standards. | |
Return | Status (Integer) See Status codes. |
StatusMsg (String) The localized description of the error. | |
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/user/changepassword HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 53 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] oldpassword=aabbccddeeffgg&newpassword=abcdefg0123456
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Reset password
URL | |
|---|---|
Method | POST |
Parameter | emailAddress (String) The e-mail address to which the token for resetting the password is to be sent. |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/resetpassword HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 28 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] emailaddress=m.mustermann%40contoso.de
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Confirm password reset
URL | |
|---|---|
Method | POST |
Parameter | requestId (String) The token created while reset request. |
newPassword (String) The new password. | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/confirmresetpassword HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 46 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] requestid=123456789&newpassword=abcdefg0123456
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Delete user account
URL | |
|---|---|
Method | POST |
Parameter | username (String) User name |
password (String) Password | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/deleteaccount HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] username=m.mustermann&password=abcdefg0123456
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Confirm deletion of user account
URL | |
|---|---|
Method | POST |
Parameter | requestId (String) The token created while delete request. |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/confirmdeleteaccount HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 19 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] requestid=123456789
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve storage information
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | DiskSpace (Long) Guaranteed disk space in bytes, 0 if unlimited |
UsedDiskSpace (Long) Used disk space by documents in bytes | |
DocumentCount (Long) Number of all documents | |
FolderCount (Long) Number of all folders | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/storageinfo HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"DiskSpace": 26843545600,
"UsedDiskSpace": 24559346,
"DocumentCount": 96,
"FolderCount": 11,
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve feature information
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | FeatureSets (Array) List of all FeatureSet elements |
Name (String) Name of the set | |
Description (String) Description of the set | |
IsMainFeatureSet (Boolean) Flag, if the FeatureSet is the MainFeatureSet, which returns the actual tariff. Only one FeatureSet can be the MainFeatureSet. | |
Features (Array) List of all FeatureSet elements of a FeatureSet | |
ID (String) Unique feature-ID (see feature-ID) | |
Name (String) Name of the function | |
Description (String) Description | |
IsUnlimited (Boolean) Flag, if the function can be used unlimited. | |
Quantity (Decimal) Quantity of the usage units, if not unlimited. | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/featureinfo HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"FeatureSets": [
{
"Id": "19866cc1-b8af-45e8-9070-dadcd5c9a834",
"Name": "FOXDOX - Premium - 1 Year",
"Description": "The limitless FOXDOX experience",
"IsMainFeatureSet": true
}
],
"Features": [
{
"Id": "7b21b97c-304b-42a0-b3d4-3f90afdf716f",
"Name": "Disk space",
"Description": "Disk space for documents",
"IsUnlimited": false,
"Quantity": 26843545600
}, {
"Id": "0cd38741-439b-4e8d-883f-98c1e64eed7d",
"Name": "Advanced document classification",
"Description": "Advanced document classification with own rules",
"IsUnlimited": true,
"Quantity": 0
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change user name
URL | |
|---|---|
Method | POST |
Parameter | username (String) User name |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changeusername HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 26 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] username=newusername
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change e-mail address
URL | |
|---|---|
Method | POST |
Parameter | emailAddress (String) The new e-mail address |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changeemail HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 38 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] emailaddress=m.mustermann%40contoso.de
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Confirm e-mail address
URL | |
|---|---|
Method | POST |
Parameter | requestId (String) Confirmation code |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/confirmchangeemail HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 17 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] requestid=abcdefg
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve history of changes
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | LastChangeDocs (String) Date and time of last change to a document |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/changehistory HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"LastChangeDocs": "Tue, 17 Nov 2015 10:02:26 GMT",
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change push settings
URL | |
|---|---|
Method | POST |
Parameter | deviceType (Integer) 1 = iOS, 2 = Android (GCM) deprecated 3 = Android (FCM) |
pushId (String) device-specific pushId | |
enablePush (Boolean) Flag, if the push for a certain device shall be enabled or disabled. | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/updatepushsettings HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] devicetype=1&pushid=[...]&enablepush=True
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
} Retrieve notification settings
URL | ||||
|---|---|---|---|---|
Method | POST | |||
Parameter | none | |||
Return | Items (Array) List of all notification elements
| |||
Status (Integer) see Status codes | ||||
StatusMsg (String) Localized description of the error | ||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/listnotificationsettings HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [
{
"EventId": 196611,
"ChannelId": 1,
"SendNotification": true
}, {
"EventId": 196611,
"ChannelId": 2,
"SendNotification": true
},{
"EventId": 196611,
"ChannelId": 3,
"SendNotification": true
},{
"EventId": 196609,
"ChannelId": 1,
"SendNotification": true
},{
"EventId": 196609,
"ChannelId": 2,
"SendNotification": true
},{
"EventId": 196609,
"ChannelId": 3,
"SendNotification": true
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change notification settings
URL | |
|---|---|
Method | POST |
Parameter | eventId (Integer) See Event-ID |
ChannelId (Integer) Channel-ID 1 = System message, 2 = e-mail, 3 = Push | |
SendNotification (Boolean) Flag, if notifications for this event shall be sent on this channel. | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/updatenotificationsettings HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 48 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] eventid=196611&channelId=1&sendNotification=true
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
} Change notification settings (Bulk)
URL | |
|---|---|
Method | POST |
Parameter | NotificationSettings (JSON-object) Example:
|
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/updatenotificationsettingsbulk HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 311 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] notificationSettings=%7B%22Settings%22%3A+%5B%7B%22EventId%22%3A65538%2C+%22ChannelId%22%3A1%2C+%22SendNotification%22%3Afalse%7D%2C+%7B%22EventId%22%3A65539%2C+%22ChannelId%22%3A1%2C+%22SendNotification%22%3Afalse%7D%2C+%7B%22EventId%22%3A65537%2C+%22ChannelId%22%3A1%2C+%22SendNotification%22%3Afalse%7D%5D%7D
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change language settings
URL | |
|---|---|
Method | POST |
Parameter | LanguageCode (String) Language code (de, en, etc) If an invalid language code is passed, then the default value is used (currently "de") |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/updatelanguage HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 15 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] languagecode=de
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change show welcome tour
URL | |
|---|---|
Method | POST |
Parameter | show (boolean) show or don't show welcome tour |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/user/updateshowwelcometour HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 24 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-APPVER: 0.1 X-LANG: de X-TOKEN: [...] show=true
Answer
{
"Status": 200,
"StatusMsg": "",
"Error":0
} Contacts
Send contact request
URL | |
|---|---|
Method | POST |
Parameter | UserName (String) The user name of the contact to be added. |
Message (String, optional) An optional message, which will be sent together with the contact request. | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/requestcontact HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 83 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] username=m.mustermann&message=Hello+Max!+Please+confirm+my+contact request.
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve contact list
URL | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||||||
Parameter | SID (String, optional) An optional contact- or group-SID. If a contact-SID is passed, then only the respective contact will be returned. If a group-SID is passed, then all contacts of the respective group will be returned. | ||||||||||||||||||||
Return | Items (Array) List of all contact elements
| ||||||||||||||||||||
Status (Integer) see Status codes | |||||||||||||||||||||
StatusMsg (String) Localized description of the error | |||||||||||||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/listcontacts HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1
Answer
{
"Items: [
{
"UserName": "m.mustermann",
"IsTrusted": false,
"EmailAddress": "m.mustermann@contoso.de",
"Telephone": "",
"CellPhone": "",
"CompanyName": "Contoso",
"Title": 0,
"FirstName": "Max",
"LastName": "Mustermann",
"Address": "Sample street no. 1",
"ZipCode": "12345",
"City": "Sample city",
"Province": "",
"Country": "276",
"Birthday": "Mon, 09 Jan 1980 13:37:00 GMT",
"About": "",
"SharesDocsWithMe": false,
"SharingDocsWithContact": true,
"SID": "U-0ece8b01-567e-4253-bc3d-957b7aeb09c6",
"GroupCount": 0
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve the number of pending, received contact requests
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | ContactRequests (Integer) Number of pending contact requests |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/requestcount HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-TOKEN: [...] X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1
Answer
{
"ContactRequests": 0,
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve the number of pending, sent contact requests
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | PendingContactRequests (Integer) Number of pending contact requests |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/pendingrequestcount HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-TOKEN: [...] X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1
Answer
{
"PendingContactRequests": 0,
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve the list of pending, sent contact requests
URL | ||||||||
|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||
Parameter | none | |||||||
Return | Items (Array) List of pending contact requests
| |||||||
Status (Integer) see Status codes | ||||||||
StatusMsg (String) Localized description of the error | ||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/listpendingrequests HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-TOKEN: [...] X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1
Answer
{
"Items": [
{
"Id": "8e5e2ec2-a1de-4029-bd9e-a560549de481",
"Created": "Sun, 22 Nov 2015 10:06:31 GMT",
"UserName": "m.mustermann",
"Title": 2,
"FirstName": "Max",
"LastName": "Mustermann",
"Message": "Hello Max!"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Delete the number of pending, sent contact requests
URL | |
|---|---|
Method | POST |
Parameter | requestId (String) ID of the contact request |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/removerequest HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 46 X-TOKEN: [...] X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 requestId=bf788557-44c0-47b4-81fa-d8ab5410768d
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Confirm contact request
URL | |
|---|---|
Method | POST |
Parameter | requestId (String) ID of the contact request |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/confirmrequest HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 46 X-TOKEN: [...] X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 requestId=bf788557-44c0-47b4-81fa-d8ab5410768d
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Reject contact request
URL | |
|---|---|
Method | POST |
Parameter | requestId (String) ID of the contact request |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/rejectrequest HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 46 X-TOKEN: [...] X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 requestId=bf788557-44c0-47b4-81fa-d8ab5410768d
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Delete contact
Warnung
This method is outdated and will not be provided in future versions.
Instead please use Delete contact with SID.
URL | |
|---|---|
Method | POST |
Parameter | UserName (String) The user name of the contact to be removed. |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/remove HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 21 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 username=m.mustermann
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Delete contact with SID
URL | |
|---|---|
Method | POST |
Parameter | SID (String) The SID of the contact to be removed. |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/removesid HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 42 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 sid=U-9d7eacd9-cc33-43bc-beb8-3d88a9557c66
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Invite user
URL | |
|---|---|
Method | POST |
Parameter | name (String) Name of the recipient |
e-mail (String) The e-mail address of the recipient. | |
message (String, optional) An optional message, which will be sent together with the invitation. | |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/invite HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 144 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 name=John+Doe&email=j.doe%40contoso.com&message=Hello+John!+Register+at+foxdox.+There+I+can+share+our+project+files+with+you.
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Confirm invitation
URL | |
|---|---|
Method | POST |
Parameter | confirmCode (String) Confirmation code |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/confirminvitation HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 19 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 confirmcode=abcdefg
Answer
{
"Status": 400,
"StatusMsg": "",
"Error": 201103
}Retrieve only released documents
Anmerkung
This method is outdated and will not be provided in future versions.
Please use Retrieve released documents with SID instead.
URL | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||
Parameter | UserName (String) The user name of the contact whose released documents are to be retrieved. | |||||||||||||||||||||||||||||||
folderId (String, optional) Optional, returns only the documents of the specified folder. | ||||||||||||||||||||||||||||||||
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | ||||||||||||||||||||||||||||||||
Return | Items (Array)
| |||||||||||||||||||||||||||||||
Status (Integer) See Status codes. | ||||||||||||||||||||||||||||||||
StatusMsg (String) The localized description of the error. | ||||||||||||||||||||||||||||||||
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/contact/listdocuments HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 21 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 username=m.mustermann
Answer
{
"Items": [
{
"CanRead": true,
"CanReadWrite": false,
"Created": "Tue, 17 Nov 2015 08:01:46 GMT",
"Id": "370ea063-a839-4e5a-866b-f1bb3779d610",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": false,
"IsProcessed": true,
"IsPublic": false,
"IsShared": true,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "text/plain",
"Name": "hallowelt.txt",
"OriginalName": "hallowelt.txt",
"ParentFolderId": "00000000-0000-0000-0000-000000000000",
"FolderId": "00000000-0000-0000-0000-000000000000",
"FolderName": "",
"FolderPath": "",
"Size": 10,
"Version": 0,
"IsOwnDocument": false,
"DocumentOwner": "m.mustermann",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Tue, 17 Nov 2015 08:01:46 GMT",
"PhysicalFileChanged":"Tue, 17 Nov 2015 08:01:46 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
},
{
"CanRead": true,
"CanReadWrite": false,
"Created": "Mon, 27 Jul 2015 13:44:17 GMT",
"Id": "f004e235-f34d-4755-bf08-01c51869fd44",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": true,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "application/pdf",
"Name": "Inhalt.pdf",
"OriginalName": "Inhalt.pdf",
"ParentFolderId": "00000000-0000-0000-0000-000000000000",
"FolderId": "00000000-0000-0000-0000-000000000000",
"FolderName": "",
"FolderPath": "",
"Size": 89151,
"Version": 0,
"IsOwnDocument": false,
"DocumentOwner": "m.mustermann",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Wed, 02 Sep 2015 19:36:40 GMT",
"PhysicalFileChanged": "Mon, 27 Jul 2015 13:46:08 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve released documents with SID
URL | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||
Parameter | SID (String) The SID of the contact whose released documents are to be retrieved. | |||||||||||||||||||||||||||||||
folderId (String, optional) Optional, returns only the documents of the specified folder. | ||||||||||||||||||||||||||||||||
rootDocumentsOnly (Boolean, optional) Optional, returns only the documents which were directly shared with the current user. Only active if folderId is empty guid or missing. | ||||||||||||||||||||||||||||||||
providerRootFolderName (String, optional) Optional, Display name of the "Meine Provider" folder By default, this folder is always named "Meine Provider". | ||||||||||||||||||||||||||||||||
Return | Items (Array)
| |||||||||||||||||||||||||||||||
Status (Integer) see Status codes | ||||||||||||||||||||||||||||||||
StatusMsg (String) Localized description of the error | ||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/listdocumentssid HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 42 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 sid=U-22418a6e-e700-48f2-b372-5bc8d59b88c4
Answer
{
"Items": [
{
"CanRead": true,
"CanReadWrite": false,
"Created": "Tue, 17 Nov 2015 08:01:46 GMT",
"Id": "370ea063-a839-4e5a-866b-f1bb3779d610",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": false,
"IsProcessed": true,
"IsPublic": false,
"IsShared": true,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "text/plain",
"Name": "hallowelt.txt",
"OriginalName": "hallowelt.txt",
"ParentFolderId": "00000000-0000-0000-0000-000000000000",
"FolderId": "00000000-0000-0000-0000-000000000000",
"FolderName": "",
"FolderPath": "",
"Size": 10,
"Version": 0,
"IsOwnDocument": false,
"DocumentOwner": "m.mustermann",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Tue, 17 Nov 2015 08:01:46 GMT",
"PhysicalFileChanged":"Tue, 17 Nov 2015 08:01:46 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
},
{
"CanRead": true,
"CanReadWrite": false,
"Created": "Mon, 27 Jul 2015 13:44:17 GMT",
"Id": "f004e235-f34d-4755-bf08-01c51869fd44",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": true,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "application/pdf",
"Name": "Inhalt.pdf",
"OriginalName": "Inhalt.pdf",
"ParentFolderId": "00000000-0000-0000-0000-000000000000",
"FolderId": "00000000-0000-0000-0000-000000000000",
"FolderName": "",
"FolderPath": "",
"Size": 89151,
"Version": 0,
"IsOwnDocument": false,
"DocumentOwner": "m.mustermann",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Wed, 02 Sep 2015 19:36:40 GMT",
"PhysicalFileChanged": "Mon, 27 Jul 2015 13:46:08 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Create contact group
URL | |
|---|---|
Method | POST |
Parameter | groupName (String) The name of the contact group. |
Return | Created (String) Date and time, when the group was created. |
ID (String) ID of the group | |
Name (String) Name of the contact group | |
SID (String) SID of the group | |
Status (Integer) See Status codes | |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/creategroup HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 23 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupname=Projektgruppe
Answer
{
"Created": "Fri, 04 Dec 2015 08:55:09 GMT",
"Name": "Project group",
"Id": "8d98721c-224f-4afd-af99-04d16d67bb67",
"SID": "G-8d98721c-224f-4afd-af99-04d16d67bb67",
"Status": 200,
"StatusMsg": "",
"Error": 0
}Rename contact group
URL | |
|---|---|
Method | POST |
Parameter | groupID (String) The SID of the group |
groupName (String) The new name of the contact group. | |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/renamegroup HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 70 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupid=8d98721c-224f-4afd-af99-04d16d67bb67&groupname=Projektgruppe+A
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Delete contact group
URL | |
|---|---|
Method | POST |
Parameter | groupID (String) The SID of the group |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/deletegroup HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 44 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupid=8d98721c-224f-4afd-af99-04d16d67bb67
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}List contact groups
URL | |||||||
|---|---|---|---|---|---|---|---|
Method | POST | ||||||
Parameter | SID (String, optional) An optional contact- or group-SID. If a contact-SID is passed, then only the groups of the contact will be returned. If a group-SID is passed, then only the respective group will be returned. | ||||||
Return | Items (Array) List of all contact groups elements
| ||||||
Status (Integer) See Status codes | |||||||
StatusMsg (String) Details on the status code | |||||||
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/listgroups HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1
Answer
{
"Items": [
{
"Created": "Tue, 16 Jun 2015 13:21:47 GMT",
"Name": "Project group A",
"Id": "7345364a-3ff0-43f5-8efe-16b1a6b613c5",
"SID": "G-7345364a-3ff0-43f5-8efe-16b1a6b613c5",
"ContactCount": 5,
"SharingDocsWithGroup": true
},
{
"Created": "Fri, 04 Dec 2015 08:11:27 GMT",
"Name": "Project group B",
"Id": "45462d09-6a9c-44ad-b050-f53753a70656",
"SID": "G-45462d09-6a9c-44ad-b050-f53753a70656",
"ContactCount": 3,
"SharingDocsWithGroup": false
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}List all groups of a contact
Warnung
This method is outdated and will not be provided in future versions.
Instead please use List contact groups.
URL | |||||||
|---|---|---|---|---|---|---|---|
Method | POST | ||||||
Parameter | ContactSID (String) SID of the contact | ||||||
Return | Items (Array) List with all contact groups elements
| ||||||
Status (Integer) See Status codes | |||||||
StatusMsg (String) Details on the status code | |||||||
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/listcontactgroups HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 49 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 contactsid=U-22418a6e-e700-48f2-b372-5bc8d59b88c4
Answer
{
"Items": [
{
"Created": "Tue, 16 Jun 2015 13:21:47 GMT",
"Name": "Project group A",
"Id": "7345364a-3ff0-43f5-8efe-16b1a6b613c5",
"SID": "G-7345364a-3ff0-43f5-8efe-16b1a6b613c5",
"ContactCount": 5,
"SharingDocsWithGroup": true
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}List contacts of a group
URL | |||
|---|---|---|---|
Method | POST | ||
Parameter | groupID (String) The SID of the group | ||
Return | Items (Array) List of all contact elements
| ||
Status (Integer) See Status codes | |||
StatusMsg (String) Details on the status code | |||
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/listgroupmember HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 44 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupid=45462d09-6a9c-44ad-b050-f53753a70656
Answer
{
"Items": [
{
"UserName": "m.mustermann",
"SID": "U-c6448d9b-503a-493e-8fc9-af6fe6cde6d7"
},
{
"UserName": "franz.fuchs",
"SID": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Add contact to a group
URL | |
|---|---|
Method | POST |
Parameter | groupId (String) The ID of the group |
userName (String) User name of the contact | |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/addtogroup HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 66 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupid=45462d09-6a9c-44ad-b050-f53753a70656&username=m.mustermann
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Add contact to a group with SID
URL | |
|---|---|
Method | POST |
Parameter | groupID (String) The SID of the group |
ContactSID (String) SID of the contact | |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/addtogroup HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 94 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupid=45462d09-6a9c-44ad-b050-f53753a70656&contactsid=U-9bee8b7c-3d5f-4b11-9ad3-67f393dcb36a
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Remove contact from group
URL | |
|---|---|
Method | POST |
Parameter | groupID (String) The SID of the group |
UserName (String) User name of the contact | |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/removefromgroup HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 66 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupid=45462d09-6a9c-44ad-b050-f53753a70656&username=m.mustermann
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Remove contact from group with SID
URL | |
|---|---|
Method | POST |
Parameter | groupID (String) The SID of the group |
ContactSID (String) SID of the contact | |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/removesidfromgroupHTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 94 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupid=45462d09-6a9c-44ad-b050-f53753a70656&contactsid=U-9bee8b7c-3d5f-4b11-9ad3-67f393dcb36a
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Update all contacts of a group
This method removes all members of a group and adds the specified members.
URL | |
|---|---|
Method | POST |
Parameter | groupID (String) The SID of the group |
Contacts (String) JSON-formatted list of the contact-SID's { contacts: ["SID1", "SID2", "SID3", "SIDn"] } | |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/updategroupmember HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 172 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 groupId=45462d09-6a9c-44ad-b050-f53753a70656&contacts=%7B+contacts%3A+%5B%22U-9bee8b7c-3d5f-4b11-9ad3-67f393dcb36a%22%2C+%22U-6e2eec77-1ee1-444c-b256-f6c985b33dba%22%5D+%7D
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve the number of sent invitations
URL | ||||||
|---|---|---|---|---|---|---|
Method | POST | |||||
Parameter | none | |||||
Return | Items (Array) List of sent invitations
| |||||
Status (Integer) see Status codes | ||||||
StatusMsg (String) Localized description of the error | ||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/contact/listinvitations HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Type: application/x-www-form-urlencoded Content-Length: 0 X-LANG: de X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-APPVER: 0.1
Answer
{
"Items": [{
"Id": "9c2d2bf7-f774-4efb-b7f7-faf0da975194",
"Created": "Wed, 16 Dec 2015 07:53:20 GMT",
"RecipientMailAddress": "max.mustermann@googlemail.com",
"RecipientName": "Max Mustermann",
"Message": "Hey, did you try this?"
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Delete sent invitation
URL | |
|---|---|
Method | POST |
Parameter | invitationId (String) ID of the invitation |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/removeinvitation HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 44 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 invitationId=04395d12-86f8-4364-a92b-c2b1b174c2de
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Re-send invitation
URL | |
|---|---|
Method | POST |
Parameter | invitationId (String) ID of the invitation |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/resendinvitation HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 44 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 invitationId=04395d12-86f8-4364-a92b-c2b1b174c2de
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Re-send pending, sent contact requests
URL | |
|---|---|
Method | POST |
Parameter | requestId (String) The ID of the contact request |
Return | Status (Integer) See Status codes |
StatusMsg (String) Details on the status code | |
Error (Integer) See Error codes |
Request
POST https://api.foxdox.de/contact/resendrequest HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 44 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-TOKEN: [...] X-LANG: de X-APPVER: 0.1 requestId=04395d12-86f8-4364-a92b-c2b1b174c2de
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Folder
Retrieve root folder
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | Created (String) Date and time, when the folder was created |
Modified (String) Date and time, when the folder was modified recently | |
Name (String) The name of the root folder (is always "Root"). | |
ID (String) The ID of the folder | |
IsShared (Boolean) Flag, if this folder is released. | |
IsAuditProof (Boolean) Flag, if this folder has audit-proof presettings | |
AuditProofUntil (String) Date until documents in this folder shall be stored audit-proof. The value must be a valid date and must not be in the past. An empty value will reset previously made settings. | |
DocumentCount (Long) Number of documents within this folder. | |
FolderCount (Long) Number of subfolders within this folder. | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/rootfolder HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Root",
"Id": "806584d4-3d23-4787-9d86-32c94498458a",
"IsShared": false,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve folder content - subfolder
URL | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||
Parameter | folderId (String, optional) The ID of the respective folder. If no ID is specified, then the content of the root folder is displayed. | ||||||||||||
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | |||||||||||||
Return | Items (JSON-Map) List of all subfolder elements
| ||||||||||||
Status (Integer) See Status codes. | |||||||||||||
StatusMsg (String) Localized description of the error. | |||||||||||||
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/folder/listfolders HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=f3219150-b6d6-4bee-bc6b-3f54ffb83b65
Answer
{
"Items": [
{
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Fotos",
"Id": "6d62353e-374a-46e0-a7c5-15241e911868",
"ParentFolderId": "f3219150-b6d6-4bee-bc6b-3f54ffb83b65",
"DefaultDocTypeId": "d02d7f8a-7c6e-47a8-980a-ad46e6c1933d",
"IsFav": false,
"IsShared": false,
"Path": "Fotos"
},
{
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Job",
"Id": "1894ed32-ef57-4452-80ee-e2e51d315362",
"ParentFolderId": "f3219150-b6d6-4bee-bc6b-3f54ffb83b65",
"DefaultDocTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"IsFav": false,
"IsShared": false,
"Path": "Job"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve folder content - documents
URL | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||||||||||||||||
Parameter | folderId (String, optional) The ID of the respective folder. If no ID is specified, then the content of the root folder is displayed. | ||||||||||||||||||||||||||||||
providerRootFolderName (String, optional) Optional, display name of the Meine Provider folder By default, this folder is always named Meine Provider. | |||||||||||||||||||||||||||||||
Return | Items (JSON-Map) List of all document elements
| ||||||||||||||||||||||||||||||
Status (Integer) See Status codes. | |||||||||||||||||||||||||||||||
StatusMsg (String) The localized description of the error. | |||||||||||||||||||||||||||||||
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/folder/listdocuments HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=f3219150-b6d6-4bee-bc6b-3f54ffb83b65
Answer
{
"Items": [
{
"CanRead": true,
"CanReadWrite": true,
"Created": "Thu, 17 Dec 2015 13:21:19 GMT",
"Id": "dcfbc8fc-3542-4f6b-8436-9de72c26c0b7",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "text/plain",
"Name": "Pangramm.txt",
"OriginalName": "Pangramm.txt",
"ParentFolderId": "b7acd398-b584-415f-84c1-2593328c9500",
"FolderId": "b7acd398-b584-415f-84c1-2593328c9500",
"FolderName": "Correspondence",
"FolderPath": "Correspondence",
"Size": 21681,
"version": 0,
"IsOwnDocument": true,
"DocumentOwner": "foxdox",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b6704a3c-2cb4-4fd5-9c0f-b9ba0025f3eb",
"DocumentTypeName": "Correspondence",
"Modified": "Thu, 17 Dec 2015 13:21:19 GMT",
"PhysicalFileChanged": "Thu, 17 Dec 2015 13:21:19 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve folder structure
URL | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||
Parameter | rootFolderName (String) Display name of the root folder. By default, the root folder is always named Root. A path with this name would look like this: Root\Invoices\Outgoing invoices. Some applications do not accept this display name. With this parameter you can change the display name of the root folder within the path. For example: My documents\Invoices\Outgoing invoices. | |||||||||||||
flat (Boolean) True = The folder structure will be returned flat, False = The folder structure will be returned in a nested hierarchy. | ||||||||||||||
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | ||||||||||||||
Return | Items (String) List of all folder elements
| |||||||||||||
Status (Integer) See Status codes. | ||||||||||||||
StatusMsg (String) The localized description of the error. | ||||||||||||||
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/folder/rootfolder HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 38 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] rootFolderName=My+Documents&flat=false
Answer
{
"Items": [
{
"Items": [
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Fotos",
"Id": "6d62353e-374a-46e0-a7c5-15241e911868",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Fotos",
"DefaultDocTypeId": "d02d7f8a-7c6e-47a8-980a-ad46e6c1933d",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Job",
"Id": "1894ed32-ef57-4452-80ee-e2e51d315362",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Job",
"DefaultDocTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"IsFav": false,
"IsShared": false
},
{
"Items": [
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Receipt",
"Id": "ce522758-3245-4b89-973e-8039671300f6",
"ParentFolderId": "13f01266-3cdd-473e-bed1-2851d8303141",
"Path": "My Documents/Invoices/Receipts",
"DefaultDocTypeId": "52168b02-f43d-4921-b792-0b17ce24918d",
"IsFav": false,
"IsShared": false
}
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Wed, 27 May 2015 12:38:19 GMT",
"Name": "Invoices",
"Id": "13f01266-3cdd-473e-bed1-2851d8303141",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Invoices/Receipts",
"DefaultDocTypeId": "2822007a-9188-41bb-a8b6-09b89211e9a8",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Correspondence",
"Id": "b7acd398-b584-415f-84c1-2593328c9500",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Correspondance",
"DefaultDocTypeId": "b6704a3c-2cb4-4fd5-9c0f-b9ba0025f3eb",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Miscellaneous",
"Id": "46e6ad33-7abd-4df7-8cc9-1560c4294f70",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Miscellaneous",
"DefaultDocTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Wed, 02 Sep 2015 19:18:33 GMT",
"Modified": "Wed, 02 Sep 2015 19:18:33 GMT",
"Name": "Voice recording",
"Id": "31d400ab-5005-454c-a56a-0a4f1da751bc",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Voice recording",
"DefaultDocTypeId": "00000000-0000-0000-0000-000000000000",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:40 GMT",
"Name": "Tax",
"Id": "d7260795-1057-4000-9dc0-d06213a226d8",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Tax",
"DefaultDocTypeId": "dd72a8b7-0558-4c05-a9e2-b595a979ce1b",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:40 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:40 GMT",
"Name": "Insurances",
"Id": "46663219-5945-45a3-afca-afd13110916d",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Insurances",
"DefaultDocTypeId": "be881675-4a88-4aa4-8e51-965f33907267",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:40 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:40 GMT",
"Name": "Contracts",
"Id": "48b93867-5185-432b-a2e2-5f4685803111",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Contracts",
"DefaultDocTypeId": "01060e58-2292-409a-9afb-85905b98d8c1",
"IsFav": false,
"IsShared": false
}
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "My Documents",
"Id": "806584d4-3d23-4787-9d86-32c94498458a",
"ParentFolderId": "00000000-0000-0000-0000-000000000000",
"Path": "My Documents",
"DefaultDocTypeId": "00000000-0000-0000-0000-000000000000",
"IsFav": false,
"IsShared": false
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve shared folder structure
URL | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||
Parameter | SID (String) The SID of the contact. | |||||||||||||
rootFolderName (String) The display name of the root folder. | ||||||||||||||
flat (Boolean) True = The folder structure will be returned flat, False = The folder structure will be returned in a nested hierarchy. | ||||||||||||||
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | ||||||||||||||
Return | Items (String) List of all folder elements
| |||||||||||||
Status (Integer) See Status codes. | ||||||||||||||
StatusMsg (String) The localized description of the error. | ||||||||||||||
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/folder/listsharedfolders HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 85 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] sid=U-33a8c6aa-0c30-4c48-a32b-ec47826e8e5c&rootFolderName=Shared+Documents&flat=false
Answer
{
"Items": [
{
"Items": [
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Fotos",
"Id": "6d62353e-374a-46e0-a7c5-15241e911868",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Fotos",
"DefaultDocTypeId": "d02d7f8a-7c6e-47a8-980a-ad46e6c1933d",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Job",
"Id": "1894ed32-ef57-4452-80ee-e2e51d315362",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Job",
"DefaultDocTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"IsFav": false,
"IsShared": false
},
{
"Items": [
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Receipt",
"Id": "ce522758-3245-4b89-973e-8039671300f6",
"ParentFolderId": "13f01266-3cdd-473e-bed1-2851d8303141",
"Path": "My Documents/Invoices/Receipts",
"DefaultDocTypeId": "52168b02-f43d-4921-b792-0b17ce24918d",
"IsFav": false,
"IsShared": false
}
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Wed, 27 May 2015 12:38:19 GMT",
"Name": "Invoices",
"Id": "13f01266-3cdd-473e-bed1-2851d8303141",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Invoices/Receipts",
"DefaultDocTypeId": "2822007a-9188-41bb-a8b6-09b89211e9a8",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Correspondence",
"Id": "b7acd398-b584-415f-84c1-2593328c9500",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Correspondance",
"DefaultDocTypeId": "b6704a3c-2cb4-4fd5-9c0f-b9ba0025f3eb",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Miscellaneous",
"Id": "46e6ad33-7abd-4df7-8cc9-1560c4294f70",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Miscellaneous",
"DefaultDocTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Wed, 02 Sep 2015 19:18:33 GMT",
"Modified": "Wed, 02 Sep 2015 19:18:33 GMT",
"Name": "Voice recording",
"Id": "31d400ab-5005-454c-a56a-0a4f1da751bc",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Voice recording",
"DefaultDocTypeId": "00000000-0000-0000-0000-000000000000",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:40 GMT",
"Name": "Tax",
"Id": "d7260795-1057-4000-9dc0-d06213a226d8",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Tax",
"DefaultDocTypeId": "dd72a8b7-0558-4c05-a9e2-b595a979ce1b",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:40 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:40 GMT",
"Name": "Insurances",
"Id": "46663219-5945-45a3-afca-afd13110916d",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Insurances",
"DefaultDocTypeId": "be881675-4a88-4aa4-8e51-965f33907267",
"IsFav": false,
"IsShared": false
},
{
"Items": [
],
"Created": "Tue, 10 Feb 2015 12:53:40 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:40 GMT",
"Name": "Contracts",
"Id": "48b93867-5185-432b-a2e2-5f4685803111",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Contracts",
"DefaultDocTypeId": "01060e58-2292-409a-9afb-85905b98d8c1",
"IsFav": false,
"IsShared": false
}
],
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "My Documents",
"Id": "806584d4-3d23-4787-9d86-32c94498458a",
"ParentFolderId": "00000000-0000-0000-0000-000000000000",
"Path": "My Documents",
"DefaultDocTypeId": "00000000-0000-0000-0000-000000000000",
"IsFav": false,
"IsShared": false
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve folder information
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | |
Return | Created (String) The date and time, when the folder was created. |
Modified (String) The date and time, when the folder was modified recently. | |
Name (String) The name of the folder. | |
ID (String) The ID of the folder. | |
ParentFolderID (String) The ID of the superordinate folder. | |
Path (String) The complete path of the current folder. | |
DefaultDocTypeId (String) The ID of the default document type. | |
IsFav (Boolean) Flag, if this folder is marked as favorite. | |
IsShared (Boolean) Flag, if this folder is released. | |
IsAuditProof (Boolean) Flag, if this folder has audit-proof presettings. | |
AuditProofUntil (String) The date until documents in this folder should be stored audit-proof. The value must be a valid date and must not be in the past. An empty value will reset previously made settings. | |
DocumentCount (Long) The number of documents in this folder. | |
FolderCount (Long) The number of subfolders within this folder. | |
Status (Integer) See Status codes. | |
StatusMsg (String) The localized description of the error. | |
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/folder/rootfolder HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868
Answer
{
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Photos",
"Id": "6d62353e-374a-46e0-a7c5-15241e911868",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "Photos",
"DefaultDocTypeId": "d02d7f8a-7c6e-47a8-980a-ad46e6c1933d",
"IsFav": false,
"IsShared": false,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Create folder
URL | |
|---|---|
Method | POST |
Parameter | ParentFolderID (String) ID of the folder where the folder shall be created |
name (String) The name of the new folders. | |
DefaultDocTypeId (String, optional) ID of the default document type | |
IsFav (Boolean, optional) Flag, that this folder shall be added to the favorites | |
Return | Created (String) Date and time, when the folder was created |
Modified (String) Date and time, when the folder was modified recently | |
Name (String) Name of the folder. | |
ID (String) The ID of the folder | |
ParentFolderID (String) ID of the superordinate folder | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/create HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 130 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] parentFolderId=6d62353e-374a-46e0-a7c5-15241e911868&name=Inbox&defaultDocTypeId=d02d7f8a-7c6e-47a8-980a-ad46e6c1933d&isFav=false
Answer
{
"Created": "Tue, 29 Dec 2015 11:01:23 GMT",
"Modified": "Tue, 29 Dec 2015 11:01:23 GMT",
"Name": "Inbox",
"Id": "d1ea7e50-9493-4171-8c8d-ca41645b85d1",
"ParentFolderId": "6d62353e-374a-46e0-a7c5-15241e911868",
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Rename folder
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
name (String) The new name of the folder. | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/rename HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 69 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&name=Incoming invoices
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Move folder
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
targetFolderId (String) ID of the target folder | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/move HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 97 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&targetFolderId=1894ed32-ef57-4452-80ee-e2e51d315362
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Delete folder
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/delete HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve path
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) The ID of the folder. |
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | |
Return | Status (Integer) See Status codes. |
StatusMsg (String) Localized description of the error. | |
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/folder/path HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868
Answer
{
"Path": "Invoices/Incoming invoices"
"Status": 200,
"StatusMsg": "",
"Error": 0
}Resolve path
URL | |
|---|---|
Method | POST |
Parameter | path (String) The complete path of a folder |
Return | |
Created (String) Date and time, when the folder was created | |
Modified (String) Date and time, when the folder was modified recently | |
Name (String) Name of the folder. | |
ID (String) The ID of the folder | |
ParentFolderID (String) ID of the superordinate folder | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/resolvepath HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 36 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] path=Invoices%2FIncoming invoices
Answer
{
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 29 Dec 2015 10:27:34 GMT",
"Name": "Incoming invoices",
"Id": "6d62353e-374a-46e0-a7c5-15241e911868",
"ParentFolderId": "1894ed32-ef57-4452-80ee-e2e51d315362",
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve access rights
URL | |||||
|---|---|---|---|---|---|
Method | POST | ||||
Parameter | FolderID (String) ID of the folder | ||||
Return | |||||
Items (JSON-Map) List of authorization object elements
| |||||
Status (Integer) see Status codes | |||||
StatusMsg (String) Localized description of the error | |||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/resolvepath HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868
Answer
{
"Items": [
{
"Name": "m.mustermann",
"SID": "U-749c915a-2ce3-4a39-ae71-85af1016780b",
"Identifier": "U",
"Allowed": 1,
"Denied": 0
},
{
"Name": "Project team",
"SID": "G-5c00b1fc-6005-4154-b31f-9ca0ad16f932",
"Identifier": "G",
"Allowed": 3,
"Denied": 0
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Assign access rights (contact)
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
UserName (String) The user who shall get the respective right. Only users from own contact list can be passed. | |
Rights (Integer) 0 = No permission (removes the right of the user to this document) 1 = reading allowed 2 = writing allowed 3 = reading and writing allowed | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/allow HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 79 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&userName=max.mustermann&Rights=1
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Assign access rights (contact group)
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
groupName (String) The contact group who shall get the respective right. | |
Rights (Integer) 0 = No permission (removes the right of the user to this document) 1 = reading allowed 2 = writing allowed 3 = reading and writing allowed | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/allowgroup HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 79 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&groupName=Group+A&Rights=1
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Assign access rights (SID)
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
SID (String) SID of the contact or the group | |
Rights (Integer) 0 = No permission (removes the right of the user to this document) 1 = reading allowed 2 = writing allowed 3 = reading and writing allowed | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/allowsid HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 103 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&sid=U-d16b0921-e9b3-4da7-a66a-7c7cf695fa41&Rights=1
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Assign access rights to multiple SID's
To this method a list of rights can be passed directly. This overwrites all current access rights.
Example for the ACL-parameter:
Example
{
ace: [
{sid: "U-4EB9A089-E89D-42FC-94C0-753256A16D6C", rights: 1}, // 1 = readonly
{sid: "G-4BC3838F-685D-4F1F-B671-A0184243D800", rights: 3}, // 3 = read-write
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
acl (String) see sample | |
recursiveDepth (Integer) Settings how the ACL shall be applied to sub-folders and documents. 0 = only current folder, 1 = only documents in the current folder, 2 = all documents and all sub-folders incl. documents | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/denysid HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 234 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&acl=%7Bace%3A+%5B%7Bsid%3A+%22U-4EB9A089-E89D-42FC-94C0-753256A16D6C%22%2C+rights%3A+1%7D%2C+%7Bsid%3A+%22G-4BC3838F-685D-4F1F-B671-A0184243D800%22%2C+rights%3A+3%7D%5D%7D&recursiveDepth=1
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Remove all access rights
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/removeshare HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 103 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Apply access rights to sub-folders and documents
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/applyaclrecursive HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 103 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change default document type
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
docTypeId (String) ID of the new document type | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/setdefaultdoctype HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 92 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&docTypeId=ac1aebb3-e5d6-4ff6-a31d-96c0e2353deb
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Mark as favorite
URL | |
|---|---|
Method | POST |
Parameter | FolderID (String) ID of the folder |
IsFav (Boolean) Flag, if the folder shall be marked as favorite or not | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/setfavourite HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 103 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&isFav=true
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve favorites
URL | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||
Parameter | providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | ||||||||
Return | Items (String) List of all folder elements
| ||||||||
Status (Integer) See Status codes. | |||||||||
StatusMsg (String) The localized description of the error. | |||||||||
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/folder/listfavourite HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [
{
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Photos",
"Id": "6d62353e-374a-46e0-a7c5-15241e911868",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Photos",
"DefaultDocTypeId": "d02d7f8a-7c6e-47a8-980a-ad46e6c1933d",
"IsFav": true,
"IsShared": false
},
{
"Created": "Tue, 10 Feb 2015 12:53:39 GMT",
"Modified": "Tue, 10 Feb 2015 12:53:39 GMT",
"Name": "Job",
"Id": "1894ed32-ef57-4452-80ee-e2e51d315362",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"Path": "My Documents/Job",
"DefaultDocTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"IsFav": true,
"IsShared": false
},
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Mark as audit-proof
URL | |
|---|---|
Method | POST |
Parameter | folderID (String) ID of the folder |
auditProofUntil (Date-String) Date until documents in this folder shall be stored audit-proof. The value must be a valid date and must not be in the past. An empty value will reset previously made settings. | |
includeDocuments (Boolean) (Optional, default=true) Determines whether documents in this folder, that are not already marked as audit proof will be marked as audit proof with the given date | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/folder/markasauditproof HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 72 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=6d62353e-374a-46e0-a7c5-15241e911868&auditProofUntil=2016-12-31[&includeDocuments=true]
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve folder content - documents (bulk)
URL | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||||||||||||||||
Parameter | folderIds (JSON-Array) The IDs of the respective folders. Example: ["c48b8c3b-460e-4fb0-b7c2-6d456f98df8c" "ef9bb87d-8a5c-4271-b9a4-7cd81facc3ff"] | ||||||||||||||||||||||||||||||
providerRootFolderName (String, optional) Optional. The display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | |||||||||||||||||||||||||||||||
Return | Items (JSON-Map) List of all document elements
| ||||||||||||||||||||||||||||||
Status (Integer) See Status codes. | |||||||||||||||||||||||||||||||
StatusMsg (String) The localized description of the error. | |||||||||||||||||||||||||||||||
Error (Integer) See Error codes. |
Request
POST https://api.foxdox.de/folder/listdocumentsbulk HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 45 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderIds=%5B%22c48b8c3b-460e-4fb0-b7c2-6d456f98df8c%22%2C+%22ef9bb87d-8a5c-4271-b9a4-7cd81facc3ff%22%5D
Answer
{
"Items": [
{
"CanRead": true,
"CanReadWrite": true,
"Created": "Thu, 17 Dec 2015 13:21:19 GMT",
"Id": "dcfbc8fc-3542-4f6b-8436-9de72c26c0b7",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "text/plain",
"Name": "Pangramm.txt",
"OriginalName": "Pangramm.txt",
"ParentFolderId": "b7acd398-b584-415f-84c1-2593328c9500",
"FolderId": "b7acd398-b584-415f-84c1-2593328c9500",
"FolderName": "Correspondence",
"FolderPath": "Correspondence",
"Size": 21681,
"version": 0,
"IsOwnDocument": true,
"DocumentOwner": "foxdox",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b6704a3c-2cb4-4fd5-9c0f-b9ba0025f3eb",
"DocumentTypeName": "Correspondence",
"Modified": "Thu, 17 Dec 2015 13:21:19 GMT",
"PhysicalFileChanged": "Thu, 17 Dec 2015 13:21:19 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Document
This chapter concludes all document-related functions.
Upload document
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the target folder. If no specific folder-ID is specified, then the main folder is used. |
Specifies the ID of the document type. If no specific document type ID is specified, then the document type "Miscellaneous" is used. | |
The actual file | |
ID of the cryptographic key, if the document shall be encrypted, else remain empty. | |
Return |
ID of the uploaded document |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/upload HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 771237 Content-Type: multipart/form-data; X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"DocumentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Upload new version
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document for which the new version is to be uploaded. |
Comment on the new version | |
The actual file | |
Return |
ID of the uploaded document |
The current version number | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/uploadnewversion HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 46188 Content-Type: multipart/form-data; X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"DocumentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Version": 2,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Download encrypted document
Retrieves an encrypted document file from the document repository. Possible errors (404 or 401) will be transmitted in the header.
Anmerkung
The password must be passed with the header X-KEYPASS . There is no JavaScript / AJAX-support intended. For encrypted documents no preview graphics and no document pages can be retrieved.
URL | |
|---|---|
Method | GET |
Parameter |
The ID of the document. |
Return | The encrypted file as download. |
Request
GET https://api.foxdox.de/document/getsecuredoc?id=... HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: image/png; X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] X-KEYPASS: [...]
Answer
The encrypted file as download.
Retrieve preview graphic
Retrieves a preview graphic in JPEG-format, with a max. page length of 300 pixels. Possible errors (404 or 401) will be transmitted in the header.
Anmerkung
For JavaScript / AJAX support this function is available as a GET-variant https://api.foxdox.de/document/getthumbex . Here, the token and the parameter must be passed in the querystring and not in the header.
URL | |
|---|---|
Method | GET |
Parameter |
The ID of the document. |
The page of the document If no specific page is specified, then the first page will be returned. For documents with only one page the parameter will be ignored. The page is specified 0-based. Page 1 is 0, page 4 is 3 etc. | |
If deviating from the current version | |
Return | The preview as download (image /jpg) |
Request
GET https://api.foxdox.de/document/getthumb?id=... HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 771237 Content-Type: multipart/form-data; X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Retrieve document page
Anmerkung
For JavaScript / AJAX support this function is available as a GET-variant https://api.foxdox.de/document/getpageex. Here, the token and the parameter must be passed in the querystring and not in the header.
URL | |
|---|---|
Method | GET |
Parameter |
The ID of the document. |
The page of the document If no specific page is specified, then the first page will be returned. For documents with only one page the parameter will be ignored. The page is specified 0-based. Page 1 is 0, page 4 is 3 etc. | |
Size of the page in percent. If no zoom-level is specified, then 100% applies. | |
If deviating from the current version | |
Return | The document page as download |
Request
GET https://api.foxdox.de/document/getpage?id=... HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 77137 Content-Type: image/jpeg; X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
The document page as download
Retrieve document information
URL | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||
Parameter | DocumentId (String) The ID of the document. | ||||||||
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | |||||||||
Return | FolderID (String) The ID of the folder. | ||||||||
FolderName (String) The name of the folder. | |||||||||
FolderPath (String) The path. | |||||||||
Created (String) The date and time, when the document was uploaded. | |||||||||
Modified (String) The date and time, when the document was last modified. | |||||||||
Name (String) The display name of the document. | |||||||||
OriginalName (String) The original file name of the document. | |||||||||
MimeType (String) The MimeType. | |||||||||
Size (Long) The size of the file in bytes. | |||||||||
IsProcessed (Boolean) Flag, if the internal processing of the document was finished. | |||||||||
IsIndexed (Boolean) Flag, if the document was included in the search index. | |||||||||
IsShared (Boolean) Flag, if the document is released. | |||||||||
IsDeleted (Boolean) Flag, if the document is deleted. | |||||||||
IsPublic (Boolean) Flag, if the document is publicly available. | |||||||||
IsProtected (Boolean, optional) Flag, if a publicly available document is password protected. true = password protected // false = not password protected. | |||||||||
IsEncrypted (Boolean) Flag, if the document is encrypted. | |||||||||
IsDownloadOnly (Boolean) Flag, if this document is only available for download. Page view, preview images or search are not available. | |||||||||
IsOffline (Boolean) Flag, if the document should be available offline. | |||||||||
IsAuditProof (Boolean) Flag, if the document is audit-proof. | |||||||||
AuditProofUntil (String) The date until the document is audit-proof. Until then the document can not be deleted. | |||||||||
KeyName (String) Name of the cryptographic key. | |||||||||
Version (Integer) The version number of the document. | |||||||||
VersionComment (String) The comment on the version. | |||||||||
Pages (Integer) The number of pages. | |||||||||
Description (String) The document description. | |||||||||
DocumentTypeId (String) The ID of the document type. | |||||||||
DocumentTypeName (String) The name of the document type. | |||||||||
IsOwnDocument (Boolean) Flag, if the document is an own document. | |||||||||
DocumentOwner (String) The owner of the document. | |||||||||
DocumentOwnerSid (String) The SID of the document owner. | |||||||||
CanRead (Boolean) Flag, if read access was assigned. | |||||||||
CanReadWrite (Boolean) Flag, if read and write access was assigned . | |||||||||
Attributes:
| |||||||||
Status (Integer) See Status codes. | |||||||||
StatusMsg (String) The details on the status code. | |||||||||
Error (Integer) See Error codes. |
Request
GET https://api.foxdox.de/document/details HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 48 Content-Type: application/x-www-form-urlencoded; X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Answer
{
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Comment",
"DataType": 1,
"Value": "",
…
}],
"CanRead": true,
"CanReadWrite": true,
"Created": "Mon, 13 Jun 2016 12:04:16 GMT",
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"DocumentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": false,
"IsAuditProof": false,
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT",
"KeyName": null,
"MimeType": "text/plain",
"Name": "hallowelt.txt",
"Modified": "Mon, 13 Jun 2016 12:04:16 GMT",
"PhysicalFileChanged": "Mon, 13 Jun 2016 12:04:16 GMT",
"OriginalName": "hallowelt.txt",
"ParentFolderId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"ParentFolderName": "Root",
"FolderId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"FolderName": "Root",
"FolderPath": "",
"Size": 10,
"Version": 0,
"VersionComment": "",
"IsOwnDocument": true,
"DocumentOwner": "username",
"DocumentTypeId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"DocumentTypeName": "Sonstiges",
"Description": null,
"Pages": 1,
"Status": 200,
"StatusMsg": "",
"Error": 0
}Rename document
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
The new display name of the document. The original name remains under which the document was uploaded. | |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/rename HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 62 Content-Type: application/x-www-form-urlencoded; X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&name=test.txt
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change description of the document
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
Description of the document | |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/updatedescription HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 89 Content-Type: application/x-www-form-urlencoded; X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=46e6ad33-7abd-4df7-8cc9-1560c4294f70&description=This+is+the+new+description
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change the attribute value
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
The ID of the attribute. | |
| |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/updateattribute HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 113 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=e2f3d05f-2bcf-4449-a2e0-101a00c4d32d&attributeId=00000000-0000-0000-0000-a00000000001&value=new+value
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change name, description and all attributes
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
The new display name of the document. The original name remains under which the document was uploaded. | |
| |
See sample | |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Sample: attributes-field
{
attributes: [
{attributeId: "00000000-0000-0000-0000-a00000000001", value: "Value A"},
{attributeId: "00000000-0000-0000-0000-a00000000002", value: "Value B"},
]
}Request
GET https://api.foxdox.de/document/updatebulk HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 315 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=e2f3d05f-2bcf-4449-a2e0-101a00c4d32d&attributes=%7Battributes%3A+%5B%7BattributeId%3A+%2200000000-0000-0000-0000-a00000000001%22%2C+value%3A+%22Value+A%22%7D%2C+%7BattributeId%3A+%2200000000-0000-0000-0000-a00000000002%22%2C+value%3A+%22Value+B%22%7D%5D%7D&name=new_name.txt&description=new+description
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Moving a document
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
The ID of the target folder. | |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/move HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=e2f3d05f-2bcf-4449-a2e0-101a00c4d32d&targetFolderId=46e6ad33-7abd-4df7-8cc9-1560c4294f70
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Move document to recycle bin
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/markasdeleted HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=e2f3d05f-2bcf-4449-a2e0-101a00c4d32d
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Restore document from recycle bin
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document to be deleted. |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/restorefromdeleted HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Delete document
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/delete HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Search document
URL | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||
Parameter | keywords (String) The keyword. Several terms separated by a space. | |||||||||||||
folderId (String, optional) Optional. The ID of the folder to search in. | ||||||||||||||
includeShared (Boolean, optional) Optional. Search in released documents, too. | ||||||||||||||
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | ||||||||||||||
Return | Items:
| |||||||||||||
Status (Integer) See Status codes. | ||||||||||||||
StatusMsg (String) The details on the status code. | ||||||||||||||
Error (Integer) See Error codes. |
Request
GET https://api.foxdox.de/document/find HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] keywords=xxx&folderId =XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&includeShared=false
Answer
{
"Items": [{
"DocumentId": "9917ce1c-0737-4cb0-97e0-750ea573d64f",
"FolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderName": "Root",
"FolderPath": "Root",
"DocumentName": "helloworld.txt",
"DocumentTags": null,
"Created": "Fri, 11 Mar 2016 13:06:51 GMT",
"DocumentTypeName": "Miscellaneous",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"Score": 1.29970694,
"DocumentOwner": "foxdox_qs13",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"CanRead": true,
"CanReadWrite": true
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Search with detailed return list
URL | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||||
Parameter |
The keyword. Several terms separated by a space. | |||||||||||||||||||||||||||||||||
Optional folder ID where to be searched. | ||||||||||||||||||||||||||||||||||
Optionally, search in released documents, too. | ||||||||||||||||||||||||||||||||||
Optionally, search in makred as deleted documents, too. | ||||||||||||||||||||||||||||||||||
providerRootFolderName (String, optional) Optional, Display name of the "Meine Provider" folder By default, this folder is always named "Meine Provider". | ||||||||||||||||||||||||||||||||||
Return | Items:
| |||||||||||||||||||||||||||||||||
See Status codes | ||||||||||||||||||||||||||||||||||
Details on the status code | ||||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/findasdetailedlist HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] keywords=xxx&folderId =XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&includeShared=false&includeDeleted=false
Answer
{
"Items": [
{
"Score": 1.2334739,
"CanRead": true,
"CanReadWrite": true,
"Created": "Tue, 17 Nov 2015 07:56:18 GMT",
"Id": "6a174048-be94-40bc-abd9-bf98e0ae93a5",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": false,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "text/plain",
"Name": "hallowelt.txt",
"OriginalName": "helloworld.txt",
"ParentFolderId": "00000000-0000-0000-0000-000000000000",
"FolderId": "46e6ad33-7abd-4df7-8cc9-1560c4294f70",
"FolderName": "Miscellaneous",
"FolderPath": "Root/Miscellaneous",
"Size": 10,
"Version": 0,
"IsOwnDocument": true,
"DocumentOwner": "m.mustermann",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Tue, 17 Nov 2015 07:56:18 GMT",
"PhysicalFileChanged": "Tue, 17 Nov 2015 07:56:18 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve document access rights
URL | ||||||
|---|---|---|---|---|---|---|
Method | POST | |||||
Parameter |
The ID of the document. | |||||
Return | Items:
| |||||
See Status codes | ||||||
Details on the status code | ||||||
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/acl HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 48 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=370ea063-a839-4e5a-866b-f1bb3779d610
Answer
{
"Items": [
{
"Name": "fritz.fuchs",
"SID": "U-749c915a-2ce3-4a39-ae71-85af1016780b",
"Identifier": "G",
"Allowed": 1,
"Denied": 0
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Assign document access rights (contact)
URL | |
|---|---|
Method | POST |
Parameter | DocumentId (String) Document ID |
UserName (String) The user who shall get the respective right. Only users from own contact list can be passed. | |
Rights (Integer) 0 = No permission (removes the right of the user to this document) 1 = reading allowed 2 = writing allowed 3 = reading and writing allowed | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/allow HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 79 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=6d62353e-374a-46e0-a7c5-15241e911868&userName=max.mustermann&Rights=1
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Assign document access rights (contact group)
URL | |
|---|---|
Method | POST |
Parameter | DocumentId (String) Document ID |
groupName (String) The contact group who shall get the respective right. | |
Rights (Integer) 0 = No permission (removes the right of the user to this document) 1 = reading allowed 2 = writing allowed 3 = reading and writing allowed | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/allowgroup HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 79 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=6d62353e-374a-46e0-a7c5-15241e911868&groupName=Group+A&Rights=1
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Assign document access rights (SID)
URL | |
|---|---|
Method | POST |
Parameter | DocumentId (String) Document ID |
SID (String) SID of the contact or the group | |
Rights (Integer) 0 = No permission (removes the right of the user to this document) 1 = reading allowed 2 = writing allowed 3 = reading and writing allowed | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/allowsid HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 103 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=6d62353e-374a-46e0-a7c5-15241e911868&sid=U-d16b0921-e9b3-4da7-a66a-7c7cf695fa41&Rights=1
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Assign access rights to multiple SID's 1
To this method a list of rights can be passed directly. This overwrites all current access rights.
Example for the ACL-parameter:
Example
{
ace: [
{sid: "U-4EB9A089-E89D-42FC-94C0-753256A16D6C", rights: 1}, // 1 = readonly
{sid: "G-4BC3838F-685D-4F1F-B671-A0184243D800", rights: 3}, // 3 = read-write
URL | |
|---|---|
Method | POST |
Parameter | DocumentId (String) Document ID |
acl (String) see sample | |
recursiveDepth (Integer) Settings how the ACL shall be applied to sub-folders and documents. 0 = only current folder, 1 = only documents in the current folder, 2 = all documents and all sub-folders incl. documents | |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/denysid HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 234 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=6d62353e-374a-46e0-a7c5-15241e911868&acl=%7Bace%3A+%5B%7Bsid%3A+%22U-4EB9A089-E89D-42FC-94C0-753256A16D6C%22%2C+rights%3A+1%7D%2C+%7Bsid%3A+%22G-4BC3838F-685D-4F1F-B671-A0184243D800%22%2C+rights%3A+3%7D%5D%7D&recursiveDepth=1
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Remove all document access rights
URL | |
|---|---|
Method | POST |
Parameter | DocumentId (String) Document ID |
Return | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/removeshare HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 48 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=6d62353e-374a-46e0-a7c5-15241e911868
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Edit a document
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
The ID of the document type. | |
JSON-string, contains as the only one element an array with the fields attributeId and value. Example: { „attributes“: [{„attributeId“: „XXXXXX“, „value“: „YYYYYY“}] } | |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/changedoctype HTTP/1.1
Host: api.foxdox.de
Connection: keep-alive
Content-Length: 99
Content-Type: application/x-www-form-urlencoded
X-DEVID: [...]
X-APPID: [...]
X-LANG: de
X-APPVER: 0.1
X-TOKEN: [...]
documentId=6ebe471f-4fb6-492b-9b08-9f3314dd6e5f&documentTypeId=d02d7f8a-7c6e-47a8-980a-ad46e6c1933d&attributes={attributes=[{attributeId=00000000-0000-0000-0000-a00000000050,value=""}Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}List released documents
URL | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||
Parameter | username (String, optional) The user the document should be shared with. Empty to retrieve all documents. Instead of the user name alternatively the SID of a group or a contact can be passed. | |||||||||||||||||||||||||||||||
folderId (String, optional) ID of the folder to be filtered. Empty to retrieve all documents. | ||||||||||||||||||||||||||||||||
rootDocumentsOnly (Boolean, optional) Optional, receive only all shared documents without a shared parent folder Only active if folder ID is empty or missing | ||||||||||||||||||||||||||||||||
providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | ||||||||||||||||||||||||||||||||
Return | Items:
| |||||||||||||||||||||||||||||||
Status (Integer) See Status codes | ||||||||||||||||||||||||||||||||
StatusMsg (String) Details on the status code | ||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/listshareddocs HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] folderId=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&username=foxdox
Answer
{
"Items": [{
"CanRead": true,
"CanReadWrite": true,
"Created": "Fri, 17 Jun 2016 06:51:58 GMT",
"Id": "3cdde74c-2687-4ad4-ae89-a80776958ca5",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": true,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "image/png",
"Name": "2016-06-15 08_24_35-Tarif - Bestellstatus.png",
"OriginalName": "2016-06-15 08_24_35-Tarif - Bestellstatus.png",
"ParentFolderId": "8f491f1a-353f-43b7-b59a-12e568832cdd",
"FolderId": "8f491f1a-353f-43b7-b59a-12e568832cdd",
"FolderName": "TestTeilen",
"FolderPath": "TestTeilen",
"Size": 54380,
"Version": 0,
"IsOwnDocument": true,
"DocumentOwner": "foxdox_qs13",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "61534ea8-9bb6-4354-8f1f-7130b88b03d5",
"DocumentTypeName": "document",
"Modified": "Fri, 17 Jun 2016 06:51:58 GMT",
"PhysicalFileChanged": "Fri, 17 Jun 2016 06:51:58 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
List all documents
URL | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||
Parameter | providerRootFolderName (String, optional) Optional, Display name of the "Meine Provider" folder By default, this folder is always named "Meine Provider". | |||||||||||||||||||||||||||||||
Return | Items:
| |||||||||||||||||||||||||||||||
See Status codes | ||||||||||||||||||||||||||||||||
Details on the status code | ||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/listalldocs HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"CanRead": true,
"CanReadWrite": true,
"Created": "Thu, 17 Dec 2015 15:05:48 GMT",
"Id": "482a0d01-b69e-43f7-8007-2010fdbc6160",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "image/png",
"Name": "635851226714332950.png",
"OriginalName": "635851226714332950.png",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderName": "Root",
"FolderPath": "",
"Size": 120295,
"Version": 0,
"IsOwnDocument": true,
"DocumentOwner": "foxdox_qs13",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Thu, 17 Dec 2015 15:05:48 GMT",
"PhysicalFileChanged": "Thu, 17 Dec 2015 15:05:48 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
},
{
"CanRead": true,
"CanReadWrite": true,
"Created": "Wed, 27 May 2015 13:15:50 GMT",
"Id": "61b62804-5101-4df5-a23e-44023b840937",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": false,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "application/pdf",
"Name": "Pangramm (10).pdf",
"OriginalName": "Pangramm (10).pdf",
"ParentFolderId": "46e6ad33-7abd-4df7-8cc9-1560c4294f70",
"FolderId": "46e6ad33-7abd-4df7-8cc9-1560c4294f70",
"FolderName": "Miscellaneous",
"FolderPath": "Miscellaneous",
"Size": 392647,
"Version": 0,
"IsOwnDocument": true,
"DocumentOwner": "foxdox_qs13",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Wed, 27 May 2015 13:15:50 GMT",
"PhysicalFileChanged": "Wed, 27 May 2015 13:15:50 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Show recycle bin
URL | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||
Parameter | providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | |||||||||||||||||||||||||||||||
Return | Items:
| |||||||||||||||||||||||||||||||
Status (Integer) See Status codes. | ||||||||||||||||||||||||||||||||
StatusMsg (String) The details on the status code. | ||||||||||||||||||||||||||||||||
Error (Integer) See Error codes. |
Request
GET https://api.foxdox.de/document/listdeleteddocs HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"CanRead": true,
"CanReadWrite": true,
"Created": "Tue, 26 Apr 2016 06:43:18 GMT",
"Id": "460f437b-b5a3-41d6-9d51-71c6c4bb9c63",
"IsDeleted": true,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": false,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "text/plain",
"Name": "helloworld.txt",
"OriginalName": "helloworld.txt",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderName": "Root",
"FolderPath": "",
"Size": 10,
"Version": 0,
"IsOwnDocument": true,
"DocumentOwner": "foxdox_qs13",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Wed, 04 May 2016 09:22:27 GMT",
"PhysicalFileChanged": "Wed, 04 May 2016 09:22:27 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Sending
REMOVED
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
The user name of a contact the document shall be sent to. | |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/send HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=6ebe471f-4fb6-492b-9b08-9f3314dd6e5f&username=foxdox
Answer
404 can not find the requested resource
List all offline documents
URL | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||
Parameter | providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | |||||||||||||||||||||||||||||||
Return | Items:
| |||||||||||||||||||||||||||||||
Status (Integer) See Status codes | ||||||||||||||||||||||||||||||||
StatusMsg (String) Details on the status code | ||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/listofflinedocs HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"CanRead": true,
"CanReadWrite": true,
"Created": "Tue, 17 Nov 2015 09:59:31 GMT",
"Id": "53fa2ad9-f6b4-48d5-bb0c-98bddde101e8",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": false,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": true,
"IsAuditProof": false,
"KeyName": null,
"MimeType": "text/plain",
"Name": "helloworld.txt",
"OriginalName": "helloworld.txt",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderName": "Root",
"FolderPath": "",
"Size": 10,
"Version": 0,
"IsOwnDocument": true,
"DocumentOwner": "foxdox_qs13",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Sun, 13 Dec 2015 22:08:02 GMT",
"PhysicalFileChanged": "Tue, 17 Nov 2015 09:59:31 GMT",
"AuditProofUntil": "Mon, 01 Jan 0001 00:00:00 GMT"
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve version history
URL | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||
Parameter |
The ID of the document. | |||||||||||||||||
Return |
The ID of the document. | |||||||||||||||||
Items: List of all document versions
| ||||||||||||||||||
See Status codes | ||||||||||||||||||
Details on the status code | ||||||||||||||||||
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/versionhistory HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=6ebe471f-4fb6-492b-9b08-9f3314dd6e5
Answer
{
"Id": "6ebe471f-4fb6-492b-9b08-9f3314dd6e5f",
"Items": [{
"IsCurrentVersion": true,
"TimeImported": "Fri, 01 Jul 2016 22:01:33 GMT",
"DocumentTypeId": "d02d7f8a-7c6e-47a8-980a-ad46e6c1933d",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Comment",
"DataType": 1,
"Value": "",
"Length": 0,
"Rows": 0
}],
"Version": 1,
"VersionComment": "",
"OriginalName": "02 Client Application Programming Interface.pdf",
"MimeType": "application/pdf",
"Size": 1500153,
"Pages": 1,
"IsDownloadOnly": false,
"DocumentTypeName": "Photo"
},
{
"IsCurrentVersion": false,
"TimeImported": "Fri, 01 Jul 2016 06:41:35 GMT",
"DocumentTypeId": "d02d7f8a-7c6e-47a8-980a-ad46e6c1933d",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Value": "2016-07-01 17:54:13.048000",
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Name",
"DataType": 1,
"Value": "",
"Length": 150,
"Rows": 0
}],
"Version": 0,
"VersionComment": "",
"OriginalName": "facepalm.jpg",
"MimeType": "image/jpeg",
"Size": 1822,
"Pages": 1,
"IsDownloadOnly": false,
"DocumentTypeName": "Photo"
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}List audit-proof documents
URL | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||
Parameter | providerRootFolderName (String, optional) Optional. Display name of the Meine Provider folder. By default, this folder is always named Meine Provider. | |||||||||||||||||||||||||||||||
Return | Items:
| |||||||||||||||||||||||||||||||
See Status codes | ||||||||||||||||||||||||||||||||
StatusMsg (String) Details on the status code | ||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/listauditproofdocs HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"CanRead": true,
"CanReadWrite": true,
"Created": "Tue, 15 Mar 2016 13:16:59 GMT",
"Id": "67bfabe3-d461-45b4-ae96-de7a4e78632f",
"IsDeleted": false,
"IsDownloadOnly": false,
"IsEncrypted": false,
"IsIndexed": true,
"IsProcessed": true,
"IsPublic": false,
"IsShared": false,
"IsOffline": false,
"IsAuditProof": true,
"KeyName": null,
"MimeType": "text/plain",
"Name": "helloworld.txt",
"OriginalName": "helloworld.txt",
"ParentFolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderId": "806584d4-3d23-4787-9d86-32c94498458a",
"FolderName": "Root",
"FolderPath": "",
"Size": 11,
"Version": 0,
"IsOwnDocument": true,
"DocumentOwner": "foxdox_qs13",
"DocumentOwnerSid": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4",
"DocumentTypeId": "b056f2c3-59be-4038-adf3-24728e9376df",
"DocumentTypeName": "Miscellaneous",
"Modified": "Fri, 01 Jul 2016 22:15:12 GMT",
"PhysicalFileChanged": "Tue, 15 Mar 2016 13:16:59 GMT",
"AuditProofUntil": "Wed, 06 Jul 2016 22:00:00 GMT"
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Mark as audit-proof 1
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
Date until the document shall be stored audit-proof. The value must be a valid date and must not be in the past. | |
Flag, that this document shall be marked as audit-proof. After expiration of the audit-proof time this flag can be resetted. | |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/MarkAsAuditProof HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=6ebe471f-4fb6-492b-9b08-9f3314dd6e5f&auditProofUntil=07.07.2017&isAuditProof=true
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Decrypt encrypted document
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document. |
Password for the used key | |
Flag, if the original document shall be deleted | |
Return |
The ID of the new (encrypted) document |
See Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/decrypt HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 99 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=5f8237ec-6653-42e5-b166-48e156614375&password=foxdox&deleteAfterDecrypt=true
Answer
{
"DocumentId": "2a1b19a5-41ee-4319-a743-14e39c1f9843",
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Download document
Anmerkung
For JavaScript / AJAX support this function is available as a GET-variant https://api.foxdox.de/document/getdocex. Here, the token and the parameter must be passed in the querystring and not in the header.
URL | |
|---|---|
Method | GET |
Parameter |
The ID of the document. |
If deviating from the current version | |
useContentDispositionHeader (Boolean, optional) If the file should be downloaded, or inline displayed | |
Return | The original uploaded file as download. |
Request
GET https://api.foxdox.de/document/getdoc?id=... HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Download as PDF
Anmerkung
For JavaScript / AJAX support this function is available as a GET-variant https://api.foxdox.de/document/getpdfex. Here, the token and the parameter must be passed in the querystring and not in the header.
URL | https://api.foxdox.de/document/getpdf |
|---|---|
Method | GET |
Parameter |
The ID of the document. |
If deviating from the current version | |
Return | The document as PDF file. |
Request
GET https://api.foxdox.de/document/getpdf?id=... HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Download full export package
Anmerkung
For JavaScript / AJAX support this function is available as a GET-variant https://api.foxdox.de/document/getpackageex. Here, the token and the parameter must be passed in the querystring and not in the header.
URL | |
|---|---|
Method | GET |
Parameter |
The ID of the document. |
If deviating from the current version | |
Return | The original uploaded file, the OCR-text and the PDF-file packed as ZIP-file. |
Request
GET https://api.foxdox.de/document/getpackage?id=... HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Download OCR-text
Anmerkung
For JavaScript / AJAX support this function is available as a GET-variant https://api.foxdox.de/document/getocrex. Here, the token and the parameter must be passed in the querystring and not in the header.
URL | |
|---|---|
Method | GET |
Parameter |
The ID of the document. |
If deviating from the current version | |
Return | The OCR-text (if existing) |
Request
GET https://api.foxdox.de/document/getdoc?id=... HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Download offline version
Anmerkung
For JavaScript / AJAX support this function is available as a GET-variant https://api.foxdox.de/document/getofflinedocdocex. Here, the token and the parameter must be passed in the querystring and not in the header.
URL | |
|---|---|
Method | GET |
Parameter |
The ID of the document. |
Return | An offline version of the document. |
Request
GET https://api.foxdox.de/document/getofflinedoc?id=... HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Mark as audit-proof (bulk)
URL | |
|---|---|
Method | POST |
Parameter |
The IDs of the document. Example: ["48a90943-9a5d-4e19-92cb-d97dd91e3801", "1bbcf56c-5650-4cef-96a5-508e94a19666"] |
Date until the documents shall be stored audit-proof. The value must be a valid date and must not be in the past. | |
Flag, that this documents shall be marked as audit-proof. After expiration of the audit-proof time this flag can be resetted. | |
Return |
See Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
GET https://api.foxdox.de/document/MarkAsAuditProofBulk HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 151 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentids=%5B%2248a90943-9a5d-4e19-92cb-d97dd91e3801%22%2C+%221bbcf56c-5650-4cef-96a5-508e94a19666%22%5D&isauditproof=true&auditproofuntil=18.01.2017
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Tenant
Retrieve tenant information
URL | ||
|---|---|---|
Method | POST | |
Parameter | None | |
Return | ||
Items (JSON-Map) List of tenant objects
| ||
Status (Integer) see Status codes | ||
StatusMsg (String) Localized description of the error | ||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/tenant/details HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [
{
"TenantName": "m.mustermann",
"BusinessType": 1
}
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Published documents
Publishing
Anmerkung
When the parameter isPublicUntil is true and publicUntil is set with a date and the date is in the past, the settings for the document are reseted, and the document is not public anymore.
URL | |
|---|---|
Method | POST |
Parameter | DocumentId (String) The ID of the document. |
IsPublic (Boolean) true = published // false = not published | |
IsProtected (Boolean, optional) true = password protected // false = not password protected | |
Password (String, optional) The password, if password protection is true Must be at least 6 chars long | |
isPublicUntil(Boolean, optional) true = is public until the set date // false = is not public | |
publicUntil(String, optional) The Date until the document is public | |
Return | PublicUrl (String) The URL under which the document is accessible. Empty, if the publishing was removed. |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/publish HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 91 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentId=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&isPublic=true&isProtected=true&password=geheim&isPublicUntil=false&publicUntil=""
Answer
{
"PublicUrl":"https://api.foxdox-staging.test.d-velop.de/Public/document/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Status":200,
"StatusMsg":"",
"Error":0
}Download public document
This function downloads a public document from the archive. There is no login and no token needed.
URL | |
|---|---|
Method | GET |
Parameter | ID (String) The ID of the document. |
Token (String, optional) The download token. | |
useContentDispositionHeader (Boolean, optional) If useContentDispositionHeader is false, the document will be downloaded. | |
Return | The public document as download or the document content. |
Request
GET https://api.foxdox.de/public/document/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX?token=t?useContentDispositionHeader=false HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1
Answer
If useContentDispositionHeader is false, the document as download. If useContentDispositionHeader is true, the document content.
Download preview graphic
This function downloads a preview graphic of a public document. There is no login and no token needed.
URL | https://api.foxdox.de/public/thumb/?id=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&page=N&token=t |
|---|---|
Method | GET |
Parameter | ID (String) The ID of the document. |
page (Integer) Optional, Default = 1 | |
token (String) Optional, the download token | |
Return | The preview graphic on the specified page of the public document as download. |
Request
GET https://api.foxdox.de/public/thumb HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1
Answer
The preview graphic on the specified page of the public document as download.
Download page graphic
This function downloads a preview graphic of a public document. There is no login and no token needed.
URL | https://api.foxdox.de/public/page/?id=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&page=N&zoom=Z&token=T |
|---|---|
Method | GET |
Parameter | ID (String) The ID of the document. |
page (Integer) Optional, Default = 1 | |
Optional, default = 100 | |
token (String) Optional, the download token | |
Return | The specified page of the public document as download. |
Request
GET https://api.foxdox.de/public/page HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1
Answer
Binary data.
Retrieve information
There is no login and no token needed for this function.
URL | |
|---|---|
Method | POST |
Parameter | ID (String) The ID of the document. |
Return |
Display name of the document. |
The MimeType | |
The size of the file in bytes | |
Number of pages | |
Flag, if this document is only available for download. Page view or preview graphics are not available. | |
IsProtected (Boolean) Flag, if this document is password-protected. | |
See Status codes | |
Details on the status code | |
See Error codes |
Request
POST https://api.foxdox.de/public/details HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 39 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 id=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Answer
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Name": "name.txt",
"MimeType": "text/plain",
"Size": 273,
"Pages": 1,
"IsDownloadOnly": false,
"Status": 200,
"StatusMsg": "",
"Error": 0
} Request a download token
URL | |
|---|---|
Method | POST |
Parameter | id (String) The ID of the document. |
password (String, optional) The password, if password protection is true Must be at least 6 chars long | |
Return | Token (String) The download token |
Ttl (Integer) Token lifetime in seconds | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/public/requestpublictoken HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 91 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] id=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&password=secure
Answer
{
"Token":"",
"Ttl": 86400,
"Status":200,
"StatusMsg":"",
"Error":0
}Document type
This chapter concludes all document type-related functions.
Retrieve document types
URL | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||
Parameter | none | |||||||||
Return | Items:
| |||||||||
Status (Integer) see Status codes | ||||||||||
Details on the status code | ||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/doctype/listdocumenttypes HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 9323 Content-Type: application/json; charset=utf-8 X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"Id": "61534ea8-9bb6-4354-8f1f-7130b88b03d5",
"Name": "Document",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Subject",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "d02d7f8a-7c6e-47a8-980a-ad46e6c1933d",
"Name": "Photo",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Name",
"DataType": 1,
"Length": 150,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "52168b02-f43d-4921-b792-0b17ce24918d",
"Name": "Receipt",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000070",
"Name": "Amount",
"DataType": 4,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Name",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000002",
"Name": "Store",
"DataType": 1,
"Length": 0,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "2822007a-9188-41bb-a8b6-09b89211e9a8",
"Name": "Invoice",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Invoice Number",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000002",
"Name": "Name",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000070",
"Name": "Amount",
"DataType": 4,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000003",
"Name": "Invoice recipient - Name",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000004",
"Name": "Invoice recipient- Street
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000005",
"Name": "Invoice recipient - PLZ
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000006",
"Name": "Invoice recipient - City",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000007",
"Name": "Biller - Name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000008",
"Name": "Biller - Street
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000009",
"Name": "Biller - PLZ
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000010",
"Name": "Biller - City",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000011",
"Name": "Invoice recipient - First name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000012",
"Name": "Biller - First name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000013",
"Name": "Due date of payment",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000014",
"Name": "BLZ",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000015",
"Name": "Account",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000016",
"Name": "IBAN",
"DataType": 1,
"Length": 0,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "b6704a3c-2cb4-4fd5-9c0f-b9ba0025f3eb",
"Name": "Correspondence",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Subject",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000003",
"Name": "Sender - Name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000004",
"Name": "Sender - Street
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000005",
"Name": "Sender - PLZ
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000006",
"Name": "Sender - City",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000007",
"Name": "Recipient - Name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000008",
"Name": "Recipient - Street
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000009",
"Name": "Recipient - PLZ
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000010",
"Name": "Recipient - City",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000002",
"Name": "Sender - First name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000011",
"Name": "Recipient - First name",
"DataType": 1,
"Length": 0,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "b056f2c3-59be-4038-adf3-24728e9376df",
"Name": "Miscellaneous",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Comment",
"DataType": 1,
"Length": 0,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "74133306-a674-411d-86c3-fcac987129f7",
"Name": "Voice recording",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Recording date",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000080",
"Name": "Length",
"DataType": 3,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Comment",
"DataType": 1,
"Length": 0,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "dd72a8b7-0558-4c05-a9e2-b595a979ce1b",
"Name": "Taxes",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Name",
"DataType": 1,
"Length": 150,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000002",
"Name": "Tax ID",
"DataType": 1,
"Length": 150,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "be881675-4a88-4aa4-8e51-965f33907267",
"Name": "Insurances",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Insurance type",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000002",
"Name": "Insurance number",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000051",
"Name": "Insurance beginning",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000052",
"Name": "Insurance ending",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000003",
"Name": "Insurance company - Name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000004",
"Name": "Insurance company - Street
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000005",
"Name": "Insurance company - PLZ
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000006",
"Name": "Insurance company - City",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000007",
"Name": "Contractor - Name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000008",
"Name": "Contractor - Street
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000009",
"Name": "Contractor - PLZ
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000010",
"Name": "Contractor - City",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000011",
"Name": "Contractor - First name
"DataType": 1,
"Length": 0,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "01060e58-2292-409a-9afb-85905b98d8c1",
"Name": "Contract",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Contract type",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Contract date",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000051",
"Name": "Contract commencement",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000052",
"Name": "Contract expiry",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000080",
"Name": "Contract period",
"DataType": 5,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000003",
"Name": "Contractee - Name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000004",
"Name": "Contractee - Street
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000005",
"Name": "Contractee - PLZ
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000006",
"Name": "Contractee - City",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000007",
"Name": "Contractor - Name
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000008",
"Name": "Contractor - Street
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000009",
"Name": "Contractor - PLZ
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000010",
"Name": "Contractor - City",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000002",
"Name": "Contractor - First name",
"DataType": 1,
"Length": 0,
"Rows": 0
}],
"IsSystem": true
},
{
"Id": "95276883-79f6-43e2-baae-2bec9ddbac8f",
"Name": "Payslip",
"Attributes": [],
"IsSystem": false
},
{
"Id": "9e19ad9d-036e-46e0-945c-35f5ba1c75b1",
"Name": "Newsletter",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Name",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
}],
"IsSystem": false
},
{
"Id": "217276a8-351d-424b-be02-883df99c19e1",
"Name": "Wage and salary",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Pers-Nr.",
"DataType": 1,
"Length": 150,
"Rows": 0
}],
"IsSystem": false
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve document type
URL | |||||
|---|---|---|---|---|---|
Method | POST | ||||
Parameter |
The ID of the document type. | ||||
Return |
ID of the document type | ||||
The name of the document type | |||||
Flag, if this document type is one of the types provided by the system. | |||||
Attributes:
| |||||
Status (Integer) see Status codes | |||||
StatusMsg (String) Localized description of the error | |||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/document/publish HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 53 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentTypeId=61534ea8-9bb6-4354-8f1f-7130b88b03d5
Answer
{
"Id": "61534ea8-9bb6-4354-8f1f-7130b88b03d5",
"Name": "Document",
"Attributes": [{
"Id": "00000000-0000-0000-0000-a00000000001",
"Name": "Subject",
"DataType": 1,
"Length": 0,
"Rows": 0
},
{
"Id": "00000000-0000-0000-0000-a00000000050",
"Name": "Date",
"DataType": 5,
"Length": 0,
"Rows": 0
}],
"IsSystem": true,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Create a document type
URL | |
|---|---|
Method | POST |
Parameter |
The name of the new document type |
Return |
ID of the document type |
The name of the document type | |
Status (Integer) see Status codes | |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/doctype/adddocumenttype HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 11 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] Name=XXXXXX
Answer
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX",
"Name": "XXXXXX",
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Delete document type
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the document type. |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/doctype/deletedocumenttype HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 53 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentTypeId =XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve attributes
URL | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||
Parameter | none | |||||||||
Return | Items:
| |||||||||
Status (Integer) see Status codes | ||||||||||
StatusMsg (String) Localized description of the error | ||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/doctype/deletedocumenttype HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Name": "xxxx",
"DataType": 1,
"Length": 150,
"Rows": 0
},
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Name": "xxxx,
"DataType": 1,
"Length": 150,
"Rows": 0
},
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Name": "xxxx",
"DataType": 1,
"Length": 150,
"Rows": 0
},
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Name": "xxxx",
"DataType": 1,
"Length": 150,
"Rows": 0
},
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Name": "xxxx",
"DataType": 1,
"Length": 150,
"Rows": 0
},
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Name": "xxxx",
"DataType": 1,
"Length": 150,
"Rows": 0
},
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Name": "xxxx",
"DataType": 1,
"Length": 150,
"Rows": 0
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Add attribute
URL | |
|---|---|
Method | POST |
Parameter | DocumentTypeId (String) The ID of the document type. |
The ID of the attribute. | |
The new name of the attribute. | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/doctype/addattribute HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 110 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentTypeId=XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX&attributeId=XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX&name=xxxxx
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Rename attribute
URL | |
|---|---|
Method | POST |
Parameter | DocumentTypeId (String) The ID of the document type. |
The ID of the attribute. | |
The new name of the attribute. | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/doctype/renameattribute HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 103 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentTypeId=XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX&attributeId=XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX&name=xxxxx
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Delete attribute
URL | |
|---|---|
Method | POST |
Parameter | DocumentTypeId (String) The ID of the document type. |
The ID of the attribute. | |
Return | Status (Integer) see Status codes |
StatusMsg (String) Localized description of the error | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/doctype/removeattribute HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 103 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] documentTypeId=XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX&attributeId=XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Messages
This chapter concludes all message-related functions.
Send
URL | |
|---|---|
Method | POST |
Parameter |
Name of the recipient. Only users from own contact list can be passed. |
Subject line | |
The message content. | |
SID (String) ID of the recipient | |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/message/send HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 82 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] userName=XXXXXX&subject=XXXX&text=XXXX=sid=U-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve number of unread messages
URL | |
|---|---|
Method | POST |
Parameter | none |
Return |
Number of unread messages |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/message/unreadmessagecount HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"UnreadMessages": 5,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve message list
URL | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||
Parameter | none | ||||||||
Return | Items:
| ||||||||
Status (Integer) see Status codes | |||||||||
Details on the status code | |||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/message/listmessages HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"Created": 'Wed,01Mar201716: 14: 19GMT',
"IsRead": True,
"SenderName": "FOXDOX",
"Id": "d7e2d62a-5201-4e05-a118-c74590e68904",
"MessageData": [{
"MessageDataType": 1,
"Value": "f9e0f0a4-d1d7-41eb-a8ba-ac8ec984111e"
}],
"Subject": "\ufeffDocumentshared",
"MessageData":[]
}
{
"Created": "Sun, 13 Dec 2015 18:35:08 GMT",
"Id": "289ec207-5793-42b0-97c1-7619f5dcfbde",
"SenderName": "FOXDOX",
"Subject": "Your contact request was accepted",
"IsRead": false,
"MessageData":[]
},
{
"Created": "Wed, 08 Jul 2015 14:07:31 GMT",
"Id": "a7589d0e-1d04-4d06-bf51-2e927e3980a3",
"SenderName": "FOXDOX",
"Subject": "Document released",
"IsRead": true,
"MessageData":[
{
"Value": "86eae818-65dc-4f54-a74c-0dc22a44c53c",
"MessageDataType": 1,
"DisplayName": "Document.pdf"
}
]
},
{
"Created": "Tue, 14 Jul 2015 15:18:02 GMT",
"Id": "281f900f-f196-40e8-9466-7fc683bb7451",
"SenderName": "FOXDOX",
"Subject": "Document released",
"IsRead": true,
"MessageData":[
{
"Value": "1c0d1278-647d-4221-878d-b5b29d2f8b24",
"MessageDataType": 1,
"DisplayName": "Presentation.pptx"
}
]
},
{
"Created": "Wed, 08 Jul 2015 14:23:34 GMT",
"Id": "c7149e12-51be-49c9-8415-c023c1f4007a",
"SenderName": "FOXDOX",
"Subject": "Document released",
"IsRead": true,
"MessageData":[
{
"Value": "aedfb4df-acb6-458b-96f4-fb3a10937148",
"MessageDataType": 1,
"DisplayName": "Presentation.pptx"
}
]
},
],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve complete message
URL | |||
|---|---|---|---|
Method | POST | ||
Parameter | MessageID (String) ID of the message. | ||
Return |
Date and time, when the message was created. | ||
ID of the message. | |||
Name of the sender. | |||
Subject line | |||
The content of the message. | |||
Flag, if the message was already been read. | |||
The message type (1 = System message, 2 = message of a user) | |||
MessageDate (List)
| |||
Status (Integer) see Status codes | |||
Details on the status code | |||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/message/getmessage HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 41 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] messageId=e933bc11-9197-4d13-a730-b5222a4cc6cc
Answer
{
"Created": "Sun, 13 Dec 2015 18:35:08 GMT",
"Id": "289ec207-5793-42b0-97c1-7619f5dcfbde",
"SenderName": "FOXDOX",
"Subject": "Document received",
"Text": "Example message body.",
"IsRead": false,
"MessageType": 1,
"MessageData":[
{
"Value": "aedfb4df-acb6-458b-96f4-fb3a10937148",
"MessageDataType": 1,
"DisplayName": "Presentation.pptx"
}
]
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Mark as read
URL | |
|---|---|
Method | POST |
Parameter | MessageID (String) ID of the message. |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/message/markasread HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 46 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] messageId=289ec207-5793-42b0-97c1-7619f5dcfbde
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Mark as unread
URL | |
|---|---|
Method | POST |
Parameter | MessageID (String) ID of the message. |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/message/markasunread HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 46 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] messageId=289ec207-5793-42b0-97c1-7619f5dcfbde
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Delete message
URL | |
|---|---|
Method | POST |
Parameter | MessageID (String) ID of the message. |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/message/delete HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 46 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] messageId=289ec207-5793-42b0-97c1-7619f5dcfbde
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Key management
This chapter concludes all functions, which are used for the management of the so called key ring. The key ring is a summary of all cryptographic keys, which are used by a user for his document encryption.
Details
URL | |
|---|---|
Method | POST |
Parameter |
ID of the key |
Return |
ID of the key |
Name of the key. | |
Key password hint | |
Date and time, when the key was created | |
Flag, if this key is the default key. | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/listkeys HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 42 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] KeyId=ac3373f7-2ccb-4d61-8a2c-429154ac5d31
Answer
{
"KeyId": "ac3373f7-2ccb-4d61-8a2c-429154ac5d31",
"Name": "Private key",
"KeyHint": "Hint",
"Created": "Thu, 05 Dec 2013 15:36:35 GMT",
"IsDefaultKey": false,
"Status": 200,
"StatusMsg": "",
"Error": 0
}Change password for key
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the key, which shall be the default key. |
The old password. | |
The new password. | |
Key password hint | |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/changepassword HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 111 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] keyId=0083bcfe-bc08-401e-aa8a-fd077286c96d&oldPassword=password&newPassword=password1keyHint=Password%20Hint
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
List keys
URL | ||||||
|---|---|---|---|---|---|---|
Method | POST | |||||
Parameter | none | |||||
Return | Items:
| |||||
Status (Integer) see Status codes | ||||||
Details on the status code | ||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/listkeys HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"KeyId": "ac3373f7-2ccb-4d61-8a2c-429154ac5d31",
"Name": "Private key",
"KeyHint": "Hint",
"Created": "Thu, 05 Dec 2013 15:36:35 GMT",
"IsDefaultKey": false
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Create key
URL | |
|---|---|
Method | POST |
Parameter |
The name of the new key. The name has to be unique. |
The new password, which protects the key. | |
Key password hint | |
Flag, if this key shall be the default key | |
Return |
ID of the key |
Name of the key. | |
Date and time, when the key was created | |
Flag, if this key is the default key. | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/create HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 71 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] name=key01&password=password&keyHint=Password%20Hint&isDefault=false
Answer
{
"KeyId": "0083bcfe-bc08-401e-aa8a-fd077286c96d",
"Name": "key1",
"KeyHint": "password hint",
"Created": "Wed, 23 Mar 2016 16:02:32 GMT",
"IsDefaultKey": false,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Export public part of a key
There is no token needed for this method.
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the key, for which the public part shall be exported. |
Return |
Base64-coded key |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/exportpublic HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 42 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 keyId=0083bcfe-bc08-401e-aa8a-fd077286c96d
Answer
{
Data":"BgIAAACkAABSU0ExABAAAAEAAQDZ0W9IOxJX5JHc9IYeGpuWtWMKMr2cmjWf9e+adHc1oMLrq0SAJUZosjBqbXPI+ew/Vip7R6rVJ0Fz1KaozqERqnBzhfccOTW+mRU3Fos6R0w1Ut8yg425xeQHxcTH6lJOQDQXDjSU7m2lZSBv8aAYfKh4TeB63QPDQM60k+qfF4vi0UG3yrXlOeLEXfJU3TdmnGif2wCAM3v4+ls/a5JCHnsnX/1wzvgomwpSCmxODpLWvtR9dfNecisAoT/GywFF4xaSUmsOy79TezJS3r+epOCN+4oEyQIFJHeySafLYZIbsyWiHRQSemAfHetVnpTIp0Ve5dIb6SlMyl8eCtyRd5jr29fK779X4Qj1sTyohkA8D33cj4VczyRdW6mSve0fHX3PcnZ3Yxelvd+z9BMr2FDmvEdYhUf7D7y8X6myBY4kRQZmkl6XtRAU52xPiyS/bC9kWO2rRMSda3XPVEVH6lUNHEVbOT+THpjIDv36KrL+4LDlZE+miXkUUO1PC1dcG8xKWtAQ831i7cOpaggPAjAjCib0mN5z/1T9hxM1C7tBvmBpMe5u/OCObYVmmBKqHf8d6h57SYK53d0sdGgn5aLd+jz8j9qUogY05+GyfhC9r6uOgmA2o0mB3Ua3/wjs8J/V2IJjcNwY3BOH1PC77cNLq+kFvKFc/4fBI6u4kw==",
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Export key for recovery
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the key, which shall be exported. |
The password, which protects the key. | |
Return |
Base64-coded key |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/changepassword HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 60 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] keyId=0083bcfe-bc08-401e-aa8a-fd077286c96d&password=password
Answer
{
Data":"BwIAAACkAABSU0EyABAAAAEAAQBHm7Ht4YWZ0HvBbkPKCWW61S4v17bHSCs6PoRVlZzo7qh7y6RiART8uKr63pOZvIzpm7/j978QHOU9en88TN7UV1CH2BeDXDrlH8hZci1641ZzBFllXA/gcfA3vq9VbrZGSHQek1RGjgzwwAvyk7+V7XbY463/kfrXY8Ef/GRhmOHmuQviwTCbRjwiRAY+wqL8P4ABuatiVQ7IJhpER8N5RPouLBHyXYgEW6CISC0eqP9HcESsk7x+gKon6R4gwzcsqRc7YrwBOFO+/f6uDR3wL3GHfsqCmxD0tD7Gs0KSIxRul8YIR2sZumQ4FwY+khDTQPJRK56UZv3ywR7vr1gb5O6DmcE/6qizusLJCgdpPSYiKXxlW2M1qhDBOzTx3qZn6yH36MxIBfFGwo5Fyb7pn7BGWUR/ZU014UrxpIPXry7n9hvH90g68sTSzZDKg7CnPoz5vFw6YDWO+sQN+/9yhKj4Xx5VS+NQFv/GdepQjH11130rRLnwalEerpz6jtEoBTSZgk0LwH5fC6t/fGizoj00IZVw4+Y5VtSLJFYzQX61yOdmlKHfkUhpQ2slOMeXUxWCSBNr8neAnqyGSJXSmri+R5z6tAywzck2plrCqJ5d80899RjlNMFrEln0e2btUWAn1yH/HaqkOYEEIIHzBtyx+QbqlbN3inoiKSxNsxXsfauqWOLoR/hQYXgsa86nouDjk2OYwdaDkZVAS7bc2/9GOFlQUajU5shIljigJnH3j8ao9kdA9JgHaki0P3T6e2I1JaYAsc3BKJnnvol4ntZCo6u17+QRCL7VnMjL7F2BHdtjm/jbNjQYWAF+qbgdlCcGonrXFuqurl+zJtpwuIoZN/ysaPvX/SRSe9goXa6CWEU97eMDQ+3qf0p5GhimkmgyewClaLnGJZDROMYhr39vcLO90e0T+rIFKlwDK2ZFqMswSTrZxw/8KjAWB76ARDSCLVbCDcG3kVHKUJlmYFWWVbWlyVYu6qq++/ZaBKWeBTGhA2mnahl9q8cABr7rVNfCKCKLuvkd3drirLsAxdPk0gtiQk7N7aOhoUtVAXupo+hoMgoj30/QA+cK0H0ND9JVgDW36GA7QZJZagJiMtVsU6eGayE6iZqZSOGbKFy+K6BgTcjVJpnmsEomPk79HuHkh2G6B7T3eN1Be3vk0QaTBb1LGBPDAJC7rtKdAcvU2ZC5/XY60faRRBSU1gohBdjNAhaMmRoDGWbkViIaqoDND9Pueb5YyhMOY54D7QTd/WYAj/wVC4u2j+iXLHxr1IYshb93592lBTmXi9NNZSV5vtlzTz10doYGGsrWDEGsxisoBzqujbScR00GvBUFxanLFqua0Tb9udSLKI7xheTBJkyao6ckxLafKL1RY+OGAMzI7MbvaN1YB0NJoSNx3LhhpaajIc7V71MrNpNWtQ6U+Fsq5+85rrQG1K3NrVOCuGIlzALfiRCpQL6XZEyVXXp6IVQXg9dP2sUdKbAvTezmM1PEXW0aha1VMPIKISzeG07D23ff6FR1SsREQgose7rzfO0qL6QjGS3qzfMB9V38pZsVpWm2BYiQJgD6qwqgOdvbGJ/NX7jcXO8PGTxNOQbqFPgkm9E2nBv01K0O/GExNQzUE/zWaeEKx/ujP0BEHaxLWtiZzSFg5wBVJTj+UQmXSvc9givsX2AwylC0/DHFT9fKkrZPGt6NiF9jWfOHcE59GMHpGG8LUnBRZTPEOpB2V3Cu/HFt8dxjKKXANTG+0cPC63R3/+gKbR32cxZxw5Ej68HPKIrV+m4Tccc8KXhbtf/cjDpIhlHCG0R/gyl0YGr1KzULbxA8DwQHygWT0Cwl40c5mCQc04U5nZfTq7Dd9JTKYSl3Taqkws4u2lbTyB0P0zgzKazCHTdX4oIpmMpgqW6UxwrN97mvIZHqa1KzIJjwhzGxDqK6TJyc7xo7pNuOn4219GQHjmR7ayBnzAaSqx/TWuFLgPzdVsLiS+YnsCMBMnMnG5hb/E014gnwCckE2CIdT5yrVCv7vmQj21dkzlKAoYP+c/psmc5ZFAUtwWXKowWL8HNCPw5mi0uEwZaAsmYG19aFyqL5ucAwqQ05C0b75a20R9KcE4z+1n7X1XEacs1pnfwjaZnb336E7BakMRhYnb3t3m49pWl9GJaU9MZVr6m8/y19md1H9RuaYWskwKqSoK+IHoyjzQiy4meDuDH4Jaz3u8+9Xy8LBCSZftlSX++xyVFTypR07OzU9pK5Gv+M0g8DYVDRR4SIGGw5yt4WGeEgnYoR8uQ750BAWSnQBRDuAVwWEALdCegyVaN9Fi2mTlQO5vLeiW9+Q/367Un+ozHXW8YTBYAAOq2Ek3QWqKwEac4AT5UCraGuWL/nQb/MSleuy3loOVeIBitKkQoGGV4U6XV+wWq7XB0V583xzikwaTNCwsrf6NICLTh+nwpkpabQmp09sPpPA3XgDg0aWFCNW1Je+ZCQ8E2zZeiDjKWZnGyouW0b2U0VrTla9vbxumFfk/y3eVYN11r/IPTaKifspC/MfGM7NU2avhgboRrW3e058UfbJUZTOQrQ0wbGzvk4J6/wg81pQ3OVtchzpSNtdu+HFO3zAKkCL/j3oJzmWaAGRXa4MHtJHL4PeukPVpORlH2K2yso4I144j3Ym0oJ47jsG3we87PPqfWPRCVIy6h7wCBxoxTbNrsxNjCBXhRvNhC50OZ1Uls1Sr+ADbrjrDDW9k2hRJpygZrTosC9ENZJRScFvU2izyQZ9MVJrOijHegbtNK5Pp5FYjocWvn7am0L9vc/T/m0c2/CZa6v1T1HR6RVtk1r+0ozfoKeMT1UvzopUrEb6vR8XnGxSD+VzI2QDbaakJewj7yII0OPeD9z/wTeffg6DaT2tCAKUO/sygtgnouiQOmVP2dpd7Iws86THoNmbHBqdAACV+8aU8KNmdwZoqervopnWbEfF4FaRU5W0ZswUA+pdjAT/W0FRr+SMFzOltHIxilLWhQXl4LqFzi91lerzRe6tJq5czl7CW6xezU+UMFqwc1glA6sbLFZIk2Oen44xgwutMB/Bu+oTzs=",
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Restore/import key
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the key, which shall be imported/exported. |
The new password, which protects the key. | |
Base64-coded key (from key export) | |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/changepassword HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 3172 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] keyId=0083bcfe-bc08-401e-aa8a-fd077286c96d&newPassword=password&keyData=BwIAAACkAABSU0EyABAAAAEAAQBHm7Ht4YWZ0HvBbkPKCWW61S4v17bHSCs6PoRVlZzo7qh7y6RiART8uKr63pOZvIzpm7/j978QHOU9en88TN7UV1CH2BeDXDrlH8hZci1641ZzBFllXA/gcfA3vq9VbrZGSHQek1RGjgzwwAvyk7+V7XbY463/kfrXY8Ef/GRhmOHmuQviwTCbRjwiRAY+wqL8P4ABuatiVQ7IJhpER8N5RPouLBHyXYgEW6CISC0eqP9HcESsk7x+gKon6R4gwzcsqRc7YrwBOFO+/f6uDR3wL3GHfsqCmxD0tD7Gs0KSIxRul8YIR2sZumQ4FwY+khDTQPJRK56UZv3ywR7vr1gb5O6DmcE/6qizusLJCgdpPSYiKXxlW2M1qhDBOzTx3qZn6yH36MxIBfFGwo5Fyb7pn7BGWUR/ZU014UrxpIPXry7n9hvH90g68sTSzZDKg7CnPoz5vFw6YDWO+sQN+/9yhKj4Xx5VS+NQFv/GdepQjH11130rRLnwalEerpz6jtEoBTSZgk0LwH5fC6t/fGizoj00IZVw4+Y5VtSLJFYzQX61yOdmlKHfkUhpQ2slOMeXUxWCSBNr8neAnqyGSJXSmri+R5z6tAywzck2plrCqJ5d80899RjlNMFrEln0e2btUWAn1yH/HaqkOYEEIIHzBtyx+QbqlbN3inoiKSxNsxXsfauqWOLoR/hQYXgsa86nouDjk2OYwdaDkZVAS7bc2/9GOFlQUajU5shIljigJnH3j8ao9kdA9JgHaki0P3T6e2I1JaYAsc3BKJnnvol4ntZCo6u17+QRCL7VnMjL7F2BHdtjm/jbNjQYWAF+qbgdlCcGonrXFuqurl+zJtpwuIoZN/ysaPvX/SRSe9goXa6CWEU97eMDQ+3qf0p5GhimkmgyewClaLnGJZDROMYhr39vcLO90e0T+rIFKlwDK2ZFqMswSTrZxw/8KjAWB76ARDSCLVbCDcG3kVHKUJlmYFWWVbWlyVYu6qq++/ZaBKWeBTGhA2mnahl9q8cABr7rVNfCKCKLuvkd3drirLsAxdPk0gtiQk7N7aOhoUtVAXupo+hoMgoj30/QA+cK0H0ND9JVgDW36GA7QZJZagJiMtVsU6eGayE6iZqZSOGbKFy+K6BgTcjVJpnmsEomPk79HuHkh2G6B7T3eN1Be3vk0QaTBb1LGBPDAJC7rtKdAcvU2ZC5/XY60faRRBSU1gohBdjNAhaMmRoDGWbkViIaqoDND9Pueb5YyhMOY54D7QTd/WYAj/wVC4u2j+iXLHxr1IYshb93592lBTmXi9NNZSV5vtlzTz10doYGGsrWDEGsxisoBzqujbScR00GvBUFxanLFqua0Tb9udSLKI7xheTBJkyao6ckxLafKL1RY+OGAMzI7MbvaN1YB0NJoSNx3LhhpaajIc7V71MrNpNWtQ6U+Fsq5+85rrQG1K3NrVOCuGIlzALfiRCpQL6XZEyVXXp6IVQXg9dP2sUdKbAvTezmM1PEXW0aha1VMPIKISzeG07D23ff6FR1SsREQgose7rzfO0qL6QjGS3qzfMB9V38pZsVpWm2BYiQJgD6qwqgOdvbGJ/NX7jcXO8PGTxNOQbqFPgkm9E2nBv01K0O/GExNQzUE/zWaeEKx/ujP0BEHaxLWtiZzSFg5wBVJTj+UQmXSvc9givsX2AwylC0/DHFT9fKkrZPGt6NiF9jWfOHcE59GMHpGG8LUnBRZTPEOpB2V3Cu/HFt8dxjKKXANTG+0cPC63R3/+gKbR32cxZxw5Ej68HPKIrV+m4Tccc8KXhbtf/cjDpIhlHCG0R/gyl0YGr1KzULbxA8DwQHygWT0Cwl40c5mCQc04U5nZfTq7Dd9JTKYSl3Taqkws4u2lbTyB0P0zgzKazCHTdX4oIpmMpgqW6UxwrN97mvIZHqa1KzIJjwhzGxDqK6TJyc7xo7pNuOn4219GQHjmR7ayBnzAaSqx/TWuFLgPzdVsLiS+YnsCMBMnMnG5hb/E014gnwCckE2CIdT5yrVCv7vmQj21dkzlKAoYP+c/psmc5ZFAUtwWXKowWL8HNCPw5mi0uEwZaAsmYG19aFyqL5ucAwqQ05C0b75a20R9KcE4z+1n7X1XEacs1pnfwjaZnb336E7BakMRhYnb3t3m49pWl9GJaU9MZVr6m8/y19md1H9RuaYWskwKqSoK+IHoyjzQiy4meDuDH4Jaz3u8+9Xy8LBCSZftlSX++xyVFTypR07OzU9pK5Gv+M0g8DYVDRR4SIGGw5yt4WGeEgnYoR8uQ750BAWSnQBRDuAVwWEALdCegyVaN9Fi2mTlQO5vLeiW9+Q/367Un+ozHXW8YTBYAAOq2Ek3QWqKwEac4AT5UCraGuWL/nQb/MSleuy3loOVeIBitKkQoGGV4U6XV+wWq7XB0V583xzikwaTNCwsrf6NICLTh+nwpkpabQmp09sPpPA3XgDg0aWFCNW1Je+ZCQ8E2zZeiDjKWZnGyouW0b2U0VrTla9vbxumFfk/y3eVYN11r/IPTaKifspC/MfGM7NU2avhgboRrW3e058UfbJUZTOQrQ0wbGzvk4J6/wg81pQ3OVtchzpSNtdu+HFO3zAKkCL/j3oJzmWaAGRXa4MHtJHL4PeukPVpORlH2K2yso4I144j3Ym0oJ47jsG3we87PPqfWPRCVIy6h7wCBxoxTbNrsxNjCBXhRvNhC50OZ1Uls1Sr+ADbrjrDDW9k2hRJpygZrTosC9ENZJRScFvU2izyQZ9MVJrOijHegbtNK5Pp5FYjocWvn7am0L9vc/T/m0c2/CZa6v1T1HR6RVtk1r+0ozfoKeMT1UvzopUrEb6vR8XnGxSD+VzI2QDbaakJewj7yII0OPeD9z/wTeffg6DaT2tCAKUO/sygtgnouiQOmVP2dpd7Iws86THoNmbHBqdAACV+8aU8KNmdwZoqervopnWbEfF4FaRU5W0ZswUA+pdjAT/W0FRr+SMFzOltHIxilLWhQXl4LqFzi91lerzRe6tJq5czl7CW6xezU+UMFqwc1glA6sbLFZIk2Oen44xgwutMB/Bu+oTzs=
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Delete key
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the key, which shall be deleted. |
The password, which protects the key. | |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/delete HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 60 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] keyId=0083bcfe-bc08-401e-aa8a-fd077286c96d&password=password
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Rename key
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the key, which shall be renamed. |
The name of the new key. The name has to be unique. | |
The new password, which protects the key. | |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/rename HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 71 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] name=key01&password=password&keyId=0083bcfe-bc08-401e-aa8a-fd077286c96d
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Change default key
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the key, which shall be the default key. |
The new password, which protects the key. | |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/keyring/setdefault HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 60 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] keyId=0083bcfe-bc08-401e-aa8a-fd077286c96d&password=password
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Document-Service-Provider
Here, all function are summarized, which allow the interaction with document-service-provider.
Send document
URL | |
|---|---|
Method | POST |
Parameter |
Short name of the provider (recipient) |
Unique service key (context) | |
Key, which identifies the user on the provider-side | |
The ID of the document. | |
The filled form. | |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/senddocument HTTP/1.1
Host: api.foxdox.de
Connection: keep-alive
Content-Length: 140
Content-Type: application/x-www-form-urlencoded
X-DEVID: [...]
X-APPID: [...]
X-LANG: de
X-APPVER: 0.1
X-TOKEN: [...]
providerShortName=FOXDOX.link&providerSpecificUserId=100&documentId=ba60ab40-e411-4031-a119-7f749af2c10d&formular={}&serviceKey=Sd4kd2qaAnswer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve details for a service
URL | ||||||||
|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||
Parameter | providerServiceKey (String) This service key is used to interact with the service (subscribe service, cancel, etc.) | |||||||
Return |
The ID of the service | |||||||
Creation date of the service | ||||||||
Name of the service | ||||||||
Description of the service | ||||||||
The key of the service | ||||||||
The hidden-flag of the service | ||||||||
The describing tags of the service | ||||||||
| ||||||||
TemplateDelivery (Object):
| ||||||||
Defines, if inbound requests will be accepted automatically | ||||||||
Defines, if the service blocks requests after x failed attempts of a user | ||||||||
Defines, if the service is permitted by FOXDOX | ||||||||
Specifies, how often a user can be declined before his requests will be blocked. | ||||||||
Defines, if the service is permitted by FOXDOX | ||||||||
Defines, if document delivery jobs shall be started and processed immediately. | ||||||||
Defines, if the service delivers documents encrypted. | ||||||||
Defines, if the provider can receive via the respective service documents of his subscribers | ||||||||
Defines, if the provider can send via the respective service documents to his subscribers | ||||||||
The default comment, which will be replaced by the request manager during accepting of a service subscription. | ||||||||
The default comment, which will be replaced by the request manager during declining of a service subscription. | ||||||||
Status (Integer) see Status codes | ||||||||
Details on the status code | ||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/servicedetails HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 27 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] providerServiceKey=nhZX4GH9
Answer
{
"Id": "7fbfecf7-9c14-490d-8a7a-4132cd19d3ce",
"Created": "13.02.2014 10:52:24",
"Name": "Payslips",
"Description": "Delivery of the payslips",
"ServiceKey": "nhZX4GH9",
"Hidden": false,
"Tags": null,
"Template": {
"Fields": [{
"Name": "Pers-Nr.",
"Description": "Personal number",
"FieldType": 1,
"RegEx": null,
"RegExErrorMessage": null,
"IsKey": true,
"Status": 200,
"StatusMsg": "",
"Error": 0
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
},
"TemplateDelivery": {
"Fields": [],
"Status": 200,
"StatusMsg": "",
"Error": 0
},
"ImmediatelyAccept": false,
"BlockSubscriptions": false,
"DeclineLimit": 0,
"Permitted": true,
"ImmediatelyStartJobs": false,
"DeliverEncrypted": false,
"DocumentOutboxEnabled": false,
"DocumentInboxEnabled": false,
"DefaultCommentSubscriptionAccept": "",
"DefaultCommentSubscriptionDecline": "",
"Status": 200,
"StatusMsg": "",
"Error": 0
}Find service
URL | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||||||||||||||||||
Parameter |
| ||||||||||||||||||||||||||||||||
Return | Items:
| ||||||||||||||||||||||||||||||||
Status (Integer) see Status codes | |||||||||||||||||||||||||||||||||
Details on the status code | |||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/find HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 4 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] keywords=__my
Answer
"Items": [{
"ProviderLevel": 0,
"ProviderShortName": "FOXDOX",
"ProviderName": null,
"ProviderEmailAddress": "support@foxdox.de",
"ProviderWebsiteUrl": "http://www.foxdox.de",
"ProviderPhoneNumber": null,
"ProviderIconUrl": "https://brand01.foxdox.de/global/providerlogo/foxdox_logo.png",
"ProviderAbout": null,
"ProviderAddress": null,
"ProviderCity": null,
"ProviderZipCode": null,
"ProviderProvince": null,
"ProviderCountry": null,
"ProviderIsSystemDefault": true,
"ServiceName": "FOXDOX invoices",
"ServiceDescription": "",
"ServiceKey": "lglCiORs",
"ServiceLevel": 0,
"ServiceImmediatelyAccept": false,
"SubscriptionState": 2,
"Subscriptions": [{
"Id": "7363b7a4-9cbf-431d-824e-99673152b237",
"Date": "Tue, 10 Feb 2015 12:53:41 GMT",
"State": 2,
"ProviderSpecificUserId": "U-22418a6e-e700-48f2-b372-5bc8d59b88c4"
}],
"ServiceBlockSubscriptions": false,
"ServiceDeclineLimit": 0,
"ServiceDeliverEncrypted": false,
"ServiceDocumentOutboxEnabled": true,
"ServiceDocumentInboxEnabled": false,
"ServiceDefaultCommentSubscriptionAccept": "",
"ServiceDefaultCommentSubscriptionDecline": ""
}],
"Status": 200,
"StatusMsg": "",
"Error": 0Service quick subscription
A quick subscription can only be executed, if a respective service key is provided by the business process provider.
URL | |
|---|---|
Method | POST |
Parameter | subscriptionKey (String) Service key |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/quicksubscription HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 35 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] subscriptionKey=8700-1f02-6b5b-33d3
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
} Retrieve information on service quick subscription
URL | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | |||||||||||||||||||||||||||||||
Parameter | subscriptionKey (String) Service key | |||||||||||||||||||||||||||||||
Return |
User ID, which the business process provider has intended for this quick subscription. | |||||||||||||||||||||||||||||||
Items:
| ||||||||||||||||||||||||||||||||
Status (Integer) see Status codes | ||||||||||||||||||||||||||||||||
Details on the status code | ||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/quicksubscriptioninfo HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 35 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] subscriptionKey=ab0c-e010-060e-9a89
Answer
{
"ProviderSpecificUserId": "2016_05_27_09",
"Items": [{
"ProviderLevel": 0,
"ProviderShortName": "FOXDOX.link",
"ProviderName": "FOXDOX.link",
"ProviderEmailAddress": "info@ambifox.de",
"ProviderWebsiteUrl": "",
"ProviderPhoneNumber": "01234-56789",
"ProviderIconUrl": "https://apibeta.foxdox.de/content/img/ambifox.png",
"ProviderAbout": "FOXLINK Test-Provider",
"ProviderAddress": "Fleehook 1",
"ProviderCity": "Ahaus",
"ProviderZipCode": "48683",
"ProviderProvince": "NRW",
"ProviderCountry": "276",
"ProviderIsSystemDefault": false,
"ServiceName": "Test-Service1",
"ServiceDescription": "Test1",
"ServiceKey": "Sd4kd2qa",
"ServiceLevel": 0,
"ServiceImmediatelyAccept": true,
"SubscriptionState": 5,
"Subscriptions": [{
"Id": "bf31dc2c-1cdf-4525-bf77-c6f81321abbb",
"Date": "Fri, 27 May 2016 14:14:36 GMT",
"State": 5,
"ProviderSpecificUserId": "2016_05_27_10"
}],
"ServiceBlockSubscriptions": true,
"ServiceDeclineLimit": 3,
"ServiceDeliverEncrypted": false,
"ServiceDocumentOutboxEnabled": true,
"ServiceDocumentInboxEnabled": true,
"ServiceDefaultCommentSubscriptionAccept": "",
"ServiceDefaultCommentSubscriptionDecline": ""
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Request service subscription - existing branch
This allows to react to an existing (pending) subscription request. For example: A user requests a service and was declined by the provider, he can re-request with this call without opening a new request branch.
URL | |
|---|---|
Method | POST |
Parameter |
The ID of the service request |
The form data in JSON-format. A JSON-document is sent, where each form field of the services in the JSON-document must be contained with value. If e.g. the values "First name" and "Last name" are specified as text fields for a service as form, then the request form for Max Mustermann looks like this:
| |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/rerequestservicesubscription HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 105 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] providerServiceSubscriptionId=dc084d25-2d0d-43f3-a235-0baad9754c8b&formular=%7B+++%22Firstname%22%3A+%22Max%22%2C+++%22Lastname%22%3A+%22Mustermann%22+%7D
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Request service subscription (new branch)
Creates a new request for a service subscription. All previous requests for this service will be disregarded, so that e.g. a multi-subscription is possible.
URL | |
|---|---|
Method | POST |
Parameter |
Short name of the provider |
Unique service key | |
The form data in JSON-format. A JSON-document is sent, where each form field of the services in the JSON-document must be contained with value. If e.g. the values "First name" and "Last name" are specified as text fields for a service as form, then the request form for Max Mustermann looks like this:
| |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/requestservicesubscription HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 136 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] serviceKey=nhZX4GH9&providerShortName=FOXDOX+Messe&formular=%7B+++%22Firstname%22%3A+%22Max%22%2C+++%22Lastname%22%3A+%22Mustermann%22+%7D
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Cancel service subscription
URL | |
|---|---|
Method | POST |
Parameter |
Short name of the provider |
Unique service key | |
Key, which identifies the user on the provider-side | |
A comment | |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/resignservicesubscription HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 97 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] serviceKey=Sd4kd2qa&providerShortName=FOXDOX.link&providerSpecificUserId=2016_05_27_10&comment=ok
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}List services of a provider
URL | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||||||||||||||||||
Parameter | providerShortName (String) The short name of the document provider | ||||||||||||||||||||||||||||||||
Return | Items:
| ||||||||||||||||||||||||||||||||
Status (Integer) see Status codes | |||||||||||||||||||||||||||||||||
Details on the status code | |||||||||||||||||||||||||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/listservices HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 30 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] providerShortName=FOXDOX+Messe
Answer
{
"Items": [{
"ProviderLevel": 0,
"ProviderShortName": "FOXDOX Messe",
"ProviderName": "d.velop business services GmbH",
"ProviderEmailAddress": "post@foxdox.de",
"ProviderWebsiteUrl": "",
"ProviderPhoneNumber": "",
"ProviderIconUrl": null,
"ProviderAbout": "The FOXDOX Messe provider is used for demo- and presentation purposes",
"ProviderAddress": "Schildarpstrasse 6-8",
"providerCity": "Gescher",
"ProviderZipCode": "48712",
"ProviderProvince": "NRW",
"ProviderCountry": "276",
"ProviderIsSystemDefault": false,
"ServiceName": "Payslips",
"ServiceDescription": "Delivery of the payslips",
"ServiceKey": "nhZX4GH9",
"ServiceLevel": 0,
"ServgiceImmediatelyAccept": false,
"SubscriptionState": 2,
"Subscriptions": [{
"Id": "b27a1c02-7043-4e89-b126-0cc1566e2065",
"Date": "Tue, 22 Sep 2015 07:42:20 GMT",
"State": 2,
"ProviderSpecificUserId": "4444"
},
{
"Id": "c11aa817-4e8b-4073-a266-435f073822d6",
"Date": "Tue, 22 Sep 2015 07:44:22 GMT",
"State": 2,
"ProviderSpecificUserId": "555"
},
{
"Id": "034cac89-67d0-4db5-b151-55571c6284ee",
"Date": "Tue, 22 Sep 2015 07:39:19 GMT",
"State": 2,
"ProviderSpecificUserId": "123456"
},
{
"Id": "56e72e93-c749-4b68-b8f6-8e31d9a99ddd",
"Date": "Tue, 15 Sep 2015 13:25:42 GMT",
"State": 1,
"ProviderSpecificUserId": null
}],
"ServiceBlockSubscriptions": false,
"ServiceDeclineLimit": 0,
"ServiceDeliverEncrypted": false,
"ServiceDocumentOutboxEnabled": false,
"ServiceDocumentInboxEnabled": false,
"ServiceDefaultCommentSubscriptionAccept": "",
"ServiceDefaultCommentSubscriptionDecline": ""
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
List provider
URL | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||
Parameter | none | ||||||||||||||
Return | Items:
| ||||||||||||||
Status (Integer) see Status codes | |||||||||||||||
Details on the status code | |||||||||||||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/provider/listproviders HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"ProviderLevel": 0,
"ProviderShortName": "FOXDOX Messe",
"ProviderName": "d.velop business services GmbH",
"EmailAddress": "post@foxdox.de",
"WebsiteUrl": "",
"PhoneNumber": "",
"IconUrl": "",
"About": "The FOXDOX Messe provider is used for demo- and presentation purposes",
"Address": "Schildarpstrasse 6-8",
"City": "Gescher",
"ZipCode": "48712",
"Province": "NRW",
"Country": "276",
"ParentId": null,
"IsSystemDefault": false
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Terms and Conditions of Service, Privacy Policy, imprint
Here, all functions are summarized, which allow the user to read and accept Terms and Conditions of Service. Terms and Conditions of Service and Privacy Policy are named in the following TAC and PP.
Show current Privacy Policy
URL | |
|---|---|
Method | POST |
Parameter | none |
Return |
Date, since when the PP is valid. |
Unique ID | |
Text of the explanation | |
Flag, if the text is HTML-formatted. If | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/showpp HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Date": "\/Date(1447113600000)\/",
"TextIsHtml": true,
"Text": "XXXXXX",
"Status": 200,
"StatusMsg": "",
"Error": 0
}Show current business TAC
URL | |
|---|---|
Method | POST |
Parameter | none |
Return |
Date, since when the TAC is valid. |
Unique ID | |
Text of the TAC | |
Flag, if the text is HTML-formatted. If False, then it is plain text. | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/showbusinesstac HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Id": "4aaabeba-e2ad-4904-8620-88e989ef0343",
"Date": "/Date(1438380000000)/",
"TextIsHtml": true,
"Text": "xxxx",
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Show current TAC
URL | |
|---|---|
Method | POST |
Parameter | none |
Return |
Date, since when the TAC is valid. |
Unique ID | |
Text of the TAC | |
Flag, if the text is HTML-formatted. If False, then it is plain text. | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/showtac HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Date": "\/Date(1431388800000)\/",
"TextIsHtml": true,
"Text": "xxxx",
"Status": 200,
"StatusMsg": "",
"Error": 0
}Accept Privacy Policy
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/acceptpp HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Send PP to e-mail adress
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/sendpp HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Show history of Privacy Policy
URL | |||||
|---|---|---|---|---|---|
Method | POST | ||||
Parameter | none | ||||
Return | Items:
| ||||
Status (Integer) see Status codes | |||||
Details on the status code | |||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/listpphistory HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"Id": "bd486a7b-09f3-4f75-a592-c99e308bae39",
"Date": "\/Date(1447113600000)\/",
"TextIsHtml": true,
"Text": ""
},
{
"Id": "1981e85d-25da-43ec-93ed-325cce5186a5",
"Date": "\/Date(1386288000000)\/",
"TextIsHtml": true,
"Text": ""
},
{
"Id": "5d0d43a8-1695-4d00-9089-e5849b0d03a1",
"Date": "\/Date(1359936000000)\/",
"TextIsHtml": true,
"Text": ""
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Show history of TAC
URL | |||||
|---|---|---|---|---|---|
Method | POST | ||||
Parameter | none | ||||
Return | Items:
| ||||
Status (Integer) see Status codes | |||||
Details on the status code | |||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/listtachistory HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"Id": "27ade4ce-264f-47d8-b15f-d7dd04567c62",
"Date": "\/Date(1431388800000)\/",
"TextIsHtml": true,
"Text": ""
},
{
"Id": "11adf4a3-9aa5-4f57-b5ec-3402b61a3b78",
"Date": "\/Date(1386284400000)\/",
"TextIsHtml": true,
"Text": ""
},
{
"Id": "49126160-0086-4430-a149-07156299478a",
"Date": "\/Date(1360018800000)\/",
"TextIsHtml": true,
"Text": ""
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}Show history of business TAC
URL | |||||
|---|---|---|---|---|---|
Method | POST | ||||
Parameter | none | ||||
Return | Items:
| ||||
Status (Integer) see Status codes | |||||
Details on the status code | |||||
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/listbusinesstachistory HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Items": [{
"Id": "4aaabeba-e2ad-4904-8620-88e989ef0343",
"Date": "\/Date(1438380000000)\/",
"TextIsHtml": true,
"Text": ""
}],
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve imprint
URL | |
|---|---|
Method | POST |
Parameter | none |
Return |
The actual text |
Flag, if the text is HTML-formatted. If | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/imprint HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Language": "de",
"Text": "",
"TextIsHtml": true,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Retrieve description of services
URL | |
|---|---|
Method | POST |
Parameter | none |
Return |
The actual text |
Flag, if the text is HTML-formatted. If | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/servicedescription HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Language": "de",
"Text": "",
"TextIsHtml": true,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Accept the Terms and Conditions of Service
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/accepttac HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Send TAC to e-mail address
URL | |
|---|---|
Method | POST |
Parameter | none |
Return | Status (Integer) see Status codes |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/sendtac HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Status": 200,
"StatusMsg": "",
"Error": 0
}Retrieve consumer information
URL | |
|---|---|
Method | POST |
Parameter | none |
Return |
Language in which the text is returned |
The actual text | |
Flag, if the text is HTML-formatted. If | |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/legal/customerinformation HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 0 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...]
Answer
{
"Language": "de",
"Text": "",
"TextIsHtml": true,
"Status": 200,
"StatusMsg": "",
"Error": 0
}
Document import
Here, all functions are summarized, which allow the user to import documents from FOXDOX or other sources into the own repository.
Import public document from FOXDOX
URL | |
|---|---|
Method | POST |
Parameter |
ID of the public document |
ID of the own folder into which the document is to be imported. | |
Return |
The ID of the new document. |
Status (Integer) see Status codes | |
Details on the status code | |
Error (Integer) see Error codes |
Request
POST https://api.foxdox.de/import/frompublicdoc HTTP/1.1 Host: api.foxdox.de Connection: keep-alive Content-Length: 85 Content-Type: application/x-www-form-urlencoded X-DEVID: [...] X-APPID: [...] X-LANG: de X-APPVER: 0.1 X-TOKEN: [...] id=5044ae9c-8a00-4064-a118-4114937bdf28&folderid=f5ceef26-555f-4085-bbb0-9343fdae294a
Answer
{
"DocumentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Status": 200,
"StatusMsg": "",
"Error": 0
}