NSM API

The NSM::api application enables a REST API webservice to retrieve the difefrent models from the NSM models collection. NEVER use the files directly.

The API is available at http://nsm-api.nrc.pt.

API

GET http://nsm-api.nrc.pt/list
    get list of available models
GET http://nsm-api.nrc.pt/doc/:uid
    retrieve document model by unique identifier
GET http://nsm-api.nrc.pt/pln/:uid
    retrieve PLN resources model by unique identifier
GET http://nsm-api.nrc.pt/data/:uid
    retrieve data model by unique identifier

All endpoints return the result in JSON format by default, following the data types specification described in NSM Models.

Examples

Get the list of available documents:

$ curl http://nsm-api.nrc.pt/list
{"const-pt":{"docLang":"pt","docHeader":"Constituição da República Portuguesa","docUID":"const-pt"},"raum-2014":{"docLang":"pt","docUID":"raum-2014","docHeader":" Regulamento Académico da Universidade do Minho"},"cod-trab":{"docHeader":"Código do Trabalho","docUID":"cod-trab","docLang":"pt"},"cmg-op-2015":{"docLang":"pt","docHeader":"Orçamento Participativo de Guimarães 2015","docUID":"cmg-op-2015"},"ualg-reg-2010":{"docUID":"ualg-reg-2010","docHeader":"Regulamento de Avaliação da Universidade do Algarve","docLang":"pt"}}

Get the document model with uid const-pt:

$ curl http://nsm-api.nrc.pt/doc/const-pt
{"docUID": "const-pt", "docHeader": "Constitui\u00e7\u00e3o da Rep\u00fablica Portuguesa", "docLang": "pt", "docPreamble": "A 25 de Abril de 1974, o Movimento das For\u00e7as Armadas, coroando a longa resist\u00ea (...)