安否確認API

Overview

本APIは安否確認の集計の閲覧/開始/完了、ユーザの回答状況確認及び発信をすることができます。
-安否確認API（登録）
-安否確認API（集計一覧）
-安否確認API（状況確認）
-安否確認API（発信）
-安否確認API（完了）

　安否確認API（登録）

POST https://api.ntt.com/v1/anpi/register/safety/

安否確認を集計できる災害情報を登録します。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

POST https://api.ntt.com/v1/anpi/register/safety/
{
   "title": "APITEST",
   "text": "0123456789",
  "strdate": "201812311830"
 }

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

異常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Result

{
  "resultCount": 1,
  "tid": A000000,
  "useCount": 8,
  "contractCount": -1
}

戻る

　安否確認API（集計一覧）

GET https://api.ntt.com/v1/anpi/confirm/safety/

登録されている安否確認の集計一覧を取得します。
一度に取得できる情報は最大1,000件までとなります。

Request Parameters

URL Path Parameter

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

GET https://api.ntt.com/v1/anpi/confirm/safety/?offset=10&limit=10

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

異常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Result

{   
  "searchTotal": 200000,    
  "searchCount": 10,    
  "nextOffset": 10, 
  "useCount": 4365762,  
  "contractCount": -1,  
  "thrdiList": [    
    {   
      "tid": "A000000", 
      "title": "災害発生",  
      "text": "地震が発生しました。速やかに安全を確保したのちに回答を願います。",   
      "strdate": "201904031409",    
      "endflg": "1" 
      "atendpldate": "201907031409"
      "trngflg": "1"        
    },  
    {   
      "tid": "A000001", 
      "title": "災害発生",  
      "text": "昨日に続き地震が発生しました。昨日回答した人も改めて安全を確保したのちに回答を願います。",   
      "strdate": "201904031410",    
      "endflg": "0" 
      "atendpldate": "201907031410"
      "trngflg": "1"    
    }   
 ]  
}

戻る

　安否確認API（状況確認）

POST https://api.ntt.com/v1/anpi/confirm/safety-status/

安否確認へのユーザ回答状況を確認できます。
一度に確認できる情報は最大5,000件までとなります。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

POST https://api.ntt.com/v1/anpi/confirm/safety-status/
{
    "tid": A000001
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

異常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Result

{
  "searchTotal": 200000,
  "searchCount": 10,
  "nextOffset": 10,
  "useCount": 4365765,
  "contractCount": -1,
  "tid": "0000019",
  "title": "DR TEST",
  "text": "TEST",
  "strdate": "201901251917",
  "questList": [
    {
      "questnum": 1,
      "quest": "本人の安否",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "無事"
        },
        {
          "ans": "02",
          "ansmsg": "負傷"
        }
      ]
    },
    {
      "questnum": 2,
      "quest": "家族の安否",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "無事"
        },
        {
          "ans": "02",
          "ansmsg": "負傷"
        },
        {
          "ans": "03",
          "ansmsg": "不明"
        }
      ]
    },
    {
      "questnum": 3,
      "quest": "家屋の状況",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "無事"
        },
        {
          "ans": "02",
          "ansmsg": "損傷"
        },
        {
          "ans": "03",
          "ansmsg": "不明"
        }
      ]
    },
    {
      "questnum": 4,
      "quest": "出社可否",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "出社可能"
        },
        {
          "ans": "02",
          "ansmsg": "出社不可"
        },
        {
          "ans": "03",
          "ansmsg": "不明"
        }
      ]
    }
  ],
  "thrddList": [
    {
      "usrcd": "usr000001",
      "staffsei": "安否",
      "staffmei": "花子",
      "orgList": [
        {
          "orgpath": "/1stAAAA00001/",
          "orgpathnm": "1st組織00001"
        }
      ],
      "sendstatus": "1",
      "ansstatus": "1",
      "ansdate": "201901251928",
      "ansList": [
        "01",
        "01",
        "01",
        "01"
      ],
      "cmntkbn": null,
      "cmnt": null,
      "reglat": "35.6310162",
      "reglon": "139.7373535",
      "regdevice": "1",
      "regdate": "201901251928",
      "regusrcd": "usr000001",
      "regusrnm": "安否 花子",
      "readdate": "201901251928",
      "sendregdate": "201901251917"
    },
    {
      "usrcd": "usr000002",
      "staffsei": "安否",
      "staffmei": "太郎",
      "orgList": [
        {
          "orgpath": "/1stAAAA00001/",
          "orgpathnm": "1st組織00001"
        }
      ],
      "sendstatus": "7",
      "ansstatus": "4",
      "ansdate": null,
      "ansList": null,
      "cmntkbn": null,
      "cmnt": null,
      "reglat": null,
      "reglon": null,
      "regdevice": null,
      "regdate": null,
      "regusrcd": null,
      "regusrnm": null,
      "readdate": null,
      "sendregdate": "201901161810"
    }
  ]
}

戻る

　安否確認API（発信）

PUT https://api.ntt.com/v1/anpi/request/safety/

安否確認へのユーザへ発信処理を実行できます。
本APIは非同期処理になるので、発信結果は安否確認API（状況確認）でご確認ください。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

PUT https://api.ntt.com/v1/anpi/request/safety/
{
    "tid": "A000001",
    "sendkbn": "1",
    "allsendkbn": "1"
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

異常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Result

{
  "targetCount": 1,
  "useCount": 8,
  "contractCount": -1
}

戻る

　安否確認API（完了）

PUT https://api.ntt.com/v1/anpi/register/safety/

安否確認の集計を受付完了します。
本APIは非同期処理になるので、処理結果は安否確認API（集計一覧）でご確認ください。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

PUT https://api.ntt.com/v1/anpi/maintenance/organization/
{
    "tid": "0000019"
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

異常時

[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Result

{
  "targetCount": 1,
  "useCount": 8,
  "contractCount": -1
}

戻る