Revision as of 12:37, 5 August 2020

This section requires a high level of Excel skills and a knowledge of how the API works. It my be useful to use an API Development tool to check the dictionaries and make test calls, Postman is a suitable tool for this. Power Query is used to call the API to retrieve the data.

What you will need

In order to follow this section you will need the following;

• Dizions API Licence (Read Only or Full)
• Microsoft Excel 2016 or later
• API Development tool (Optional)

Setting up our first API query

Here we are going to look at how to get started using the API and Excel Power Query. Before you start you will need to create an Authentication File, with this file we can then use a standard header for all of our queries that we wish to use.

Open Microsoft Excel either using an existing file or a new blank workbook. The examples below will be using a blank workbook. You will need the data tab available in Excel.

Click on the data tab and select 'Get Data' on the left hand side. Select From other Sources>Blank Query

This will open the Power Query Editor and create Query 1. We are going to use the advanced editor to paste the following:

• Details of the authentication, stored in our Authentication File.
• A call to the API dictionary to see which records we have on the system.

To access the Advanced editor click on the View Tab and select 'Advanced Editor'. This will open a new window. For the purpose of this example you can copy the text below but you will need to change the file path on the second line (keyFile) to the location of your Authentication File. In the advanced editor delete the details currently display and paste the example below, making sure you have updated the keyFile line.

File:Orglistquery.txt

You will be prompted that Information is required for the data privacy.

• Click on continue.
• Click the check box to ignore privacy and select save.

The query will then run and display a list of the record types available in your system. This can be used as an index to lookup ID's for the records you may wish to use. On the right hand side you can change the name of the query, like 'List of Record types'.

From here we can click on close and load. If you haven't set the privacy above to will be prompted to do so. The data that is received from the API will then be added to a new worksheet in a table. If we wish to edit the query we can right click on the query in the 'Queries and Connections panel". If you have minimised the panel in can be found on the Data tab of the ribbon.

The next steps from here is to add further queries to your workbook.

Moving forward

In this section you will find examples of queries to help you move forward. Each query will need to be added to the header information as explain earlier.

This example query below will:

• Retrieve records from type 1 (the default client record of the system)
• The fields retrieved will be the Record ID, Surname, Forenames and ethnicity.
• The query will convert to a table and expand the fields to include the fields above.

URL = APIHost
 & "v2/clients/type/1/field/postcode;id;name;first_name;ethnicity"
 & "?resolveIds[]=ALL",
apiResults = Json.Document(Web.Contents(URL, [Headers=[#"Source"=SourceKey, #"Org"=OrgKey, #"User"=UserKey]])),
    #"Converted to Table" = Table.FromList(apiResults, Splitter.SplitByNothing(), null, null, ExtraValues.Error),
    #"Expanded Column1" = Table.ExpandRecordColumn(#"Converted to Table", "Column1",  {"id", "name", "first_name", "postcode", "ethnicity"},  {"Column1.id", "Column1.name", "Column1.first_name", "Column1.postcode", "Column1.ethnicity"})
in
    #"Expanded Column1"

This example query below will:

• Retrieve referrals from all projects form 01/01/2020 to 31/12.2020
• The fields retrieved will be the Referral/Case ID, the date, contact method, client age range at time of referral and the name of the project..
• The query will convert to a table and expand the fields to include the fields above.

URL = APIHost
 & "/v2/referrals/date/2020-01-01,2020-12-31/field/id;date;client;referrer;contact_method;client_age_range;project_name"
 & "?resolveIds[]=ALL",
apiResults = Json.Document(Web.Contents(URL, [Headers=[#"Source"=SourceKey, #"Org"=OrgKey, #"User"=UserKey]])),
    #"Converted to Table" = Table.FromList(apiResults, Splitter.SplitByNothing(), null, null, ExtraValues.Error),
    #"Expanded Column1" = Table.ExpandRecordColumn(#"Converted to Table", "Column1", {"id", "date", "client", "project_name", "contact_method", "referrer", "client_age_range"}, {"Column1.id", "Column1.date", "Column1.client", "Column1.project", "Column1.contact_method", "Column1.referrer", "Column1.client_age_range"}),
    #"Changed Type" = Table.TransformColumnTypes(#"Expanded Column1",Template:"Column1.date", type datetime)
in
    #"Changed Type"

You can download the below XLSX file that has three queries;

• Record Types
• All Referrals in 2020
• Record Type 1 (Default Client Record)

Once opened you will need to edit each query to specify the location of your Authentication File. This is done by editing the keyFile line.

Example with 3 queries.xlsx