QOAM API

Sergi Papaseit Valls edited this page Aug 10, 2018 · 7 revisions

Introduction

De QOAM API is currently in its initial version.

It exposes the following data:

  • Journals
  • Score Cards

The API doesn't yet offer any querying capabilities, so it will return all Journals, all Score Cards.

Performing Requests

The API returns all data in pages of 1000, with pages starting at 1. So for example, when asking for page 1 of Journals, the API will return Journals 1 until 1001, ordered by title. Page 2 will return Journals 1002 until 2002, and so forth.

Page 1 is the default page and can be skipped.

Returned data type

By default the API returns XML, but offers the capability of returning data in JSON format. Simply append ?type=json to the url, or ?page=11&type=json if requesting any other page than the default one.

Journals

The url to request the initial 1000 Journals is:

/api/journals

If you want page 3 of the journals:

/api/journals?page=3

If you want page 3 of the journals, in JSON format:

/api/journals?page=3&type=json

Score Cards

The url to request the initial 1000 Score Cards is:

/api/score/valuationScoreCards
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.