NAME

Apache2::REST::Response - Container for an API Response.

SYNOPSIS

 ... 
 $resp->status(Apache2::Const::HTTP_OK) ;
 $resp->message('Everything went smootly') ;
 $resp->data()->{'item'} = 'This is the returned item' ;
 ...

new

Builds a new one.

cleanup

Cleanup this response so it can go out without any empty attributes.

Internal use.

status

Get/Sets the HTTP status of this response

message

Get/Sets a more explicit message related to the status

data

Hash of the actual data returned by the handler (see Apache2::REST::Handler ).

bin

Get/Set the binary content to return in case the bin writer is used.

binMimeType

Get/Set the MIME type of the binary content.

stream

Get/Set the Apache2::REST::Stream to render this response as a stream of data.

Setting this will trigger a '_Stream' version of writers to be used.

multipart_stream

Get/Set the Apache2::REST::Stream to render this response as a stream of data composed of multipart response parts.

Setting this will trigger a '_multipart' version of writers to be used.