Retrieving Resources¶
User can retrieve resources by sending a GET request with a UUID reference number
of the resource. Most commonly, the request can yield two response statuses: 200
or 404
.
An example of retrieving a customer is illustrated below. Note that customer_ref
is also
referred as customer UUID
.
- GET /customer/(customer_ref)¶
Sample request
GET /customer/088ffd8885df4fd0b4076aea195c3377 HTTP/1.1 Host: api.fieldaware.net Authorization: Token d943a51d68c44ca38cab9abda20a4d18 Content-Type: application/json
Sample response:
HTTP/1.1 200 OK Content-Type: application/json Link: <https://api.fieldaware.net/customer/088ffd8885df4fd0b4076aea195c3377>; rel=self { "website": "www.bdata.net", "account": null, "glAccount": null, "name": "BigData", "discount": 8, "notes": null, "fax": null, "customerId": 239, "phone": "003537876645", "billingLocation": null, "taxable": true, "onHold": false, "customFields": {}, "email": "bdata@mailinator.com", "uuid": "088ffd8885df4fd0b4076aea195c3377" }
- Status Codes:
200 OK – when the resource is retrieved successfully
404 Not Found – when the resource can not be found
More examples of retrieving resources can be found in the reference part of the FA REST API documentation.