Skip to content

hmrc/transit-movements-converter

Repository files navigation

transit-movements-converter

This is an internal backend microservice for the Common Transit Convention project which provides an internal API to convert XML to Json and Json to XML.

This applications lives in the "protected" zone. It integrates with:

This microservice is in Beta. The signature may change.

Prerequisites

Development Setup

Run from the console using: sbt run. The service runs on the default port 9475.

The application should be run as part of the CTC_TRADERS_API profile due to it being an integral part of service.

Highlighted SBT Tasks

Task Description Command
run Runs the application with the default configured port $ sbt run
test Runs the standard unit tests $ sbt test
it/test Runs the integration tests $ sbt it/test
dependencyCheck Runs dependency-check against the current project. It aggregates dependencies and generates a report $ sbt dependencyCheck
dependencyUpdates Shows a list of project dependencies that can be updated $ sbt dependencyUpdates
dependencyUpdatesReport Writes a list of project dependencies to a file $ sbt dependencyUpdatesReport

Related API documentation

Helpful information

Guides for the related public Common Transit Convention Traders API are on the HMRC Developer Hub

Reporting Issues

If you have any issues relating to the Common Transit Convention Traders API, please raise them through our public API.

License

This code is open source software licensed under the Apache 2.0 License.