| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /bookinglog | Find booking log for booking. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | query | Guid? | Yes | Enter the company and booking id you want to see log for, if blank company id and you are an admin, your company id will be used |
| BookingId | query | int | Yes | Enter the booking id you want to get the log |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | query | int | No | Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: ?skip=10&orderBy=Id |
| Take | query | int | No | Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: ?take=20 |
| OrderBy | query | string | No | Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: ?orderBy=Id,-Age,FirstName |
| OrderByDesc | query | string | No | Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field. Example: ?orderByDesc=Id,-Age,FirstName |
| Include | query | string | No | Include any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.Example: ?include=COUNT(*) as Totalor multiple fields with ?include=Count(*) Total, Min(Age), AVG(Age) AverageAgeor unique with ?include=COUNT(DISTINCT LivingStatus) as UniqueStatus |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EventTypeId | form | int | No | |
| EventType | form | BookingLogEventType | Yes | |
| CompanyId | form | Guid | Yes | |
| BookingId | form | int | Yes | |
| Id | form | int | No | |
| Comments | form | string | No | |
| UserId | form | string | No | |
| Created | form | DateTime | Yes | |
| ModifiedDate | form | DateTimeOffset? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| ModifiedDate | form | DateTimeOffset? | No | |
| Id | form | int | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The booking log id |
| BookingId | form | int | No | The booking id |
| EventTypeId | form | int | No | The type of event |
| EventType | form | BookingLogEventTypeResponse | Yes | The type of event |
| Comments | form | string | Yes | Comments that could be added to the event log item |
| UserName | form | string | Yes | The user created the event |
| Created | form | DateTime | No | The date when the event occurred |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The event type id |
| Name | form | string | Yes | The event type name |
| Description | form | string | Yes | The event type description |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<AccessKeyTypeResponse> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| KeyType | form | string | Yes | |
| Description | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /bookinglog HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
BookingId: 0,
EventTypeId: 0,
EventType:
{
Id: 0,
Name: String,
Description: String
},
Comments: String,
UserName: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}