ユーザー情報の取得(お子様・胎児の情報も含む)
リクエストされた認証トークンより、PostgreSQLに登録しているユーザーの情報を取得するAPI
取得に成功した場合は、レスポンスコード「200」として、レスポンスを返す。
取得に失敗した場合は、レスポンスコード「404」として、レスポンスを返す。
https://wc98g2pv03.execute-api.ap-northeast-1.amazonaws.com/GETUserInfo?tenantId={tenantId}
GET
DynamoDB
フィールド名 | 値 |
---|---|
Content-Type | application/json |
Authorization | POST User Auth で取得した userTokenId |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
tenantId | String | ○ | [WHERE]DBカラム:uesrs.tenantId |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
profile | Profile | ○ | プロフィール情報(ユーザー情報、ニックネーム情報) |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
user | User | ○ | ユーザー情報 |
baby | Baby | 胎児の情報(ニックネーム情報) | |
child | Child[] | お子様の情報(ニックネーム情報) |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
userId | String | [SELECT]DBカラム:users.userId | |
gender | String | ○ | [SELECT]DBカラム:users.gender ※デフォルト値は男 |
area | String | [SELECT]DBカラム:users.area | |
dateOfBirth | String | [SELECT]DBカラム:users.dateOfBirth |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
childId | String | [SELECT]DBカラム:children.childId | |
nickname | String | [SELECT]DBカラム:children.nickname | |
dueDate | String | [SELECT]DBカラム:children.dueDate | |
gender | String | [SELECT]DBカラム:children.gender |
JSON Key | 型 | 必須 | 値の説明 |
---|---|---|---|
childId | String | [SELECT]DBカラム:children.childId | |
nickname | String | [SELECT]DBカラム:children.nickname | |
dueDate | String | [SELECT]DBカラム:children.dueDate | |
gender | String | [SELECT]DBカラム:children.gender | |
dateOfBirth | String | [SELECT]DBカラム:children.dateOfBirth | |
fourVaccine | Boolean | [SELECT]DBカラム:children.fourVaccine |
ステータス | メッセージ |
---|---|
200 | OK |
400 | BAD REQUEST |
500 | INTERNAL SERVER ERROR |
認証方式に Bearer Token を選択して、POST User Auth で取得した Token をGETリクエストします。
ユーザー情報がJSON形式で返ってきます。
> 戻る