Skip to content

Latest commit

 

History

History
108 lines (84 loc) · 2.02 KB

getResidencyStatuses.md

File metadata and controls

108 lines (84 loc) · 2.02 KB
Raw

getResidencyStatuses

Returns an array of structured residency status data in JSON format.

  • Version History:

    TASS v49.1 - Method Added

  • Version:

    1

  • Method:

    GET | POST

  • Params:

    Required:

    codeonly [boolean] - Return Code only. Must be 'true' or 'false'.

    Optional:

    none

    Conditional:

    none

  • Success Response:

    "statuses": [
	{
		"census_flg": "Y",
		"code": "AV",
		"expcode": "NACPR1",
		"citizen_flg": "N",
		"permres_flg": "N",
		"res_exp_code": "NACPR1",
		"desc": "Approved Student"
	},
	{
		"census_flg": "Y",
		"code": "AC",
		"expcode": "AC",
		"citizen_flg": "Y",
		"permres_flg": "Y",
		"res_exp_code": "AC",
		"desc": "Australian Citizen"
	},
	{
		"census_flg": "N",
		"code": "OS",
		"expcode": "NACPR",
		"citizen_flg": "N",
		"permres_flg": "N",
		"res_exp_code": "NACPR",
		"desc": "Overseas Student"
	},
	{
		"census_flg": "Y",
		"code": "PR",
		"expcode": "PRA",
		"citizen_flg": "N",
		"permres_flg": "Y",
		"res_exp_code": "PRA",
		"desc": "Permanent Resident"
	}
]

  • Error Response:

    codeonly not supplied

    "__msg": "'codeonly' IS REQUIRED"

    codeonly invalid

    "__msg": "'codeonly' MUST BE 'true' or 'false'"

  • Sample Parameters:

     codeonly=false

  • Sample GET: (With URL Encoded token)

     http://api.tasscloud.com.au/tassweb/api/?appcode=DEMOOE&v=1&method=GetResidencyStatuses&token=3w6XHPP1j163aHf%2FHRAnLA%3D%3D&company=10

  • Sample POST:

     <form id="postForm" name="postForm" method="POST" action="http://api.tasscloud.com.au/tassweb/api/">
 	<input type="hidden" name="method" value="GetResidencyStatuses" />
 	<input type="hidden" name="appcode" value="DEMOOE" />
 	<input type="hidden" name="company" value="10" />
 	<input type="hidden" name="v" value="1" />
 	<textarea name="token">3w6XHPP1j163aHf\/HRAnLA==</textarea>
 </form>