Documentation Format and Conventions
- Bettina Borces
Owned by Bettina Borces
| Topic | Documentation Format and Conventions | Example |
|---|---|---|
| Input Limits | Input limits such as the minimum and maximum number of records one can request are indicated with "[n...nnn]". | In the Web Service "PwsGetClient", the minimum client records (PwsClientRef) that can be requested is 1 and the maximum is 100. This is indicated with the notation "[1..100]". |
| Errors and Warnings | In the "Errors and Warnings" section of the web service documentation, only the most common errors and warnings for that web service are listed. Additional Errors and Warnings are listed here: Complete List of Errors and Warnings | |
| Maximum Length Limits for String Data Types | Maximum length limits for string data types are indicated with "(nnn)". | ClientName: String (50) |