Global property history reporting and due-diligence API

Calls to the API must be for genuine use and responses from the API must not be stored for the purpose of creating an offline copy of the information stored. Failure to comply with this requirement will infringe the API License.

StockWatch API Calls

Update StockWatch Record

POST /stockwatch/update/{stockwatchref}

Purpose

To add or update items on an existing StockWatch record.

Inputs

* Optional only when updating an item but are required when adding a new item to an existing record.

All optional parameters must be valid if they are supplied.

Example Request

Adding an item:

POST /stockwatch/update/4234234-2-3523-3223423523-234234:IHVREV73287476-4324234 HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "items": [{
        "itemreference": "SAMTEST",
        "manufacturer": "Samsung",
        "model": "Galaxy",
        "serials": ["7837492049023842"]
    }]
}

Updating an item:

POST /stockwatch/update/4234234-2-3523-3223423523-234234:IHVREV73287476-4324234 HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "items": [{
        "itemid": 1,
        "itemreference": "SAMTEST",
        "manufacturer": "Samsung",
        "model": "Galaxy",
        "serials": ["7837492049023842"]
    }]
}

Removing an item:

POST /stockwatch/update/4234234-2-3523-3223423523-234234:IHVREV73287476-4324234 HTTP/1.1
Accept: application/json
Content-Type: application/json

{
    "items": [{
        "itemid": 1,
        "remove": true
    }]
}

Output

A 204 No Content HTTP response code upon success. If the record does not exist then a 404 Not Found response code will be returned.

Example Response


HTTP/1.1 204 No Content
Content-Type: application/json