Update a Device

patch

https://apis.p2pemanager.com/api/v1/devices/{id}

This endpoint updates an existing Device resource. It is not neccessary to include the complete replacement object in the API call; an object containing the properties that are to be changed will suffice. For example, this endpoint can be used to change a Device's state from 'injected' to 'inTransit'.

Path Params

string

required

The Device's unique identifier.

Body Params

Device to be updated.

serialNumber

string

length ≤ 255

The Device's serial number.

alternateKey

string

length ≤ 255

The alternative key is used when a Device outputs a different serial number from its firmware/software when compared to the serial number that is printed on the Device's casing or its packaging. If there is a difference between the two, the serial number on the casing or packaging should be used as the alternative key and also in the alterntive key property of any related Shipments entries.

name

string

length ≤ 255

The Device's name.

deviceType

object

Reference to the associated Device Type resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

deviceBuild

object

Reference to the associated Device Build resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls the id, name and build number are included in the response.

kif

object

Reference to the associated KIF resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

partner

object

Reference to the associated Partner. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

client

object

Reference to the associated Client resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are populated.

injectKey

object

Reference to the associated Device resource. When used for POST and PATCH API calls, the reference can contain either the ID or Name. With GET API calls, both properties are included in the response.

auditNextDate

string

Date and time that the Device is due its next PCI Audit.

notes

string

Arbitary note that can be attached to a Device entry.

Responses

200Device update response

401Unauthorized

403Forbidden

404Not found

409Invalid data

500Internal server error