| GET, POST | /pickmeup/history | Get the user's recent history of bookings. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceRequest(IServiceRequest, IHasApiKey):
# @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
api_key: Optional[str] = None
"""
The API Key required for authentication
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ApiServiceResponse(IServiceResponse):
description: Optional[str] = None
heading: Optional[str] = None
was_successful: bool = False
model_state: Optional[Object] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingLocation:
# @ApiMember(Description="Latitude of the pickup/drop-off location.", IsRequired=true)
latitude: float = 0.0
"""
Latitude of the pickup/drop-off location.
"""
# @ApiMember(Description="Longitude of the pickup/drop-off location.", IsRequired=true)
longitude: float = 0.0
"""
Longitude of the pickup/drop-off location.
"""
# @ApiMember(Description="Address of the pickup/drop-off location.", IsRequired=true)
address: Optional[str] = None
"""
Address of the pickup/drop-off location.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PickMeUpBookingItem:
# @ApiMember(Description="Date and Time of the pickup in ISO 8601 format.")
booking_time: Optional[str] = None
"""
Date and Time of the pickup in ISO 8601 format.
"""
# @ApiMember(Description="The booking reference number returned by the service provider. To be shown to the client.")
reference_number: Optional[str] = None
"""
The booking reference number returned by the service provider. To be shown to the client.
"""
# @ApiMember(Description="Date and Time the booking request was made in ISO 8601 format.")
date_created: Optional[str] = None
"""
Date and Time the booking request was made in ISO 8601 format.
"""
# @ApiMember(Description="Status of the booking as returned by the service provider.")
status: Optional[str] = None
"""
Status of the booking as returned by the service provider.
"""
# @ApiMember(Description="Name of contact person at pickup.", IsRequired=true)
contact_name: Optional[str] = None
"""
Name of contact person at pickup.
"""
# @ApiMember(Description="Contact number of contact person at pickup.", IsRequired=true)
contact_number: Optional[str] = None
"""
Contact number of contact person at pickup.
"""
# @ApiMember(Description="The number of people to be picked up.", IsRequired=true)
passenger_count: Optional[str] = None
"""
The number of people to be picked up.
"""
# @ApiMember(Description="The location details of where the clients are to be picked up.", IsRequired=true)
pickup_location: Optional[BookingLocation] = None
"""
The location details of where the clients are to be picked up.
"""
# @ApiMember(Description="The location details of where the clients are to be dropped off.", IsRequired=true)
dropoff_location: Optional[BookingLocation] = None
"""
The location details of where the clients are to be dropped off.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PickMeUpHistoryResponse(ApiServiceResponse):
# @ApiMember(Description="Is the requested product set up and enabled on Galaxy.")
product_available: bool = False
"""
Is the requested product set up and enabled on Galaxy.
"""
# @ApiMember(Description="Does the user have access to this product, based on their Galaxy profile.")
user_has_access: bool = False
"""
Does the user have access to this product, based on their Galaxy profile.
"""
# @ApiMember(Description="List of booking history items for the Pick Me Up service.")
pick_me_up_history: Optional[List[PickMeUpBookingItem]] = None
"""
List of booking history items for the Pick Me Up service.
"""
# @ApiMember(Description="List of booking history items for the Take Me Home service.")
take_me_home_history: Optional[List[PickMeUpBookingItem]] = None
"""
List of booking history items for the Take Me Home service.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PickMeUpHistoryRequest(ApiServiceRequest):
# @ApiMember(Description="ID Number of the user's history to retrieve.", IsRequired=true)
id_number: Optional[str] = None
"""
ID Number of the user's history to retrieve.
"""
Python PickMeUpHistoryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /pickmeup/history HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"IdNumber":"String","ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ProductAvailable":false,"UserHasAccess":false,"PickMeUpHistory":[{}],"TakeMeHomeHistory":[{}],"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}