第7章営業所情報の取得

API名:
eigyousyo/info

概要:
リクエストされた営業所の情報を取得します。

URI:
https://ドメイン名/openapi/v1/eigyousyo/info

メソッド:
GET
API使用例:

Request URL: https://ドメイン名/openapi/v1/eigyousyo/info
Request Method: GET
Request Head:
    content-type: application/json
    Authorization:Bearer eyJ4NX…
本メソッドではパラメータの指定は不要です。
パラメータ
必須
データ型
デフォルト
説明
各レスポンスパラメータは下記の通りです。
パラメータ名
データ型
説明
status
Object
ステータス情報が入ります。
code
String
ステータスコードが入ります。
詳しい内容は状態コードとエラーを参照してください。
message
String
ステータス内容に関するメッセージが入ります。
詳しい内容は状態コードとエラーを参照してください。
results
Array
リクエスト結果の情報が入ります。
eigyousyoId
Integer
営業所IDが入ります。
eigyousyoCode
String
営業所コードが入ります。(数字8桁)
eigyousyoName
String
営業所名が入ります。
manager
String
担当者名が入ります。
address
String
営業所の住所が入ります。
tel
String
営業所の電話番号が入ります。
eMail
String
営業所担当者のメールアドレスが入ります。
postalCode
String
営業所の郵便番号が入ります。
comment
String
ITP-WebServiceV3で記載した備考欄の情報が入ります。
hasUserOrVehicle
Boolean
営業所への乗務員と車両の存在有無が入ります。
true:乗務員と車両のどちら、またはすべてある営業所
false:乗務員と車両のどちらもない営業所
deletef
Byte
削除済みの営業所である場合、情報が入ります。
0:削除済みでない
1:削除済
highEigyousyoId
Integer
上位営業所IDが入ります。

レスポンスの例:

{       
  "results":[
       {    
         "address": "111111111111221",        
         "comment": "",        
         "deletef": 0,        
         "eMail": "",        
         "eigyousyoCode": "00000001",        
         "eigyousyoId": 1,        
         "eigyousyoName": "本社",        
         "hasUserOrVehicle": true,
  "highEigyousyoId":null,
         "manager": "",        
         "postalCode": "20880897",        
         "tel": "889"        
    ],
    "status":{
       "code":"AF00E0000",
       "message":"success"
    }
  }