Unmask a Value
====================================

.. code-block:: http

    /api/repositories/(string:repository)/unmask

.. csv-table::
    :header: Parameter, Type, Purpose
    :widths: 20, 20, 60
    :stub-columns: 1

    repository, string, The name of the :doc:`repository <repository>` to access

Post
~~~~

.. http:post:: /api/repositories/(string:repository)/unmask
    :synopsis: Apply a mask to a value and get the unmasked result

.. code-block:: http

    POST /api/repositories/jupiter/unmask HTTP/1.1
    Content-Type: application/json

    {
        "data": {
            "value": "1/1/16",
            "mask": "0N/0N/20NN"
        }
    }

The `data` object must contain 2 key-value pairs:

.. csv-table::
    :header: Field, Description
    :widths: 25, 75

    value, The value to be recoded
    mask, The mask to be applied to the value

Both fields are required.

If the recode is successful, the response will contain the given value with the mask applied to it.

.. code-block:: http

    {
        "value": "01/01/2016"
    }

If the value or mask contain a space, then they must be surrounded by quotes:

.. code-block:: http

    POST /api/repositories/jupiter/unmask HTTP/1.1
    Content-Type: application/json

    {
        "data": {
            "value": "\"555 123-4567\"",
            "mask": "\"(NNN) NNN-NNNN\""
        }
    }

.. code-block:: http

    {
        "value": "(555) 123-4567"
    }

.. csv-table::
    :header: Response Code, Reason
    :widths: 25, 75

    200, Success
    500, Server error