Review if immigration's API provides the data we need

[CharlotteHinton]

As the Presence Checker dev team, who now know what data we need to calculate eligibility for citizenship by grant, we will compare the API documentation provided to us by Immigration NZ, with what we need and work out if we can obtain enough data on presence and visa/permit status to perform the eligibility calculation..

A / C

• Draft documentation for review by Raj Goyal and Eric
• Should work with the data that we have already (identities and movements for identities)
• Doesn't include feedback from Raj or Eric

Notes:
Raj Goyal (CCMS Architect)
Eric Reigner - Enterprise Architect from Intergen

requires #62

[Br3nda]

Missing detail on this story? What api are we talking about?

I think its about a (potential) api provided by immigration nz, in which we are the client. The api we want them to provide to us, would serve border movement and immigration status for an applicant.

This story should be rewritten to include this.

[Br3nda]

I re-wrote this story

[mischa-s]

Swagger API only showing current visa status, we would need past visas as per visa's / movements table in data export

[lamorrison]

A specific detail: the Swagger API does NOT associate a visa with each client movement. A list of movements is available but none of the methods in the API let us associate a visa with them.

This is in contrast to the secure dataset we received where each (arrival) movement is associated with the visa type (although not a specific visa instance) used to approve the movement.