Skip to content

Commit

Permalink
document all get endpoints (finally)
Browse files Browse the repository at this point in the history
  • Loading branch information
espen committed Feb 29, 2024
1 parent a20629b commit 634140f
Showing 1 changed file with 32 additions and 8 deletions.
40 changes: 32 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,14 @@ You can return bookings of multiple resources/services/events/people with an arr
<tr><td>extended</td><td>Boolean</td><td>Extend output with full data from related objects.</td></tr>
</table>

### Get booking

`GET /bookings/{booking_id}` will get booking with id `{booking_id}`.

You can also find a booking with `external_id`:

`GET /bookings/find_by/external_id/{external_id}` will get booking with external_id `{external_id}`.

### Add new booking

`POST /bookings` will create a new booking.
Expand Down Expand Up @@ -710,14 +718,6 @@ See [information about additional parameters](#additional-parameters).
<tr><td>cancellation_send_sms</td><td>Boolean</td><td>Send out cancellation SMS.</td></tr>
</table>

### Get booking

`GET /bookings/{booking_id}` will get booking with id `{booking_id}`.

You can also find a booking with `external_id`:

`GET /bookings/find_by/external_id/{external_id}` will get booking with external_id `{external_id}`.

### Update booking state

`PUT /bookings/{booking_id}/status` will update the booking state.
Expand Down Expand Up @@ -804,6 +804,10 @@ You can search multiple columns at once, for example `email` and `phone_number`,
<tr><td>since</td><td>DateTime</td><td>updated_at after param</td></tr>
</table>

### Get person

`GET /people/{person_id}` will get a person with id `{person_id}`.

### Add new person

`POST /people` will create a new person.
Expand Down Expand Up @@ -928,6 +932,10 @@ Response
]
```

### Get service

`GET /services/{service_id}` will get a service with id `{service_id}`.

### Add new service

`POST /services` will create a new service.
Expand Down Expand Up @@ -1001,6 +1009,10 @@ Response
<tr><td>since</td><td>DateTime</td><td>updated_at after param</td></tr>
</table>

### Get event

`GET /events/{event_id}` will get an event with id `{event_id}`.

### Add new event

`POST /events` will create a new event.
Expand Down Expand Up @@ -1305,6 +1317,10 @@ Response
]
```

### Get provider

`GET /providers/{provider_id}` will get a provider with id `{provider_id}`.

### Add new provider

`POST /providers` will create a new provider.
Expand Down Expand Up @@ -1350,6 +1366,10 @@ Response
]
```

### Get category

`GET /categories/{category_id}` will get a category with id `{category_id}`.

### Add new category

`POST /categories` will create a new category. To add connected services specify array of `{service_id}` in parameter `{service_id_list}`.
Expand Down Expand Up @@ -1539,6 +1559,10 @@ Response
]
```

### Get user

`GET /client/users/{user_link_id}` will get a user with id `{user_link_id}`.

#### Add new user

`GET /client/users` will create a new user.

0 comments on commit 634140f

Please sign in to comment.