codeplex api

Summary

This documentation describes how to connect to and use the CodePlex API. If you have any problems or requests, please contact us for more help.

Access

API access should be over HTTPS at https://www.codeplex.com/api/. All data is sent and received as JSON, and blank fields are omitted in responses.

Client Errors

All errors on API calls will respond with an appropriate status code as well as a JSON body:

HTTP/1.1 400 Bad Request
{"Error":{"Code":"BadRequest","Message":"There was an error.","Values":{}}}

HTTP Redirects

The API uses HTTP redirection where appropriate. Clients should assume that redirection could take place on any request. When a HTTP redirection occurs, it is not an error and the clients should follow that redirect. Redirect responses will have a Location header field which contains the URL that the client should repeat the request for.

  • 301 This is a permanent redirection. The current and all future requests should be directed to the new URL.
  • 302 This is temporary redirection. The current request should be repeated on the new URL, but future requests should continue to use this URL.

HTTP Verbs

The API will use appropriate HTTP verbs for each action, where its possible.

  • HEAD Can be issued against any resource to retrieve the HTTP header information.
  • GET Used for retrieving resources.
  • POST Used for creating resources, or invoking custom actions.
  • PATCH Used for updating resources with partial content.
  • PUT Used for replacing resources.
  • DELETE Used for deleting resources.