API information format

The format of the IBM i API information includes sections such as parameters, authorities and locks, required parameter group, format, field descriptions, and error messages.

API description
For most APIs, the description information contains similar sections.
API format
The format section in the API information shows the type of information to be returned by an API.
API field descriptions
The field descriptions section in the API information describes the fields in each API format.
API error messages
The error messages section in the API information lists the error messages for each API.
Extracting a field from the format
You can determine from the API format section where the field that you want to extract is located within the receiver variable.
Processing lists that contain data structures
Some API formats contain a list where each entry in the list is a data structure.

Parent topic: API concepts

Related concepts

APIs for the program-based environment
APIs for the service-program-based environment
Receiver variables

Related reference

API naming conventions