Developing JSON API for a Carpool Engine

Posted by Siddharth on Programmers See other posts from Programmers or by Siddharth
Published on 2012-11-01T14:02:25Z Indexed on 2012/11/01 17:16 UTC
Read the original article Hit count: 427

Filed under:

interfaces

|

api

I am developing a new set of API methods for carpooling/cab booking, so if a developer needs to develop an app or webportal for carpooling, he can call my JSON API. Basically making it easy for developers.

My API current has:

AddVehicle
AddJourney
SearchJourney
SubscribeToThisJourney(journey)
SubscriberList(journey) to get list of people who have subscribed for this journey
AcceptSubscription(subscriber)
AcceptedSubcriberList
SubscriberList to get list of providers I have subscribed to

I need help with replacing subscriber with something else. It's difficult to remember, and confusing when you see 3 methods that mean very different things: SubscriberList, SubscribedToThisJourneyList and AcceptedSubscriberList. Confusing to remember.

One is a list of who I have subscribed to
Who has subscribed to me
Whose subscription I have accepted

How can I name these methods to make them easier to understand and remember?

© Programmers or respective owner

Related posts about interfaces

Should interfaces inherit interfaces

as seen on Programmers - Search for 'Programmers'
Although this is a general question it is also specific to a problem I am currently experiencing. I currently have an interface specified in my solution called public interface IContextProvider { IDataContext { get; set; } IAreaContext { get; set; } } This interface is often used throughout… >>> More
Should interfaces extend (and in doing so inherit methods of) other interfaces

as seen on Programmers - Search for 'Programmers'
Although this is a general question it is also specific to a problem I am currently experiencing. I currently have an interface specified in my solution called public interface IContextProvider { IDataContext { get; set; } IAreaContext { get; set; } } This interface is often used throughout… >>> More
What problems will I face if I remove the concept of interfaces from my code?

as seen on Programmers - Search for 'Programmers'
I have been programming for many years but I am still not comfortable with the concept of "Interfaces". I try to use interfaces but many times I don't see a mandatory use for it. I think this is probably because the projects weren't so big, or because interfaces are more useful when teamwork is involved… >>> More
Explicit C# interface implementation of interfaces that inherit from other interfaces

as seen on Stack Overflow - Search for 'Stack Overflow'
Consider the following three interfaces: interface IBaseInterface { event EventHandler SomeEvent; } interface IInterface1 : IBaseInterface { ... } interface IInterface 2 : IBaseInterface { ... } Now consider the following class that implements both IInterface1 and IInterface 2: class… >>> More
How to force multiple Interfaces to include certain the same properties?

as seen on Stack Overflow - Search for 'Stack Overflow'
I am trying to figure out a way to force all of my Interfaces to include properties of the same name/type. For example: I have two Interfaces; IGetAlarms and IGetDiagnostics. Each of the Interfaces will contain properties that are specific to the Interface itself, however I want to force the two… >>> More

Related posts about api

Where does ASP.NET Web API Fit?

as seen on West-Wind - Search for 'West-Wind'
With the pending release of ASP.NET MVC 4 and the new ASP.NET Web API, there has been a lot of discussion of where the new Web API technology fits in the ASP.NET Web stack. There are a lot of choices to build HTTP based applications available now on the stack - we've come a long way from when WebForms… >>> More
An Introduction to ASP.NET Web API

as seen on West-Wind - Search for 'West-Wind'
Microsoft recently released ASP.NET MVC 4.0 and .NET 4.5 and along with it, the brand spanking new ASP.NET Web API. Web API is an exciting new addition to the ASP.NET stack that provides a new, well-designed HTTP framework for creating REST and AJAX APIs (API is Microsoft’s new jargon for a service… >>> More
Introduction to the ASP.NET Web API

as seen on Stephen Walter - Search for 'Stephen Walter'
I am a huge fan of Ajax. If you want to create a great experience for the users of your website – regardless of whether you are building an ASP.NET MVC or an ASP.NET Web Forms site — then you need to use Ajax. Otherwise, you are just being cruel to your customers. We use Ajax extensively in… >>> More
Introduction to the ASP.NET Web API

as seen on Stephen Walter - Search for 'Stephen Walter'
I am a huge fan of Ajax. If you want to create a great experience for the users of your website – regardless of whether you are building an ASP.NET MVC or an ASP.NET Web Forms site — then you need to use Ajax. Otherwise, you are just being cruel to your customers. We use Ajax extensively in… >>> More
How can I setup dependencies for Axis2 / Axiom on Maven2

as seen on Stack Overflow - Search for 'Stack Overflow'
I've tried the following settings on pom.xml to use Axis2 wsdl2code: <dependencies> <dependency> <groupId>org.apache.axis2</groupId> <artifactId>axis2</artifactId> <version>1.5.1</version> </dependency> </dependencies> ... <build> … >>> More