Overview
Admin Resources
Application Resources


REST API: REQUEST FORMATS
Credentials

All requests to REST API require you to authenticate using HTTP basic auth to access the resource. The username is your Login ID. The password is the password you setup or were provided.

Most HTTP clients (including web-browsers) present a dialog or prompt for you to provide a username and password for HTTP basic auth. Most clients will also allow you to provide credentials in the URL itself. For example:

https://{LoginID}:{Password}@api.proconanalytics.com/v1.3/{ApplicationID}/{AccountID}/Account
ApplicationID

Data is partitioned into Applications. The API queries must designate the ApplicationID in order to access the system. The ApplicationID is in the format 999.9 and is assigned to you during setup.

AccountID

The hierarchical structure of the data dictates that all REST calls are in an Account Context. One of the resources of the Account are SubAccounts, which are accessed by changing the Account Context to the SubAccount.

Retrieving Resources with the HTTP GET Method

You can retrieve a representation of a resource by GETting its url. The easiest way to do this is to copy and paste a URL into your web browser's address bar.

Possible GET Response Status Codes
  • 200 OK: The request was successful and the response body contains the content as defined.
  • 401 UNAUTHORIZED: The credentials provided do not allow access to the requested resource.
  • 404 NOT FOUND: Unable to locate the requested resource.
  • 500 SERVER ERROR: An internal server error has occurred.
  • 503 SERVICE UNAVAILABLE: The requested service is temporarily unavailable, please wait and try again.
Creating or Updating Resources with the HTTP POST and PUT Methods

Create or update a resource by performing an HTTP PUT OR POST and posting as form data the JSON structure specified for the resource.

Possible POST or PUT Response Status Codes
  • 200 OK: The request was successful and the resource is updated and the response body contains information about the update.
  • 201 CREATED: The request was successful, the resource is created and the response body contains information about the update.
  • 400 BAD REQUEST: The data supplied failed validation. The response body contains details about the rejection.
  • 401 UNAUTHORIZED: The credentials provided do not allow access to the requested resource.
  • 404 NOT FOUND: Unable to locate the requested resource.
  • 405 METHOD NOT ALLOWED: This resource cannot be created or updated.
  • 500 SERVER ERROR: An internal server error has occurred.
  • 503 SERVICE UNAVAILABLE: The requested service is temporarily unavailable, please wait and try again.
Deleting Resources with the HTTP DELETE Method

To delete a resource make an HTTP DELETE request to the resource URI. Not all resources support DELETE.

Possible DELETE Response Status Codes
  • 204 OK: The request was successful, the resource was deleted.
  • 401 UNAUTHORIZED: The credentials provided do not allow access to the requested resource.
  • 404 NOT FOUND: Unable to locate the requested resource.
  • 405 METHOD NOT ALLOWED: This resource cannot be deleted.
  • 500 SERVER ERROR: An internal server error has occurred.
  • 503 SERVICE UNAVAILABLE: The requested service is temporarily unavailable, please wait and try again.