Owners¶
GET/api/v1/Owners/{ownerAccountId}
PATCH/api/v1/Owners/{ownerAccountId}
Get List of Owners¶
GET/api/v1/Owners
Get a list of owners manageable by the current user.
Scope¶
read:owneraccounts
Success Response¶
200 OK
[
{
"id": "1",
"name": "Home",
"active": true
},
{
"id": "2",
"name": "Office",
"active": true
}
]
Error Responses¶
| HTTP Status Code | Error Code | Description |
|---|---|---|
| 400 | Generic Error | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Put Owner¶
PUT/api/v1/Owners
Create a new owner account.
Scope¶
write:owneraccounts
Body¶
{
"name": "Holiday Home"
}
Success Response¶
200 OK
Info
This operation is not available in the context of a Client Credentials request.
Error Responses¶
| HTTP Status Code | Error Code | Description |
|---|---|---|
| 400 | Generic Error | |
| 401 | Unauthorized | |
| 403 | Forbidden |
Get Owner by ID¶
GET/api/v1/Owners/{ownerAccountId}
Get the specified owner.
Scope¶
read:owneraccounts
Parameters¶
| Name | Type | Location | Description |
|---|---|---|---|
ownerAccountId | string | path | The owner account to retrieve. |
Success Response¶
200 OK
{
"id": "1",
"name": "Office",
"active": true
}
Error Responses¶
| HTTP Status Code | Error Code | Description |
|---|---|---|
| 400 | Generic Error | |
| 401 | Unauthorized | |
| 403 | Forbidden | |
| 404 | Owner account not found |
Patch Owner¶
PATCH/api/v1/Owners/{ownerAccountId}
Patch the details of an Owner Account.
The following properties can be patched:
name
Scope¶
write:owneraccounts
Parameters¶
| Name | Type | Location | Description |
|---|---|---|---|
ownerAccountId | string | path | The owner account to patch. |
Body¶
{
"name": "Another Home"
}
Success Response¶
200 OK
{
"id": "1",
"name": "Another Home",
"active": true
}
Error Responses¶
| HTTP Status Code | Error Code | Description |
|---|---|---|
| 400 | Generic Error | |
| 401 | Unauthorized | |
| 403 | Forbidden |