Structure of an Example
Under a descriptive title, each example comprises the following sections:
- Objective
-
When you would use the example.
- Prerequisites
-
What conditions have to exist for the example to work.
- REST URL
-
What is the REST URL to pass the REST API.
- Components
-
Which objects and methods are used in the example, and what the input variables represent.
- Sample Input XML
-
The input code sample.
- Implementation
-
Notes on implementing the example, including what modifications might be necessary to implement it.
- See Also
-
Related examples