SMPの企業情報を参照するためのAPIです。 企業情報には、SMPでデフォルト設定されている基本項目と、SMPの管理画面から追加可能な追加項目が含まれます。
company.get
| メソッド | URL |
|---|---|
| GET | https://{domainname}/services/rest/company |
| パラメータ名 | 必須 | 内容 |
|---|---|---|
| search_key{cid} | オプション | 検索条件のキー項目 指定可能なキー項目は下記「検索条件に指定可能なカラム」参照 |
| search_operator{cid} | オプション | “検索条件の比較演算子を指定 eq( = ), ne( != ), ge( >= ), gt( > ), le( <= ), lt( < ), like” |
| search_value{cid} | オプション | 検索値 Nullを指定する場合は、何も指定しません。 例： search_value1= |
| order | オプション | 並び順の項目 指定可能な並び順の項目は下記「検索条件・並び順に指定可能なカラム」参照 |
| direction | オプション | 並び順を指定する 「asc」（昇順）または「desc」（降順） |
| limit | オプション | 1回のリクエストで取得するレコード数 （最大1000） |
| offset | オプション | レコードのオフセット |
####検索条件・並び順に指定可能なカラム
| カラム名 | 検索条件 | 並び順 | 内容 |
|---|---|---|---|
| Id | ○ | ○ | 企業ID |
| DateRegist | ○ | ○ | システム登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| DateUpdate | ○ | ○ | システム更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| Name | ○ | ○ | 企業名 |
| NameKa | ○ | ○ | 企業名フリガナ |
| Zip1 | ○ | ○ | 郵便番号1 |
| Zip2 | ○ | ○ | 郵便番号2 |
| Zip3 | ○ | ○ | 郵便番号3 |
| Country | ○ | × | 国名 |
| Prefecture | ○ | × | 都道府県 |
| Address1 | ○ | ○ | 住所1 |
| Address2 | ○ | ○ | 住所2 |
| Address3 | ○ | ○ | 住所3 |
| Address4 | ○ | ○ | 住所4 |
| Address5 | ○ | ○ | 住所5 |
| Tel | ○ | ○ | 電話番号 |
| SubTel | ○ | ○ | 電話番号予備 |
| Fax | ○ | ○ | ファックス番号 |
| EmailDomain | ○ | ○ | メールドメイン |
| DateOfEstablishment | ○ | ○ | 設立 |
| Url | ○ | ○ | URL |
| Attribute{aid} | ○ | ○ | 追加項目 追加項目について/追加項目のデータ型参照 |
なし
なし
| コード | 内容 |
|---|---|
| 200 | 正常終了 |
なし
★ エレメント名：Company ★ データ型：CompanyType
| カラム名 | データ型 | 内容 |
|---|---|---|
| Id | string | 企業ID |
| DateRegist | dateTime | システム登録日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| DateUpdate | dateTime | システム更新日時(JST) YYYY-mm-ddTHH:MM:SS+09:00 |
| Name | string | 企業名 |
| NameKa | string | 企業名フリガナ |
| Zip1 | string | 郵便番号1 |
| Zip2 | string | 郵便番号2 |
| Zip3 | string | 郵便番号3 |
| Country | CountryType | 国名 CountryId : CountryName |
| Prefecture | PrefectureType | 都道府県IDと都道府県名の対応表参照 |
| Address1 | string | 住所1 |
| Address2 | string | 住所2 |
| Address3 | string | 住所3 |
| Address4 | string | 住所4 |
| Address5 | string | 住所5 |
| Tel | string | 電話番号 |
| SubTel | string | 電話番号予備 |
| Fax | string | ファックス番号 |
| EmailDomain | string | メールドメイン |
| DateOfEstablishment | string | 設立 |
| Url | string | URL |
| Attribute{aid} | ー | 追加項目 追加項目について/追加項目のデータ型参照 |
なし
<?xml version="1.0" encoding="UTF-8"?>
<CompanyList xmlns="http://smartseminar.jp/" version="1.57">
<Company>
<Id>2116</Id>
<Attribute54>1234567890</Attribute54>
<SubTel>04-1234-5678</SubTel>
<Attribute52List>
<Attribute52>1</Attribute52>
<Attribute52>2</Attribute52>
</Attribute52List>
<DateRegist>2019-02-27T12:47:40+09:00</DateRegist>
<Attribute51>2</Attribute51>
<NameKa>テストキギョウ１</NameKa>
<DateOfEstablishment>2019-02-01</DateOfEstablishment>
<Address1>港区三田3丁目１３</Address1>
<Attribute53>1</Attribute53>
<DateUpdate>2019-02-27T12:47:40+09:00</DateUpdate>
<Zip1>123</Zip1>
<CountryId>
<CountryIdName>Japan</CountryIdName>
<CountryIdId>108</CountryIdId>
</CountryId>
<PrefectureId>
<PrefectureIdName>東京都</PrefectureIdName>
<PrefectureIdId>10</PrefectureIdId>
</PrefectureId>
<EmailDomain>example.com</EmailDomain>
<Address2>テストビル12F</Address2>
<Attribute49>テストテキスト</Attribute49>
<Attribute50>テストテキストエリア
です</Attribute50>
<Zip2>4567</Zip2>
<Url>https://example.com</Url>
<Tel>03-1234-5678</Tel>
<Name>テスト企業１</Name>
<Fax>03-1234-5678</Fax>
</Company>
</CompanyList>
なし