Reservation Station API

<back to all web services

UserLogin

The following routes are available for this service:
POST/user/login
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, IHasDeviceInfo):
    # @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    api_key: Optional[str] = None
    """
    The API Key required for authentication
    """


    # @ApiMember(DataType="double", Description="Latitude of the user making this request")
    latitude: float = 0.0
    """
    Latitude of the user making this request
    """


    # @ApiMember(DataType="double", Description="Longitude of the user making this request")
    longitude: float = 0.0
    """
    Longitude of the user making this request
    """


@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 RatesItem:
    rate: Decimal = decimal.Decimal(0)
    minutes: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FacilityData:
    facility_id: int = 0
    facility_guid: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None
    next_available: Optional[str] = None
    has_next_available: bool = False
    rates: Optional[List[RatesItem]] = None
    theme_color: Optional[str] = None
    booking_notes: Optional[str] = None
    lead_time: int = 0
    venue_id: int = 0
    allow_extra_requirements: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VenueData:
    venue_id: int = 0
    name: Optional[str] = None
    registered_date: Optional[str] = None
    venue_code: Optional[str] = None
    is_coordinator: bool = False
    facilities: Optional[List[FacilityData]] = None
    latitude: float = 0.0
    longitude: float = 0.0
    has_location: bool = False
    logo_url: Optional[str] = None
    lead_time: int = 0
    venue_info: Optional[str] = None
    allow_guests: bool = False
    contact_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserCustomFieldData:
    id: Optional[str] = None
    value: Optional[str] = None
    name: Optional[str] = None
    optional: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VenueCustomField:
    venue_name: Optional[str] = None
    venue_id: int = 0
    fields: Optional[List[UserCustomFieldData]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LoginData:
    system_user_id: int = 0
    name: Optional[str] = None
    email_address: Optional[str] = None
    mobile_number: Optional[str] = None
    refresh_token: Optional[str] = None
    refresh_token_expiry: Optional[str] = None
    venues: Optional[List[VenueData]] = None
    venue_custom_fields: Optional[List[VenueCustomField]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserLoginResponse(ApiServiceResponse):
    registration_required: bool = False
    data: Optional[LoginData] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserLogin(ApiServiceRequest):
    google_id_token: Optional[str] = None
    utc_offset: int = 0
    email_address: Optional[str] = None
    display_name: Optional[str] = None

Python UserLogin DTOs

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

HTTP + JSV

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

POST /user/login HTTP/1.1 
Host: reservation.api.dev.86degrees.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	googleIdToken: String,
	utcOffset: 0,
	emailAddress: String,
	displayName: String,
	apiKey: String,
	latitude: 0,
	longitude: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	registrationRequired: False,
	description: String,
	heading: String,
	wasSuccessful: False,
	modelState: {}
}