No description, website, or topics provided.
Scala RAML
Smudgey Merge pull request #115 from hmrc/bootstrap-upgrade
[NK] Upgrade bootstrap-play-25 to the latest version 1.7.0
Latest commit bdd3506 Jul 20, 2018

README.md

native-apps-api-orchestration

Build Status Download

Consolidation of Next Generation Consumer API services - Driver for simpler mobile apps API calls

Requirements

The following services are exposed from the micro-service.

Please note it is mandatory to supply an Accept HTTP header to all below services with the value application/vnd.hmrc.1.0+json.

API

Task Supported Methods Description
/native-app/preflight-check POST Return pre-flight information. The cookie named mdtpapi will be returned from this service and must be supplied to the startup service. More...
/native-app/:nino/startup POST Initiate an async service call to return personal tax data. The cookie named mdtpapi will be returned from this service and must be supplied to the poll service. More...
/native-app/:nino/poll GET Poll the status of the async task which was initiated from startup. The cookie named mdtpapi must be supplied to this service. More...
Claimant Details /native-app/:nino/startup?journeyId={id} POST Initiate an async service to retrieve tax credit claimant details. The cookie named mdtpapi will be returned from this service and must be supplied to the poll service. More...
Claimant Details /native-app/:nino/poll GET Poll the status of the asyncclaimant details task which was initiated from startup. The cookie named mdtpapi must be supplied to this service. More...
Feedback /native-app/:nino/startup POST Initiate an async service to submit feedback. The cookie named mdtpapi will be returned from this service and must be supplied to the poll service. More...
Feedback /native-app/:nino/poll GET Poll the status of the async feedback task which was initiated from startup. The cookie named mdtpapi must be supplied to this service. More...
Survey Widget /native-app/:nino/startup?journeyId={id} POST Persists widget survey data captured in the app. More...
Survey Widget /native-app/:nino/poll GET Poll the status of the async survey widget task which was initiated from startup. The cookie named mdtpapi must be supplied to this service. More...
Help to Save Startup /native-app/:nino/startup?journeyId={id} POST Initiate an async help-to-save-startup task to retrieve Help to Save portion of startup More...
Help to Save Startup /native-app/:nino/poll GET Poll the status of an async help-to-save-startup task which was initiated from startup. More...
Audit /native-app/:nino/startup?journeyId={id} POST Retrieve message associated with Id and update state to answer. More...
Audit /native-app/:nino/startup?journeyId={id} GET Returns all messages that have not yet been answered or acknowledged. More...

Sandbox

All the above endpoints are accessible on sandbox with /sandbox prefix on each endpoint, e.g.

GET /sandbox/native-app/preflight-check

Version

Version of API need to be provided in Accept request header

Accept: application/vnd.hmrc.v1.0+json

License

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