Open Menu

© 2018 Capita Business Services Ltd. All rights reserved.

Capita Education Software Solutions is a trading name of Capita Business Services Ltd. Our Registered office is 30 Berners Street, London, W1T 3LR and our registered number is 02299747. Further information about Capita plc can be found in our legal statement.

Product / Web - SIMS ID Based APIs / Web - RAP API - Example Calls / Web: RAP API - Organisation

Web: RAP API - Organisation

Call (Development environment)

  Run("https://simsid-partner-rapapi.azurewebsites.net/api/v1/Organisation/"
     + arq.Organisation_ID+ "/Organisation/"
      , bt1
      , arq.OCP_APIM_Key
      , "RAP_Organisation,json"
      , folder);

Where

  • arq.Organisation_ID is the organisation id of the school.
  • bt1 is the bearer token,
  • arq.OCP_APIM_Key is the API Manager Key (Not used)
  • "RAP_Organisation.json" is the file name to write the output to and 
  • folder is the location to create the file

You can find all the base class definitions here along with details of the scopes.

NB: The live URL will have a different 'stem'.

Will return:

{
    "Id": 3105,
    "Name": "2082BCFF-08DD-4134-B7F9-666300ADFED6",
    "OrganisationId": "2082BCFF-08DD-4134-B7F9-666300ADFED6",
    "DfeCode": "2082BCFF",
    "DeniNumber": null
}