マーケティングプラットフォームの管理者情報を新規登録するためのAPIです。
admin.post
メソッド | URL |
---|---|
POST | https://{domainname}/services/rest/admin |
パラメータ名 | 必須 | 内容 |
---|---|---|
send_mail | オプション | send_mail=1を指定した場合には管理者情報登録後に、登録した管理者のEmailアドレス宛てに登録完了メールを送ります |
なし
★ エレメント名:AdminData ★ データ型:AdminDataType
カラム名 | データ型 | 内容 |
---|---|---|
AdminLevel | AdminLevelType | 管理者レベル AdminLevelId:AdminLevelName 2:特権管理者 3:キャンペーン管理者 |
LoginId | string | ログインID |
LoginPassword | string | ログインパスワード |
Name1 | string | 姓 |
Name2 | string | 名 |
Name3 | string | ミドルネーム |
Name1Ka | string | 姓フリガナ |
Name2Ka | string | 名フリガナ |
CompanyName | string | 会社名 |
CompanyNameKa | string | ※未使用 |
Division | string | 部署 |
Position | string | 役職 |
Tel | string | 電話番号 |
SubTel | string | 電話番号予備 |
Fax | string | ファックス番号 |
string | E-Mail アドレス | |
SubEmail | string | E-mailアドレス予備 |
Reserve1 | string | 予備1 |
Reserve2 | string | 予備2 |
Reserve3 | string | 予備3 |
Memo | string | メモ |
Language | LanguageType | 使用言語 LanguageId:LanguageName 1:日本語 2:英語 ※ 他言語も利用可能(SMP環境毎に異なるため、「設定」タブの「言語設定」に登録されている言語をご確認ください) |
NotificationType | NotificationTypeType | 通知メール(満席・残席・申込期限) NotificationTypeId:NotificationTypeName 1:配信しない 2:担当キャンペーンのみ配信する 3:全て配信する |
TimeZone | TimezoneType | タイムゾーンIDとタイムゾーン名の対応表参照 |
Group | GroupType | クループ GroupId:GroupName 1:特別管理者 2:キャンペーン管理者 |
LocalLogin | LocalLoginType | ※注1 直接ログイン LocalLoginId:LocalLoginName 0 許可しない 1 許可する |
SamlLogin | SamlLoginType | ※注1 外部IDプロバイダ経由のログイン SamlLoginId:SamlLoginName 0 許可しない 1 許可する |
SamlLoginNameId | String | ※注1 外部IDプロバイダ用ユーザ識別子 |
※注1 管理者シングルサインオン機能を有効にした場合のみ利用する項目
(管理者シングルサインオン機能を有効にしない場合は設定しないでください)
コード | 内容 |
---|---|
201 | 正常終了 |
パラメータ名 | データ型 | 内容 |
---|---|---|
Location | string | 登録されたリソースへのURL https://{domainname}/services/rest/admin/{id} |
なし
<?xml version='1.0' encoding='UTF-8'?>
<AdminData xmlns="http://smartseminar.jp/" version="1.24">
<AdminLevel>
<AdminLevelId>2</AdminLevelId>
<AdminLevelName>特権管理者</AdminLevelName>
</AdminLevel>
<CompanyName>テスト会社</CompanyName>
<Division>テスト部署</Division>
<Email>test@test.co.jp</Email>
<Fax>111-1111</Fax>
<Group>
<GroupId>1</GroupId>
<GroupName>特別管理者</GroupName>
</Group>
<Language>
<LanguageId>1</LanguageId>
<LanguageName>日本語</LanguageName>
</Language>
<LoginId>admin_login</LoginId>
<LoginPassword>adminlogin</LoginPassword>
<Memo>メモ</Memo>
<Name1>テスト</Name1>
<Name1Ka>テスト</Name1Ka>
<Name2>管理者</Name2>
<Name2Ka>カンリシャ</Name2Ka>
<NotificationType>
<NotificationTypeId>2</NotificationTypeId>
<NotificationTypeName>担当のキャンペーンのみ配信する</NotificationTypeName>
</NotificationType>
<Position>テスト役職</Position>
<Reserve1>テスト予備1</Reserve1>
<Reserve2></Reserve2>
<Reserve3></Reserve3>
<SubEmail></SubEmail>
<SubTel></SubTel>
<Tel>222-2222</Tel>
<LocalLogin>
<LocalLoginName>許可する</LocalLoginName>
<LocalLoginId>1</LocalLoginId>
</LocalLogin>
<SamlLogin>
<SamlLoginName>許可しない</SamlLoginName>
<SamlLoginId>0</SamlLoginId>
</SamlLogin>
<SamlLoginNameId>saml_id_0001</SamlLoginNameId>
</AdminData>
なし