GET v1/Companies/{CompanyId}/Locations/{LocationId}/Rooms
Returns all rooms for a location, and specifies if the room is the default selling room or default receiving room.
Information:
Base URL:
https://api.covasoft.net/availability
Example of a call would be:
Example: https://api.covasoft.net/availability/v1/Companies/{CompanyId}/Locations/{LocationId}/Rooms
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId |
The CompanyId of the company being searched. |
integer |
Required |
| LocationId |
The LocationId to query rooms for. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of RoomsReturn| Name | Description | Type | Additional information |
|---|---|---|---|
| RoomId | integer |
None. |
|
| Name | string |
None. |
|
| IsDefaultSelling | boolean |
None. |
|
| IsDefaultReceiving | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"RoomId": 1,
"Name": "sample string 2",
"IsDefaultSelling": true,
"IsDefaultReceiving": true
},
{
"RoomId": 1,
"Name": "sample string 2",
"IsDefaultSelling": true,
"IsDefaultReceiving": true
}
]