Class GetStatus

  • All Implemented Interfaces:
    RestReadView<AccountResource>, RestView<AccountResource>

    public class GetStatus
    extends Object
    implements RestReadView<AccountResource>
    REST endpoint to get the status of an account.

    This REST endpoint handles GET /accounts/<account-identifier>/status requests.

    The account status is a free-form text that a user can set for the own account (e.g. the 'OOO' string is often used to signal that the user is out-of-office).

    • Constructor Detail

      • GetStatus

        public GetStatus()
    • Method Detail

      • apply

        public Response<String> apply​(AccountResource rsrc)
        Description copied from interface: RestReadView
        Process the view operation by reading from the resource.

        The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

        The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).

        Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

        Specified by:
        apply in interface RestReadView<AccountResource>
        Parameters:
        rsrc - resource to read
        Returns:
        response to return to the client