.. _feature_service:

Feature Service
=============

The feature service provides endpoints to obtain information about
certain guest-facing features; e.g. account lookup, campaigns, etc.

.. contents:: Topics

Endpoints
---------

Is Feature Enabled
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. http:get:: feature/featureIsEnabled.json

   Used to determine whether a particular feature is enabled for a specific merchant.

   The following authentication methods are allowed for this endpoint:

   * :ref:`b2b_auth`

   :query Integer merchantId: *(required)* Paytronix-assigned merchant ID to perform the operation in.
   :query String feature: *(required)* The name of the feature in question.

.. http:response:: success

   :jsonparam String result: *(required)* ``success``
   :jsonparam String feature: *(required)* The name of the feature in question.
   :jsonparam Boolean isEnabled: *(required)* Whether the feature is enabled for the merchant id provided.

   For example:

   .. code:: javascript

       {
           "result": "success",
           "feature": "example",
           "isEnabled": true
       }

.. http:response:: failure

   :jsonparam String result: *(required)* ``failure``
   :jsonparam String errorCode: *(required)* The error code of the failure.
   :jsonparam String errorMessage: *(required)* The (human readable) error message of the failure.