{ "opencollection": "1.0.0", "info": { "name": "Arthur Certificates API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.arthuronline.co.uk/oauth/authorize", "accessTokenUrl": "https://auth.arthuronline.co.uk/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Certificates", "type": "folder" }, "items": [ { "info": { "name": "List Certificates", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/certificates", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number, between 1 and the total number of pages." }, { "name": "limit", "value": "", "type": "query", "description": "Items per page, between 1 and 100." }, { "name": "sort", "value": "", "type": "query", "description": "Field to sort the collection by." }, { "name": "direction", "value": "", "type": "query", "description": "Sort direction." } ] }, "docs": "This retrieves a list of certificates." }, { "info": { "name": "View Certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.arthuronline.co.uk/v2/certificates/:certificate_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "certificate_id", "value": "", "type": "path", "description": "Arthur certificate id." } ] }, "docs": "This API endpoint retrieves the details of a single certificate, identified by its unique  certificate_id .\n\nUse this endpoint to view the specific details of a certificate." }, { "info": { "name": "Update Certificate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.arthuronline.co.uk/v2/certificates/:certificate_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "certificate_id", "value": "", "type": "path", "description": "Arthur certificate id." }, { "name": "strict", "value": "", "type": "query", "description": "When true, abort the request instead of auto-creating an unknown Simple type. POST and PUT only." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an existing certificate using the same fields as the 'Add Certificate' endpoint found under Properties, Units, Tenancies and Workorders. Any fields that are not provided will not be changed. The API will return the updated data for the asset in the response.\n\nSupported Fields \n The following fields are supported for the request body\n\nField \n Example \n Type \n Required? \n\ntype \n Boiler Service \n String \n Yes \n\nexpiry_date \n 2023-12-05 \n String \n No \n\nnotes \n Fully assessed \n " }, { "info": { "name": "Delete Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.arthuronline.co.uk/v2/certificates/:certificate_id", "headers": [ { "name": "X-EntityID", "value": "" } ], "params": [ { "name": "certificate_id", "value": "", "type": "path", "description": "Arthur certificate id." } ] }, "docs": "This endpoint deletes an existing ceriticate record using the certificate  id ." } ] } ], "bundled": true }