Dartmouth API Developer Portal

People-Visas API

Returns information about visas for a person.

NOTE: This API is currently not available as there are no current consumers. Visa information can be made available by request and after a security review and approval process

Rating

Attribute	Value
Highly Available	Yes
Cache Refresh Interval	60 minutes
Filtering	Yes

GET

GET returns all visas for the specified netid.

Required Scopes

Currently unavailable

Request

GET /api/people/{netid}/visas

Required Headers

Authorization: Bearer {jwt}

Notes on usage

Visas are modeled as a subresource of people. Currently it is only possible to get visas for a particular person. Searching for holders of certain visas is not available.

The visas are returned as a collection. When the person does not have visas associated with their account a status of 200 is returned with an empty array in the payload.

Returns

Status Code	Description
200	The URI parameter {netid} passed in is a valid identity
404	The URI parameter {netid} passed in is NOT a valid identity

Sample Request

https://api.dartmouth.edu/api/people/f00000x/visas

Sample Return

[
  {
      "visa_id": "f00abcd-1",
      "netid": "f00abcd",
      "is_confidential": false,
      "visa_type_id": "F1",
      "visa_type_desc": "Student",
      "visa_start_date": "2020-09-09T04:00:00Z",
      "visa_expire_date": "2020-09-10T04:00:00Z",
      "visa_port_of_entry": "FEE",
      "is_current_entry": false,
      "cache_date": "2022-08-10T14:38:06Z"
  },
  {
      "visa_id": "f00abcd-2",
      "netid": "f00abcd",
      "is_confidential": false,
      "visa_type_id": "F1",
      "visa_type_desc": "Student",
      "visa_start_date": "2021-09-08T04:00:00Z",
      "visa_expire_date": "2022-12-20T05:00:00Z",
      "visa_port_of_entry": "FEE",
      "is_current_entry": true,
      "cache_date": "2022-08-10T14:38:06Z"
  }
]