Jump to content


Why the difference in API Versioning vs Format string?


  • Please log in to reply
3 replies to this topic

#1 Zambiot


    Advanced Member

  • Members
  • PipPipPip
  • 94 posts
  • LocationAsia

Posted 21 February 2013 - 07:52 AM

In building code that is reusable and concise, I was creating functions to build the Format string and the API Versioning string.  https://www.carriots...#api-versioning


I noticed that the root of the format and versioning string are different.  


Format:  application/xml or application/vnd.carriots.api.v2+xml

API Versioning:  application/vnd.carriots+xml or application/vnd.carriots.v2+xml


Can or should these be the same?  That is, should both elements be "application/vnd.carriots" and then the remainder of the version and format?

#2 jpastor


    Development leader

  • Administrators
  • 178 posts

Posted 22 February 2013 - 10:43 AM

Hi Zambiot,

Actually, the root of the format and versioning are the same. The "api" in vnd.carriots.api is a typo in the documentacion.

You can use:

Accept header:
application/vnd.carriots+json (v2 and json)
application/vnd.carriots.v2+json (v2 and json)
application/vnd.carriots (v2 and json)

We will fix this and update soon this part of the documentation, thanks for notice this.



Best regards


Enjoy Carriots!

#3 mcastillo


    Carriots CEO

  • Administrators
  • 34 posts
  • LocationMadrid

Posted 22 February 2013 - 11:33 AM

Thank you Zambiot for reporting us this typo on our documentation and sorry for the troubles. Your feedback is very valuable for us to make Carriots a better solution.


We hope you enjoy building your product with us!


Best Regards.

#4 Zambiot


    Advanced Member

  • Members
  • PipPipPip
  • 94 posts
  • LocationAsia

Posted 22 February 2013 - 04:03 PM

Thanks guys for confirming this.


I have a knack for seeing the little oddities like this.  I am glad I can help out.  I am looking for a robust, well documented platform and if you are successful then my devices can be successful too.

Also tagged with one or more of these keywords: API, format, API VERSIONING

0 user(s) are reading this topic

0 members, 0 guests, 0 anonymous users