Response #

The Response Payload is a standardized response sent by Kuzzle in JSON format.

Property	Type	Description
`controller`	string	API controller name
`action`	string	API action name
`index`	string	Index name
`collection`	string	Collection name
`_id`	string	Document unique identifier
`error`	ErrorPayload	API error
`node`	string	Unique identifier of the node who processed the request
`result`	any	API action result
`status`	number	HTTP status code
`requestId`	string	KuzzleRequest unique identifier
`volatile`	object	KuzzleRequest volatile data
`room`	string	Room unique identifier

See also the ResponsePayload framework type.