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-Type	application/json
Authorization	取得したtokenId

リクエストデータ

JSON Key	型	必須	値の説明
tenantId	String	○	[WHERE]DBカラム：children.tenantId
childId	String	○	[WHERE]DBカラム：children.childId

レスポンスデータ

JSON Key	型	必須	値の説明
vaccine	Vaccine[]	○	予防接種(ワクチン)情報一覧

Vaccine

JSON Key	型	必須	値の説明
vaccinationId	String	○	[SELECT]DBカラム：vaccination.vaccinationId
vaccinationName	String	○	[SELECT]DBカラム：vaccination.vaccinationName
discription	String	○	[SELECT]DBカラム：vaccination.discription
injectCount	Number	○	[SELECT]DBカラム：vaccination.injectCount
vaccineType	String	○	[SELECT]DBカラム：vaccination.vaccineType
regular	Boolean	○	[SELECT]DBカラム：vaccination.regular
girlsOnly	Boolean	○	[SELECT]DBカラム：vaccination.girlsOnly

処理結果ステータス

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

補足事項

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

＞戻る