The /admin/getdoc API call is used to retrieve a document from the documentation database.
This is a Private API call and requires an apikey.
| Data | Description |
|---|---|
| apikey | The API Key from the /account/login API |
| languageid | The ID of the language that the document is in. Currently, only "1" (English) is accepted. |
| key | The key for the requested document. |
| docversion | This optional parameter specifies the version of the document to be retrieved. |
| Data | Description |
|---|---|
| success | This value indicates whether or not the call succeeded. A value of "false" indicates that there will be no other data. |
| doc | a docItem object |
| Data | Description |
|---|---|
| languageid | The ID of the language that the document is in. Currently, only "1" (English) is in use. |
| keyname | The key for the retrieved document. |
| version | The version of the retrieved document. |
| title | The title of the retrieved document. |
| data | The encoded data of the retrieved document. |
| id | The unique ID of the retrievedy document. |
None.