Overview

Namespaces

  • Genetsis
    • core
      • activityid
      • user
  • None

Classes

  • Address
  • ContextType
  • Device
  • Location
  • ObjectType
  • Position
  • QualityType
  • Request
  • Response
  • SocialNetwork
  • Verbs
  • Overview
  • Namespace
  • Class

Class Response

The resulting object is based on the Result property defined in the Result section of the Activity Streams Schema.

Namespace: Genetsis\core\activityid
Package: Genetsis
Category: Bean
Version: 1.0
Located at core/activityid/Response.php
Methods summary
public mixed
# getStatus( )

Returns the response Status.

Returns the response Status.

Returns

mixed
An integer (201) whether request result is Ok another code otherwise.
public
# setStatus( integer $code )

Sets the response response code.

Sets the response response code.

Parameters

$code
response code.
public mixed
# getErrorMessage( )

Returns the response Error Message.

Returns the response Error Message.

Returns

mixed
An string whether error code!=201 NULL otherwise.
public
# setErrorMessage( string $message )

Sets the response error message.

Sets the response error message.

Parameters

$message
error message.
public mixed
# getErrorReason( )

Returns the request Error Reason.

Returns the request Error Reason.

Returns

mixed
An string whether error code!=201 NULL otherwise.
public
# setErrorReason( string $reason )

Sets the response error reason.

Sets the response error reason.

Parameters

$reason
error reason.
public mixed
# getObjectId( )

Returns the response object id.

Returns the response object id.

Returns

mixed
An string whether error code!=201 NULL otherwise.
public
# setObjectId( string $obj_id )

Sets the response object id.

Sets the response object id.

Parameters

$obj_id
object id.
Constants summary
integer RESPONSE_SUCCESS

SUCCESS: The activity was successful created

SUCCESS: The activity was successful created

# 201
integer RESPONSE_BAD_REQUEST

ERROR: Bad Request: The request could not be understood by the server due to malformed syntax.

ERROR: Bad Request: The request could not be understood by the server due to malformed syntax.

# 400
integer RESPONSE_AUTH_REQUIRE

AUTH ERROR: Non authenticated user

AUTH ERROR: Non authenticated user

# 401
integer RESPONSE_NOT_FOUND

NOT FOUND: Resource not found in server

NOT FOUND: Resource not found in server

# 404
integer RESPONSE_CONFLICT

ERROR: Conflict: The request could not be completed due to a conflict with the current state of the resource

ERROR: Conflict: The request could not be completed due to a conflict with the current state of the resource

# 409
integer RESPONSE_VALIDATION_ERROR

ERROR: Precondition failed: Business validation error

ERROR: Precondition failed: Business validation error

# 412
integer RESPONSE_INTERNAL_ERROR

ERROR: Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request

ERROR: Internal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request

# 500
API documentation generated by ApiGen