GET User Vaccination Info 解説

予防接種状況の情報を取得(一覧)します

概要

リクエストされたユーザーIDとチャイルドIDを元に、対象となるユーザーの予防接種状況の情報を取得するAPI
リクエストされた認証トークンを用いてユーザー認証を行い、成功した場合、対象となる予防接種の情報を返す。
ヘッダーにトークンIDを付与し、レスポンスコード「200」として、レスポンスを返す。
認証に失敗した場合は、レスポンスコード「401」として、レスポンスを返す。

エンドポイント

https://oevsk49876.execute-api.ap-northeast-1.amazonaws.com/GETUserVaccinationInfo?tenantId={tenantId}&childId={childId}

メソッド

GET

接続先

DynamoDB

リクエストヘッダー

フィールド名
Content-Typeapplication/json
Authorization取得したtokenId

リクエストデータ

JSON Key必須値の説明
tenantIdString[WHERE]DBカラム:children.tenantId
childIdString[WHERE]DBカラム:children.childId

レスポンスデータ

JSON Key必須値の説明
vaccineStatusVaccineStatus[]予防接種(ワクチン)状況
VaccineStatus
JSON Key必須値の説明
vaccinationIdString[SELECT]DBカラム:vaccination.vaccinationId
vaccinationNameString[SELECT]DBカラム:vaccination.vaccinationName
vaccinationCountIdString[SELECT]DBカラム:childVaccination.vaccinationCountId
scheduledDateString[SELECT]DBカラム:childVaccination.scheduledDate
inoculatedDateString[SELECT]DBカラム:childVaccination.inoculatedDate
guidelineStringvaccination.guideline_date を用いて、接種予定日を計算

処理結果ステータス

ステータスメッセージ
200OK
400Parameter Error
401Unauthorized
500INTERNAL SERVER ERROR

戻る