Add or update a PIN Type

Request

To create or update a PIN type, send a PUT request to:

http://<host>:<port>/adm/v1/pinTypes

If you are using PIN restrictions (PIN format, number of permitted incorrect PIN entry attempts, and lockout time), adding a new PIN type means that the PIN restriction configuration will need to be updated to apply restrictions to the new PIN type. (This is not necessary if you do not require require restrictions for the new PIN type or if a suitable fallback rule is configured.)

Please contact your NAGRA representative to arrange for this change to be made.

Headers

• Content-Type: application/json

Mandatory fields

• value – the name of the PIN
• description

Example

A request with this payload creates a PIN:

{
    "value": "PinTypeLabel",
    "description": "Pin Type Description"
}

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

Example

The payload of a response to a successful request is as follows.

Adding a new PIN type:

{
    "matchedCount": 0,
    "modifiedCount": 0
}

Updating an existing PIN type:

{
    "matchedCount": 1,
    "modifiedCount": 1
}

See also

For full details of this API, see Account and Device Manager (ADM) API documentation.