...
API calls that utilize results paging denote this in their documentation.
Standard Body by Status
In addition to the basic Content-Type, certain status codes have a standard payload or body format. This allows a higher degree of code reuse and simplified handling of the various data types within NetMRI.
102 Processing: The standard payload for this status indicates the progress of the processing, if available. If unavailable (i.e., how much processing has been completed is unknown), the “total” field will not be present, and the “done” field may or may not be present. Specific calls may add an additional payload.
| Description | JSON | XML |
|---|---|---|
| Format | {"total": <total toprocess>,"done": <done so far>} | <?xml version="1.0" encoding="UTF-8"?><response><total>total to process</total><done>done so far</done></response> |
| Example (Known) | {"total": 50123,"done": 10456} | <?xml version="1.0" encoding="UTF-8"?><response><total>50123</total><done>10456</done></response> |
| Example (Unknown) | {"done": 134} | <?xml version="1.0" encoding="UTF-8"?><response><done>134</done></response> |
| Example (Unknown) | {} | <?xml version="1.0" encoding="UTF-8"?><response/> |