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 Total or multiple fields with ?include=Count(*) Total, Min(Age), AVG(Age) AverageAge or 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 | No | |
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 | No | The type of event |
Comments | form | string | No | Comments that could be added to the event log item |
UserName | form | string | No | The user created the event |
Created | form | DateTime | No | Then date when the event occured |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The event type id |
Name | form | string | No | The event type name |
Description | form | string | No | 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 | No | |
Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfBookingLogQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <d2p1:BookingLogQueryResponse> <d2p1:BookingId>0</d2p1:BookingId> <d2p1:Comments>String</d2p1:Comments> <d2p1:Created>0001-01-01T00:00:00</d2p1:Created> <d2p1:EventType> <d2p1:Description>String</d2p1:Description> <d2p1:Id>0</d2p1:Id> <d2p1:Name>String</d2p1:Name> </d2p1:EventType> <d2p1:EventTypeId>0</d2p1:EventTypeId> <d2p1:Id>0</d2p1:Id> <d2p1:UserName>String</d2p1:UserName> </d2p1:BookingLogQueryResponse> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfBookingLogQueryResponseWg5EthtI>