Billiecart API

<back to all web services

SearchAllBookingsRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
GET/bookings
SearchAllBookingsRequest Parameters:
NameParameterData TypeRequiredDescription
StartUtcqueryDateTime?No
EndUtcqueryDateTime?No
SearchOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
SearchOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
DistinctformstringNo
Limitformint?No
Offsetformint?No
SortformstringNo
FilterformstringNo
SearchformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
SearchAllBookingsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BookingsformList<Booking>No
SearchOperationResponse Parameters:
NameParameterData TypeRequiredDescription
MetadataformSearchMetadataNo
SearchMetadata Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
LimitformintNo
OffsetformintNo
SortformSortingNo
FilterformFilteringNo
Sorting Parameters:
NameParameterData TypeRequiredDescription
ByformstringNo
DirectionformSortDirectionNo
SortDirection Enum:
Ascending
Descending
Filtering Parameters:
NameParameterData TypeRequiredDescription
FieldsformList<string>No
SearchformstringNo
Booking Parameters:
NameParameterData TypeRequiredDescription
StartUtcformDateTimeNo
EndUtcformDateTimeNo
BorrowerIdformstringNo
CarIdformstringNo
IdformstringNo
SearchAllBookingsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
BookingsformList<Booking>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bookings HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchAllBookingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Bookings">
  <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">
    <d2p1:Filter>
      <d2p1:Fields xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Fields>
      <d2p1:Search>String</d2p1:Search>
    </d2p1:Filter>
    <d2p1:Limit>0</d2p1:Limit>
    <d2p1:Offset>0</d2p1:Offset>
    <d2p1:Sort>
      <d2p1:By>String</d2p1:By>
      <d2p1:Direction>Ascending</d2p1:Direction>
    </d2p1:Sort>
    <d2p1:Total>0</d2p1:Total>
  </Metadata>
  <Bookings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Booking>
      <d2p1:BorrowerId>String</d2p1:BorrowerId>
      <d2p1:CarId>String</d2p1:CarId>
      <d2p1:EndUtc>0001-01-01T00:00:00</d2p1:EndUtc>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:StartUtc>0001-01-01T00:00:00</d2p1:StartUtc>
    </d2p1:Booking>
  </Bookings>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1: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>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1: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>
    </d2p1:Meta>
  </ResponseStatus>
</SearchAllBookingsResponse>