PATCH apioauth/tooltrackv2/items/{itemId}

Patch an item, will alert on low stock

Request Information

URI Parameters

Name	Description	Type	Additional information
itemId	The item id to be updated	unsigned integer	Required

Body Parameters

The patch request

PatchItemRequest

Name	Description	Type	Additional information
item	The item to be updated	PatchItemObject	None.
item_log	The log for the item changes	ItemLogObject	None.

Request Formats

application/json, text/json

Sample:

{
  "item": {
    "asset_id": 1,
    "reference": "sample string 1",
    "item_type": "sample string 2",
    "description": "sample string 3",
    "tag_1": "sample string 4",
    "tag_2": "sample string 5",
    "tag_3": "sample string 6",
    "tag_4": "sample string 7",
    "tag_5": "sample string 8",
    "consumable": true,
    "off_hire_date": "2025-04-27T15:37:58.2791879+00:00",
    "store_location": "sample string 9",
    "minimum_stock": 1,
    "maximum_stock": 1,
    "quantity": 1,
    "calibration_date": "2025-04-27T15:37:58.2791879+00:00",
    "expiry_date": "2025-04-27T15:37:58.2791879+00:00",
    "service_date": "2025-04-27T15:37:58.2791879+00:00",
    "value": 1.0,
    "condition": 0,
    "assigned_status": 0,
    "hire_status": 0,
    "calibration_status": 0,
    "pat_status": 0,
    "photo_data": "sample string 10",
    "photo_name": "sample string 11",
    "pat_date": "2025-04-27T15:37:58.2791879+00:00"
  },
  "item_log": {
    "job_reference": "sample string 1",
    "change_status": 0,
    "change_reason": 0,
    "condition_photo_name": "sample string 2",
    "condition_photo_data": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<PatchItemRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Item>
    <AssetId>1</AssetId>
    <Reference>sample string 1</Reference>
    <ItemType>sample string 2</ItemType>
    <Description>sample string 3</Description>
    <Tag1>sample string 4</Tag1>
    <Tag2>sample string 5</Tag2>
    <Tag3>sample string 6</Tag3>
    <Tag4>sample string 7</Tag4>
    <Tag5>sample string 8</Tag5>
    <Consumable>true</Consumable>
    <OffHireDate>2025-04-27T15:37:58.2791879+00:00</OffHireDate>
    <StoreLocation>sample string 9</StoreLocation>
    <MinimumStock>1</MinimumStock>
    <MaximumStock>1</MaximumStock>
    <Quantity>1</Quantity>
    <CalibrationDueDate>2025-04-27T15:37:58.2791879+00:00</CalibrationDueDate>
    <ExpiryDate>2025-04-27T15:37:58.2791879+00:00</ExpiryDate>
    <ServiceDate>2025-04-27T15:37:58.2791879+00:00</ServiceDate>
    <Value>1</Value>
    <Condition>Poor</Condition>
    <AssignedStatus>Unassigned</AssignedStatus>
    <HireStatus>NotInUse</HireStatus>
    <CalibrationStatus>NotInUse</CalibrationStatus>
    <PatStatus>NotInUse</PatStatus>
    <PhotoData>sample string 10</PhotoData>
    <PhotoName>sample string 11</PhotoName>
    <PatDate>2025-04-27T15:37:58.2791879+00:00</PatDate>
  </Item>
  <ItemLog>
    <JobReference>sample string 1</JobReference>
    <ChangeStatus>CheckIn</ChangeStatus>
    <ChangeReason>Rental</ChangeReason>
    <ConditionPhotoName>sample string 2</ConditionPhotoName>
    <ConditionPhotoData>sample string 3</ConditionPhotoData>
  </ItemLog>
</PatchItemRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated item after changes

ItemObject

Name	Description	Type	Additional information
id	The item id	unsigned integer	None.
asset_id	The id of the asset the item is associated to or null if one is not associated	unsigned integer	None.
reference	The reference of the item	string	None.
item_type	The type of the item	string	None.
description	The item description	string	None.
tag_1	Description tag 1	string	None.
tag_2	Description tag 2	string	None.
tag_3	Description tag 3	string	None.
tag_4	Description tag 4	string	None.
tag_5	Description tag 5	string	None.
consumable	If the tag is consumable	boolean	None.
off_hire_date	The time of the offhire date	date	None.
depot_id	The id of the depot	decimal number	None.
store_location	The location in a store of a item	string	None.
minimum_stock	The minimum stock level	integer	None.
maximum_stock	The maximum stock level	integer	None.
quantity	The current quantity	integer	None.
calibration_date	The calibration date	date	None.
expiry_date	The expiry date	date	None.
service_date	The service date	date	None.
value	The item value in GBP	decimal number	None.
condition	The condition of the item	ConditionStatus	None.
assigned_status	The assigned status of an item	AssignedStatus	None.
hire_status	The hire status of an item	DueDateStatus	None.
calibration_status	The calibration status of an item	DueDateStatus	None.
pat_status	The pat status of an item	DueDateStatus	None.
photo_url	The item photo url	string	None.
assigned_person_name	The name of the person who has hired the item if the item is not consumable	string	None.
pat_date	The pat date	date	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "asset_id": 1,
  "reference": "sample string 2",
  "item_type": "sample string 3",
  "description": "sample string 4",
  "tag_1": "sample string 5",
  "tag_2": "sample string 6",
  "tag_3": "sample string 7",
  "tag_4": "sample string 8",
  "tag_5": "sample string 9",
  "consumable": true,
  "off_hire_date": "2025-04-27T15:37:58.2946615+00:00",
  "depot_id": 10.0,
  "store_location": "sample string 11",
  "minimum_stock": 1,
  "maximum_stock": 1,
  "quantity": 1,
  "calibration_date": "2025-04-27T15:37:58.2946615+00:00",
  "expiry_date": "2025-04-27T15:37:58.2946615+00:00",
  "service_date": "2025-04-27T15:37:58.2946615+00:00",
  "value": 1.0,
  "condition": 0,
  "assigned_status": 0,
  "hire_status": 0,
  "calibration_status": 0,
  "pat_status": 0,
  "photo_url": "sample string 12",
  "assigned_person_name": "sample string 13",
  "pat_date": "2025-04-27T15:37:58.2946615+00:00"
}

application/xml, text/xml

Sample:

<ItemObject xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <AssetId>1</AssetId>
  <Reference>sample string 2</Reference>
  <ItemType>sample string 3</ItemType>
  <Description>sample string 4</Description>
  <Tag1>sample string 5</Tag1>
  <Tag2>sample string 6</Tag2>
  <Tag3>sample string 7</Tag3>
  <Tag4>sample string 8</Tag4>
  <Tag5>sample string 9</Tag5>
  <Consumable>true</Consumable>
  <OffHireDate>2025-04-27T15:37:58.2946615+00:00</OffHireDate>
  <DepotId>10</DepotId>
  <StoreLocation>sample string 11</StoreLocation>
  <MinimumStock>1</MinimumStock>
  <MaximumStock>1</MaximumStock>
  <Quantity>1</Quantity>
  <CalibrationDueDate>2025-04-27T15:37:58.2946615+00:00</CalibrationDueDate>
  <ExpiryDate>2025-04-27T15:37:58.2946615+00:00</ExpiryDate>
  <ServiceDate>2025-04-27T15:37:58.2946615+00:00</ServiceDate>
  <Value>1</Value>
  <Condition>Poor</Condition>
  <AssignedStatus>Unassigned</AssignedStatus>
  <HireStatus>NotInUse</HireStatus>
  <CalibrationStatus>NotInUse</CalibrationStatus>
  <PatStatus>NotInUse</PatStatus>
  <PhotoUrl>sample string 12</PhotoUrl>
  <AssignedPersonName>sample string 13</AssignedPersonName>
  <PatDate>2025-04-27T15:37:58.2946615+00:00</PatDate>
</ItemObject>