hmcts/ccd-user-profile-api repository overview

⁠ccd-user-profile-api

UI preferences for Core Case Data users.

⁠Getting started

⁠Prerequisites

• Open JDK 8⁠
• Docker⁠

⁠Environment variables

The following environment variables are required:

⁠Building

The project uses Gradle⁠.

To build project please execute the following command:

./gradlew clean build

⁠Gradle Upgrades

It is important to run the following command and commit the updated gradle-wrapper.jar to the repository for proper gradle upgrades

# this sample is for v4.9 replace with correct upgrade version
./gradlew wrapper --gradle-version 4.9 --distribution-type all

⁠Running

If you want your code to become available to other Docker projects (e.g. for local environment testing), you need to build the image:

docker-compose build

The above will build both the application and database images.
If you want to build only one of them just specify the name assigned in docker compose file, e.g.:

docker-compose build ccd-user-profile-api

When the project has been packaged in target/ directory, you can run it by executing following command:

docker-compose up

As a result the following containers will get created and started:

• Database exposing port 5453
• API exposing ports 4453

⁠Handling database

Database will get initiated when you run docker-compose up for the first time by execute all scripts from database directory.

You don't need to migrate database manually since migrations are executed every time docker-compose up is executed.

You can connect to the database at http://localhost:5453 with the username and password set in the environment variables.

⁠API

Their are currently 2 endpoints:

• POST /user-profile/users - this is used to create a User Profile as well as it's associated Jurisdictions. At least one Jurisdiction must be defined in order to create a User Profile. Also, there is currently no way to amend a User's Jurisdictions other than manually removing them from the database and creating a new User.
• GET /user-profile/users/{uid}/jurisdictions - this is used to retrieve a String[] of Jurisdictions ID for the given User ID.

⁠Create a User

To create a user the following example JSON can be used:

{
	"id" : "user1",
	"jurisdictions" : [{
			"id" : "TEST1"
		}, {
			"id" : "TEST2"
		}
	]
}

⁠LICENSE

This project is licensed under the MIT License - see the LICENSE⁠ file for details.