予防接種状況の情報を取得(一覧)します
リクエストされたユーザーIDとチャイルドIDを元に、対象となるユーザーの予防接種状況の情報を取得するAPI
リクエストされた認証トークンを用いてユーザー認証を行い、成功した場合、対象となる予防接種の情報を返す。
ヘッダーにトークンIDを付与し、レスポンスコード「200」として、レスポンスを返す。
認証に失敗した場合は、レスポンスコード「401」として、レスポンスを返す。
https://oevsk49876.execute-api.ap-northeast-1.amazonaws.com/GETUserVaccinationInfo?tenantId={tenantId}&childId={childId}
GET
DynamoDB
フィールド名 | 値 |
---|---|
Content-Type | application/json |
Authorization | 取得したtokenId |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
tenantId | String | ○ | [WHERE]DBカラム:children.tenantId |
childId | String | ○ | [WHERE]DBカラム:children.childId |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
vaccineStatus | VaccineStatus[] | ○ | 予防接種(ワクチン)状況 |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
vaccinationId | String | ○ | [SELECT]DBカラム:vaccination.vaccinationId |
vaccinationName | String | ○ | [SELECT]DBカラム:vaccination.vaccinationName |
vaccinationCountId | String | ○ | [SELECT]DBカラム:childVaccination.vaccinationCountId |
scheduledDate | String | [SELECT]DBカラム:childVaccination.scheduledDate | |
inoculatedDate | String | [SELECT]DBカラム:childVaccination.inoculatedDate | |
guideline | String | vaccination.guideline_date を用いて、接種予定日を計算 |
ステータス | メッセージ |
---|---|
200 | OK |
400 | Parameter Error |
401 | Unauthorized |
500 | INTERNAL SERVER ERROR |
> 戻る