GET Vaccination Info 解説

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

概要

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

エンドポイント

https://0qil8o1ekf.execute-api.ap-northeast-1.amazonaws.com/GETVaccinationInfo?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必須値の説明
vaccineVaccine[]予防接種(ワクチン)情報一覧
Vaccine
JSON Key必須値の説明
vaccinationIdString[SELECT]DBカラム:vaccination.vaccinationId
vaccinationNameString[SELECT]DBカラム:vaccination.vaccinationName
discriptionString[SELECT]DBカラム:vaccination.discription
injectCountNumber[SELECT]DBカラム:vaccination.injectCount
vaccineTypeString[SELECT]DBカラム:vaccination.vaccineType
regularBoolean[SELECT]DBカラム:vaccination.regular
girlsOnlyBoolean[SELECT]DBカラム:vaccination.girlsOnly

処理結果ステータス

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

補足事項

登録されているワクチンについては「ワクチン一覧」を参照ください。

戻る