breathing-space-if-stub

This is a stateless stub implementation of the EIS Integration Framework backend for the Breathing Space program.

Sample Curl microservice commands

Get BS Periods

'http://localhost:9503/individuals/breathing-space/NINO/AS000005A/periods' --header 'CorrelationId: 75e4cdc2-eecb-11ea-913a-0a9f09f70a70' --header 'OriginatorId: DS2_BS_UNATTENDED' --header 'UserId: 0000000'

Post Bs Periods

--request POST 'http://localhost:9503/individuals/breathing-space/NINO/AS000502A/periods' --header 'CorrelationId: 75e4cdc2-eecb-11ea-913a-0a9f09f70a70' --header 'OriginatorId: DS2_BS_UNATTENDED' --header 'UserId: 0000000' --header 'Content-Type: application/json' --data-raw '{"periods":[{"startDate":"2020-05-25","pegaRequestTimestamp":"2020-12-22T14:19:03+01:00"},{"startDate":"2020-06-22","endDate":"2020-08-22","pegaRequestTimestamp":"2020-12-22T14:19:03+01:00"},{"startDate":"2020-06-22","endDate":"2020-08-22","pegaRequestTimestamp":"2020-12-22T14:19:03+01:00"}]}'

Put Bs Periods

-request PUT 'http://localhost:9503/individuals/breathing-space/NINO/MS000001B/periods' --header 'CorrelationId: 24a8a24f-7126-4aa7-b690-259b2eaccaee' --header 'OriginatorId: DS2_BS_ATTENDED' --header 'UserId: 1234567' --header 'Content-Type: application/json' --data-raw '{"periods":[{"periodID": "4043d4b5-1f2a-4d10-8878-ef1ce9d97b32", "startDate":"2020-05-25","pegaRequestTimestamp":"2020-12-22T14:19:03+01:00"},{"periodID": "6aed4f02-f652-4bef-af14-49c79e968c2e", "startDate":"2020-06-22","endDate":"2020-08-22","pegaRequestTimestamp":"2020-12-22T14:19:03+01:00"},{"periodID": "a5a1e6f9-929b-442a-b3b1-96ce74f4372b", "startDate":"2020-06-22","endDate":"2020-08-22","pegaRequestTimestamp":"2020-12-22T14:19:03+01:00"}]}'

Get Individual Details

'http://localhost:9503/individuals/details/NINO/AS000001A?fields=details(nino,dateOfBirth,cnrIndicator)' --header 'CorrelationId: 75e4cdc2-eecb-11ea-913a-0a9f09f70a70' --header 'OriginatorId: DS2_BS_UNATTENDED' --header 'UserId: 0000000'

All Endpoint behaviour

Below is a list of special Nino values that, when passed to any of the stateless stub endpoints, will produce a special response from the stub (such as an error response).

All Nino values below are without a suffix letter but if a suffix letter is sent then it will be treated the same as if it were not present in the Nino

Any Nino that begins with the characters "BS" will result in the stub returning an unhappy Http response code.

The last 3 digits of the Nino can be used to specify exactly what response code the stub should return. So for instance:

NINO           Http Response Code 
------------------------------------------------
"BS000400" => 400
"BS000404" => 404
"BS000502" => 502

If the last 3 digits is not within the standard range of Http error codes then a '500' code will be returned.

GET BS Periods Endpoint

In addition to the generic behaviour described above this particular endpoint will also return for the given Nino:

NINO           Response 
------------------------------------------------
"AS000001" => A single Bs Period fully populated
"AS000002" => A single Bs Period partially populated
"AS000003" => Multiple Bs Periods fully populated
"AS000004" => Multiple Bs Periods partially populated
"AS000005" => Multiple Bs Periods with mixed population
All other Nino values will return an empty periods response

GET Individual Details Endpoint

In addition to the generic behaviour described above this particular endpoint will also return for these given Ninos:

NINO          Http Response Code + Body 
---------------------------------------------------------------------------------------------------------
"AS000001" => 200 + A fully populated individual details payload
"AS000002" => 200 + A minimally populated individual details payload
"AS000003" => 200 + A singularly populated (only ever one element in an array) individual details payload

Combined with the above Nino values the following query string values are also required to be sent:

Query String                                                                               Http Response Code + Filter Index Numb
---------------------------------------------------------------------------------------------------------------------------------
"fields=details(nino,dateOfBirth,cnrIndicator)"                                         => 200 + #0
"fields=details(nino,dateOfBirth),namelist(name(firstForename,secondForename,surname))" => 200 + #1
*ANY_OTHER_VALUE*                                                                       => 422

License

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