Cochrane+ App API

<back to all web services

EndJourney

Requires Authentication
The following routes are available for this service:
POST/journey/end
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using WebService.ServiceModel;
using WebService.ServiceModel.Base;
using CommonService.Api.Models.Base;

namespace CommonService.Api.Models.Base
{
    public partial class ApiServiceResponse
        : IServiceResponse
    {
        public virtual string Description { get; set; }
        public virtual string Heading { get; set; }
        public virtual bool WasSuccessful { get; set; }
        public virtual Object ModelState { get; set; }
    }

}

namespace WebService.ServiceModel
{
    public partial class EndJourney
        : ApiServiceRequest
    {
        public virtual int JourneyId { get; set; }
    }

    public partial class EndJourneyResponse
        : ApiServiceResponse
    {
        public virtual JourneyData Journey { get; set; }
    }

    public partial class JourneyData
    {
        public JourneyData()
        {
            JourneyNotes = new List<JourneyNoteData>{};
        }

        public virtual int JourneyId { get; set; }
        public virtual string Title { get; set; }
        public virtual string StartTime { get; set; }
        public virtual string EndTime { get; set; }
        public virtual double Distance { get; set; }
        public virtual string DistanceFormatted { get; set; }
        public virtual string RoutePolyline { get; set; }
        public virtual JourneyPointData StartPoint { get; set; }
        public virtual JourneyPointData EndPoint { get; set; }
        public virtual MeetingData MeetingData { get; set; }
        public virtual List<JourneyNoteData> JourneyNotes { get; set; }
    }

    public partial class JourneyNoteData
    {
        public virtual string Note { get; set; }
        public virtual string Date { get; set; }
    }

    public partial class JourneyPointData
    {
        public virtual double Latitude { get; set; }
        public virtual double Longitude { get; set; }
        public virtual string Address { get; set; }
    }

    public partial class MeetingData
    {
        public virtual int MeetingId { get; set; }
        public virtual string StartTime { get; set; }
        public virtual string ArrivalTime { get; set; }
        public virtual string LeftTime { get; set; }
        public virtual string Duration { get; set; }
        public virtual bool ShowTimeFields { get; set; }
        public virtual string ArrivalStatus { get; set; }
        public virtual string Email { get; set; }
        public virtual bool HasEmail { get; set; }
        public virtual string ContactName { get; set; }
        public virtual double Latitude { get; set; }
        public virtual double Longitude { get; set; }
        public virtual string Location { get; set; }
        public virtual string Address { get; set; }
        public virtual string Subject { get; set; }
        public virtual string Description { get; set; }
        public virtual string EndTime { get; set; }
        public virtual string Company { get; set; }
        public virtual string ContactNumber { get; set; }
        public virtual bool HasContactNumber { get; set; }
        public virtual bool HasLocation { get; set; }
        public virtual string SetBy { get; set; }
        public virtual string VirtualOrInPerson { get; set; }
    }

}

namespace WebService.ServiceModel.Base
{
    public partial class ApiServiceRequest
        : IServiceRequest, IHasApiKey, IHasDeviceInfo
    {
        ///<summary>
        ///The API Key required for authentication
        ///</summary>
        [ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Latitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Latitude of the user making this request")]
        public virtual double Latitude { get; set; }

        ///<summary>
        ///Longitude of the user making this request
        ///</summary>
        [ApiMember(DataType="double", Description="Longitude of the user making this request")]
        public virtual double Longitude { get; set; }
    }

}

C# EndJourney 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 /journey/end HTTP/1.1 
Host: cochraneplus-api-dev.happen.zone 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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