Share via

3.1.4.1.8.2 JSON Response Structure

  • Article

The JSON response structure consists of UTF-8 text in JSON format. It represents a response from a ProcessQuery request message, as specified section 3.1.4.1. The top-level JSON value MUST be a JSON array.

A JSON response structure MUST have at least one element, which is the response header, followed by a "0" (zero), and one or more actionId and actionResponse value pairs. These values MUST correspond to the CSOM actions that were executed and resulted in a response.

The following table lists the elements in a response JSON array.

Index

Name

Description

0

responseHeader

A response header JSON value, as specified in section 3.1.4.1.8.1.5.

i + 1

actionIdi

A JSON number that identifies the CSOM action that the actionResponsei applies to.

i + 2

actionResponsei

An ActionResponseType result, as specified in section 3.1.4.1.8.2.1, that results from the protocol server executing the CSOM action specified by the actionIdi element.