Cochrane+ App API

EndJourney

The following routes are available for this service:
POST	/journey/end

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 JourneyPointData:
    latitude: float = 0.0
    longitude: float = 0.0
    address: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MeetingData:
    meeting_id: int = 0
    start_time: Optional[str] = None
    arrival_time: Optional[str] = None
    left_time: Optional[str] = None
    duration: Optional[str] = None
    show_time_fields: bool = False
    arrival_status: Optional[str] = None
    email: Optional[str] = None
    has_email: bool = False
    contact_name: Optional[str] = None
    latitude: float = 0.0
    longitude: float = 0.0
    location: Optional[str] = None
    address: Optional[str] = None
    subject: Optional[str] = None
    description: Optional[str] = None
    end_time: Optional[str] = None
    company: Optional[str] = None
    contact_number: Optional[str] = None
    has_contact_number: bool = False
    has_location: bool = False
    set_by: Optional[str] = None
    virtual_or_in_person: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JourneyNoteData:
    note: Optional[str] = None
    date: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class JourneyData:
    journey_id: int = 0
    title: Optional[str] = None
    start_time: Optional[str] = None
    end_time: Optional[str] = None
    distance: float = 0.0
    distance_formatted: Optional[str] = None
    route_polyline: Optional[str] = None
    start_point: Optional[JourneyPointData] = None
    end_point: Optional[JourneyPointData] = None
    meeting_data: Optional[MeetingData] = None
    journey_notes: Optional[List[JourneyNoteData]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EndJourneyResponse(ApiServiceResponse):
    journey: Optional[JourneyData] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EndJourney(ApiServiceRequest):
    journey_id: int = 0

Python EndJourney DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /journey/end HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"journeyId":0,"apiKey":"String","latitude":0,"longitude":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"description":"String","heading":"String","wasSuccessful":false,"modelState":{}}