API Response Object

The OrchestraCMS APIs return an APIResponse Object whose responseObject property depends on the API used. Some APIResponse Object classes depend on others. We recommend deploying all classes as part of your API supported solution.

JSONMessage

The JSONMessage object is the core APIResponse that is returned from OrchestraCMS when using Apex . The responseObject property will be a JSON encoded string of the API specific object(s) returned. The other properties remain the same across all API requests.

JSONMessage Properties

• type : String, The type of response being sent. This will indicate the type of the object returned in responseObject. Possible types include:
  • ContentBundle
  • FilteringBundle
  • ProfileBundle
  • RenderResultBundle
  • SiteBundle
  • TaxonomyBundle
  • TargetBundle
• timeNow : DateTime, The system time when the response was created.
• isSuccess : Boolean, Whether or not the request was successful. If this is returned as false, the API error field will contain an MessageError object with details about the error.
• message : String, Success message indicating what operation succeeded.
• responseObject : String, Object returned by the call. Possible object types:
  • ContentBundle
  • FilteringBundle
  • ProfileBundle
  • RenderResultBundle
  • SiteBundle
  • TaxonomyBundle
  • TargetBundle
• transactionId : String, The value specified for this field in the corresponding API request.
• error : MessageError, If an API request fails, the APIResponse will be returned with the error field containing a MessageError object.  For more information see MessageError Properties below.
• moreResults : Boolean, Whether there are more results with the API request.

MessageError Properties

The JSONMessage object references an object of type MessageError. The following properties define this object.

• type : String, Error type.
• trace : String, Stack trace if an exception was thrown.
• message : String, Error message.