PUT Child Info 解説

お子様情報を登録・更新・削除します

概要

リクエストされた認証トークンより、PostgreSQLに登録しているユーザーIDに紐付いている胎児・お子様の情報を更新するAPI
リクエストされた認証トークンを用いてユーザー認証を行い、成功した場合、対象ユーザーのデータを更新する
「deleteFlag」=「True」の場合、削除日時を現在日時で更新する。
更新に成功した場合は、レスポンスコード「200」として、レスポンスを返す。
更新に失敗した場合は、レスポンスコード「400」として、レスポンスを返す。

エンドポイント

https://97nzw2au8a.execute-api.ap-northeast-1.amazonaws.com/PUTChildInfo

メソッド

PUT

接続先

DynamoDB

リクエストヘッダー

フィールド名値
Content-Typeapplication/json
AuthorizationPOST User Auth で取得したuserTokenId

リクエストデータ

JSON Key型必須値の説明
tenantIdString○[WHERE]DBカラム：children.tenantId
childIdString○[WHERE]DBカラム：children.childId
deleteFlagBoolean削除 or 更新を判別するフラグ：削除の場合True
nicknameString[UPDATE]DBカラム：children.nickname
genderString[UPDATE]DBカラム：children.gender
dateOfBirthString△[UPDATE]DBカラム：children.dateOfBirth
※お子様の場合は必須
dueDateString△[UPDATE]DBカラム：children.dueDate
※胎児の場合は必須
fourVaccineBoolean[UPDATE]DBカラム：children.fourVaccine

処理結果ステータス

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

動作例

GET User Info で現在のユーザー情報を取得すると、"あかちゃん" と "こども" が登録されている。

ユーザー情報確認

認証方式に Bearer Token を選択して POST User Auth で取得した Token をヘッダにつける。
Body部分にJSON形式で更新したい項目を追加してPUTリスエストを送信。ここでは、"あかちゃん" を "赤ちゃん" に変更してPUTします。

更新

GET User Info で更新後のユーザー情報を取得すると、"あかちゃん" が "赤ちゃん" に更新されています。

更新確認

同様に、Body部分にJSON形式で追加こども情報を追加してPUTリスエストを送信します。
ここでは、"お姉ちゃん" を 追加してPUTします。

追加

GET User Info で更新後のユーザー情報を取得すると、"こども" の下に "お姉ちゃん" が追加されています。

追加確認

削除をしてみます。Body部分にJSON形式で削除したいこども情報を追加してPUTリスエストを送信します。
ここでは、"こども" を 削除してみます。

削除

GET User Info でユーザー情報を取得すると、"お姉ちゃん" の上にあった "こども" が削除されています。

削除確認

＞ 戻る