Rest - Admin - Programmes: Difference between revisions
Jump to navigation
Jump to search
(Created page with "==Purpose== To fetch information about the programmes an agency is associated with. ===Base URL=== http://app.views.coop/api/restful/admin/programmes ==Retreive associated...") |
m (→Purpose) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
===Base URL=== | ===Base URL=== | ||
https://app.viewsapp.net/api/restful/admin/programmes | |||
==Retreive associated programmes== | ==Retreive associated programmes== | ||
Latest revision as of 13:09, 26 February 2016
Purpose
To fetch information about the programmes an agency is associated with.
Base URL
https://app.viewsapp.net/api/restful/admin/programmes
Retreive associated programmes
curl --url <Base URL> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"
This will return a list of programmes that the agency is associated with in the following format:
<?xml version="1.0" encoding="utf-8"?>
<admin>
<programmes>
<programme id="7">Football League Trust</programme>
<programme id="18">FLT + NCS Collaboration</programme>
<programme id="19">Sported Impact Analysis</programme>
<programme id="25">DFE YPFN</programme>
</programmes>
</admin>
Fetching information about a programme
curl --url <Base URL>/<id> -u<username>:<password> -H Content-Type:text/xml -X POST -d "<xml>"
- id - The ID of the Value List
This will return an xml file similar to the following:
<?xml version="1.0" encoding="utf-8"?>
<programme id="7">
<ProgramID>7</ProgramID>
<Name>Football League Trust</Name>
<outcomeFrameworks>2|3|4</outcomeFrameworks>
<shortCode>FLT</shortCode>
</programme>