About documentation

Documentation Structure

This API documentation consists of:

• API overview section providing an overview of key concepts that clarify important topics, such as API purpose, nomenclature, request format, methods, possible responses, endpoints and objects specification, parameters and attribute’s properties.
• Sections describing endpoints related to individual objects and Fudo Enterprise functionalities.

Conventions and symbols

This documentation is written using the following conventions:

• italic - this formatting is used to mark user interface elements.
• example - this formatting is used to write example value of a parameter, API method name or code example.
• Note field:

Note

Note field usually contains additional information closely related with described topic, e.g. suggestion concerning given procedure step; additional conditions which have to be met.

• Warning field:

Warning

Warning field usually contains essential information concerning system’s operation. Not adhering to this information may have irreversible consequences.

Disclaimer

All trademarks, product names, and company names or logos cited in this document are the property of their respective owners and are used for information purpose only.