Skip to main content

Add a new team

There are two platforms that include the concept of teams.

  • case viewer api (main tool)
  • core pathways tool.

This guide covers#

  1. How to add a new team to the case viewer api
  2. How to add a new team to the core pathways tool

1. How to add a new team to the case viewer api#

Steps:#

  • In order to send a new team request to the API, refer to the Runbook guide on Connecting to the case viewer API
  • Appending the correct value for Route to the endpoint
  • Creating a new team JSON object
  • Making a request to the API using CURL
  • Checking it worked

-- Appending the correct value for Route to the endpoint --#

Once you have the correct endpoint for hitting either Staging or Production, if you wish to direct your HTTP request to the right resource in the API then you will have to append the correct route to the endpoint.

Route information can be found in the specific controller that handles the resource you wish to target. In the Social Care Case Viewer API, the controller for teams is found at:

social-care-case-viewer-api/SocialCareCaseViewerApi/V1/Controllers/TeamController.cs

Route is defined in that file like so [Route("api/v1/teams")]

Append api/v1/teams to the endpoint in order to target the teams resource e.g.,

https://<api gateway id>.execute.<aws region>.amazonaws.com/<environment>/api/v1/teams

-- Creating a new JSON team object --#

The API expects to receive a JSON object containing the data properties needed to create a new team.

These properties consist of a name and a context

name = the name of the new team

context = refers to which service,

e.g.,

{“name”: “chosen_name”,“context”: “chosen_context”}

-- Making an API request to the API using CURL --#

If you are unfamiliar with how to use CURL, see this guide

Construct your CURL request like so:

(here it is split onto new lines for readability with \

and commented with # to explain each component of the CURL request,

<> wraps parts that require replacement by users)

curl \-X POST \ # send a post request-d '{"name": "chosen_name", "context": "chosen_context"}' \ # request body containing the JSON object-H "Content-type: application/json" \ # set json content type-H "x-api-key: <the_api_key_from_AWS>" \ # AWS API keyhttps://<api gateway id>.execute.<aws region>.amazonaws.com/<environment>/api/v1/<team> \ # the full url of the endpoint & resource collection

-- Checking it worked --#

Go to the Frontend application for whichever environment you added the team to

Click on the "Manage workers" link & enter a workers email to search for

Once found, you should press the “Update worker’s details” button

On the following page you will have the “Team” drop down, select this and check that it contains your newly added team for the correct service, e.g., Customer Service in the ASC service.

2. How to add a new team to the core pathways tool#

@TODO Complete docs for core pathways