LXI Pending Details Schema

The LXI Pending Details schema provides detailed explanation from the server regarding HTTP operations that return an HTTP status of 202. The HTTP status of 202 indicates that the operation is pending.

RULE: Schema-valid XML responses, as defined by this schema, shall be returned by devices to indicate pending operations.

OBSERVATION: Other sections of this specification require that devices return the LXIPendingDetails whenever an LXI API method returns a status of 202.

This schema specifies the XML namespace:

http://lxistandard.org/schemas/LXIPendingDetails/0.9, version: 0.9
Editorial date:

LXIPendingDetails

The LXI PendingDetails element contains the details related to why an operation is pending and permits the client to determine when it is completed.

The LXIPendingDetails complex type has no attributes

Sub-elements

The following must occur in this order:

ElementTypeCardinalityRequirements
URLxs:anyURI Required

URL provides a URL at which the client can perform a GET to determine the status of the pending operation.

RULE: URL shall be included.

OBSERVATION: When querying the URL the client will either receive another operation pending response with another instance of this XML or a status of OK that indicates the operation is complete.

UserActionRequiredxs:boolean Required

UserActionRequired indicates if the operation is blocked waiting for a user action. For instance, a front panel operation or a device reboot.

EstimatedTimeToCompletexs:integer Optional

EstimatedTimeToComplete indicates the amount of time in seconds to complete the operation.

EstimatedTimeToComplete shall be included if @UserActionRequired is false.

EstimatedTimeToComplete shall be omitted if the device is awaiting a user action and the device does not know when it will occur.

Detailsxs:string Optional

Details provides an explanation of the operation that is pending, or why it is pending.