API Reference
These docs are for v2.3. Click to read the latest docs for v3.0.

Update a component on the property

Sample Request:

PATCH /api/v2/properties/ALB10/components/C0000002015  

{
     "uprn": "ALB10",       (Mandatory, in-line with Uprn from the Request link above)
     "componentreference": "C0000002015",       (Mandatory, in-line with Component Reference from the Request link above)
     "iscompliance": true,      (Mandatory, true if the updated property component is either Compliance or both Compliance and Planned)
     "location": "Flooring",        (Not Required, Common Attribute)
     "locationdescription": "API Testing",     (Not Required, Common Attribute)
     "floorlevel": 2,     (Not Required, Common Attribute)                 
     "unitOfMeasurement": "m",        (Not Required, Common Attribute) 
     "quantity": 2,        (Not Required, Common Attribute) 
     "servicedate": "01/09/2023",       (Not Required, Compliance Component) 
     "expirydate": "11/09/2024",        (Not Required, Compliance Component) 
     "warrantyonrefresh": true,     (Not Required, Compliance Component) 
     "warrantmonths": 3,        (Not Required, Compliance Component) 
     "lastinstalled": "01/07/2023",     (Not Required, Planned Component) 
     "lastsurveyed": "11/06/2023",      (Not Required, Planned Component) 
     "nextreplacementmethod": "Manual",     (Not Required, Planned Component) 
     "nextreplacementdate": "11/07/2027"        (Not Required, Planned Component) 

}

Required Permission(s): Property.ManageComponents, Property.View

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!