- Optional param list for user answers endpoint
- lrn - Filters documents for partial or matching Local Reference Number of all user answers for given eori number
- limit - Sets the maximum number of returned documents
- skip - Sets the increment of skipped documents for pagination purposes. The number of documents skipped is worked out as 'skip * limit'
- A call is made to the
GETendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier
- A list of documents are found in the
user-answerscollection for the given EORI number from enrolment - The response JSON will have a summary list of each user answer with the following fields:
lrn- The local reference number associated with the departure application_links- Links used to retrieve the full data for a specific lrncreatedAt- The date and time that the application was started. The user has 30 days from this point to complete and submit the applicationlastUpdated- The date and time that the application was last updatedid- a UUID
{
"eoriNumber": "1234567",
"totalMovements": 2,
"totalMatchingMovements": 2,
"userAnswers": [
{
"lrn": "AB123",
"_links": {
"self": {
"href": "/manage-transit-movements-departure-cache/user-answers/AB123"
}
},
"createdAt": "2023-01-26T10:32:15.648",
"lastUpdated": "2023-01-27T08:43:17.064",
"_id": "27e687a9-4544-4e22-937e-74e699d855f8"
},
{
"lrn": "CD123",
"_links": {
"self": {
"href": "/manage-transit-movements-departure-cache/user-answers/CD123"
}
},
"createdAt": "2023-01-26T10:32:36.96",
"lastUpdated": "2023-01-26T10:32:41.377",
"_id": "750f1f92-6c61-4a3b-ad3e-95d8c7418eb4"
}
]
}
- A generic authorization error occurred. The likely cause of this is an invalid or missing bearer token.
- User has insufficient enrolments
- No documents were found for EORI number
- An error occurred in the mongo client
- A call is made to the
GETendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier
- A document is found in the
user-answerscollection for the given LRN (the EORI number is extracted from the enrolment) - The response JSON has the following fields:
lrn- The local reference number associated with the departure applicationeoriNumber- The EORI number linked to the user's enrolmentdata- The user's answerscreatedAt- The date and time that the application was started. The user has 30 days from this point to complete and submit the applicationlastUpdated- The date and time that the application was last updatedid- a UUID
- A generic authorization error occurred. The likely cause of this is an invalid or missing bearer token.
- User has insufficient enrolments
- No document was found for the given LRN
- An error occurred in the mongo client
- A call is made to the
POSTendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier - a valid
UserAnswersrequest body - the same EORI number in the enrolment and request body
- Then, for the given LRN and EORI number in the request body, either:
- A document is found in the
user-answerscollection and the document gets updated with the user answers from the request body - A document is not found in the
user-answerscollection and a new document gets created with the user answers from the request body
- A document is found in the
- Request body could not be validated as a
UserAnswers
- A generic authorization error occurred. The likely cause of this is an invalid or missing bearer token.
- User has insufficient enrolments
- EORI number in request body does not match the EORI number in the user's enrolment
- An error occurred in the mongo client
- A call is made to the
PUTendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier - a valid
Stringrequest body representing the LRN
- Then, for the given LRN in the request body and EORI number in the enrolment, a new document gets created with an empty user answers
- Request body could not be validated as a
String
- A generic authorization error occurred. The likely cause of this is an invalid or missing bearer token.
- User has insufficient enrolments
- An error occurred in the mongo client
- A call is made to the
DELETEendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier
- A document is deleted from the
user-answerscollection for the given LRN (the EORI number is extracted from the enrolment)
- An error occurred in the mongo client
- A call is made to the
GETendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier - a valid
Stringrequest body representing the LRN
- Then, for the given local reference number in the url, it is checked against the API to see if that local reference number exists, if false, the local reference number is then checked against the cache and the result is returned as a boolean.
- A call is made to the
GETendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier - a valid
Stringrequest body representing the LRN
- Then, for the given local reference number in the url, it is checked against the API to see if that local reference number exists and returns the result as a boolean.
- A call is made to the
POSTendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier - a valid
Stringrequest body representing the LRN - an
Acceptheader with either:application/vnd.hmrc.transition+jsonfor transition rulesapplication/vnd.hmrc.final+jsonfor final rules
- Then, an IE015 gets successfully submitted to the API
- Request body could not be validated as a
String
- A generic authorization error occurred. The likely cause of this is an invalid or missing bearer token.
- User has insufficient enrolments
- An error occurred
- A call is made to the
POSTendpoint with:- a valid bearer token
- a valid
HMRC-CTC-ORGenrolment withEoriNumberidentifier - a valid
Stringrequest body representing the LRN - an
Acceptheader with either:application/vnd.hmrc.transition+jsonfor transition rulesapplication/vnd.hmrc.final+jsonfor final rules
- Then, an IE013 gets successfully submitted to the API
- Request body could not be validated as a
String
- A generic authorization error occurred. The likely cause of this is an invalid or missing bearer token.
- User has insufficient enrolments
- An error occurred
- Start the service locally with
sbt runin the root directory - The service can be started via service manager, depending on the version of service manager you are using, with either:
sm --start MANAGE_TRANSIT_MOVEMENTS_DEPARTURE_CACHEsm2 --start MANAGE_TRANSIT_MOVEMENTS_DEPARTURE_CACHE
- Run the unit tests by running
sbt testin the root directory - Run the integration tests (requires
MongoDB) by runningsbt it/testin the root directory
This code is open source software licensed under the Apache 2.0 License.