Reads an existing Person.
Access control
The Permission level required to read a Person depends on:
- Whether the Person is
public - Who created the Person
The details are outlined in the table below:
| Public People | Non-Public People | |
|---|---|---|
| Your own | 0 or higher | 4 or higher |
| Other user’s | 0 or higher | 5 or higher |
Endpoints
Reading a Person is possible via these endpoints:
| Method | Path | Authentication |
|---|---|---|
GET | /people/:id/jwt | JSON Web Token |
GET | /people/:id/key | API Key & Secret |
Request url
The url should contain the ID of the Person you wish to read.
It replaces the :id placeholder in the endpoints listed above.
Response status codes
Possible status codes for these endpoints are:
| Status code | Description |
|---|---|
200 | success |
400 | the request was malformed |
401 | the request lacks authentication |
403 | authentication failed |
404 | API key not found |
500 | server error |
NOTE
If the status code is not
200
the error property
in the response body should indicate the nature of the problem.Response body
| Value | Type | Description |
|---|---|---|
result | String | Either success or error |
error | String | Will give info on the nature of the error. Only set if an error occurred. |
person.id | Number | The ID of the Person |
person.createdAt | String | Date string indicating the moment the Person was created |
person.img | String | The URL to the image stored with this Person |
person.name | String | The name of the Person |
person.notes | String | The notes stored with the Person |
person.userId | Number | The ID of the user who created the Person |
person.measies | Object | The measurements of the Person |
person.public | Boolean | Indicates whether the Person is publicly accessible or not |
person.updatedAt | String | Date string indicating the last time the Person was updated |
Example request
Javascript
const person = await axios.get(
'https://backend.freesewing.org/people/27/jwt',
{
headers: {
Authorization: `Bearer ${token}`
}
}
)
Example response
JSON
200
{
"result": "success",
"person": {
"id": 27,
"createdAt": "2022-11-19T17:36:41.342Z",
"img": "https://cdn.sanity.io/images/hl5bw8cj/production/a1565c8c6c70cfe7ea0fdf5c65501cd885adbe78-200x187.png",
"imperial": false,
"name": "Someone",
"notes": "These are some notes",
"userId": 12,
"measies": {
"chest": 930,
"neck": 360
},
"public": true,
"updatedAt": "2022-11-19T17:36:41.342Z"
}
}