アカウントの作成と編集
説明
UserManageの メソッドは、エンドユーザーアカウントの作成と編集を行います。これは、ほぼすべてのエンドユーザーの詳細を満たすために、できるだけ多用途に設計しております。
クライアントの固有識別子であるclientUserIdは、コールアウトを成功させるために唯一必要な情報(clientIdおよびapiPassword)です。Note:clientUserIdを使用してエンドユーザーを特定する場合、Eメールは一意である必要はありません。アカウントの一意の識別子としてclientUserIdを使用するには、eSuiteの設定を変更する必要があります。ご希望の方法でカスタマーサポートにお問い合わせください。お客様のクライアントIDは適宜設定されます。
このAPIメソッドへのリクエストが成功すると、ログインしているユーザーのセッショントークン、つまり32文字の英数字GUIDが返されます。
リクエスト
C#
[csharp]
using (eDeveloperClient client = new eDeveloperClient())
{
var request = new UserManageRequest()
{
clientId = 433,
apiPassword = "lP?35oS=dR",
clientUserId = "20160106_433",
emailAddress = "JohnSmith@mppglobal.com",
userPassword = "JonsPassword123"
};
var response = client.UserManage(request);
}
[/csharp]
{
var request = new UserManageRequest()
{
clientId = 433,
apiPassword = "lP?35oS=dR",
clientUserId = "20160106_433",
emailAddress = "JohnSmith@mppglobal.com",
userPassword = "JonsPassword123"
};
var response = client.UserManage(request);
}
[/csharp]
リクエストパラメータ
次の表は、UserManageに提供する必要がある引数の一覧です。また、必須の引数も識別します。
| 名称 | データー タイプ |
説明 | 必須か? | 値の例 |
|---|---|---|---|---|
| ClientId | Integer | インテグレーションで一意に識別する目的でeSuiteから提供されます。 | Yes | 433 |
| ApiPassword | String | 割り当てられたWebサービスのパスワード。 | Yes | lP?35oS=dR |
| EmailAddress | String | 顧客がeSuiteプラットフォームにアカウントを登録したアドレス。 | No | Smith@mppglobal.com |
| NewEmailAddress | String | 既存のアカウントのメールアドレスを編集するために使用。 | No | JSmith@mppglobal.com |
| UserPassword | String | 第三者認証システムによって顧客アカウントに割り当てられた一意の識別子 | No | ze35oSdr |
| ClientUserId | String | 第三者認証システムによって顧客アカウントに割り当てられた一意の識別子 | Yes | 000021 |
| Title | String | エンドユーザーのタイトル(Mr、Mrs、Missなど) | No | Mr |
| FirstName | String | エンドユーザーの名前 | No | John |
| Surname | String | エンドユーザーの姓 | No | Smith |
| DateOfBirth | String | エンドユーザーの生年月日 | No | 11/08/1989 |
| NoMarketingInformation | Boolean | ユーザーがマーケティング情報を受け取ることを選択した場合は、falseに設定します。 | No | 0 |
| MaidenName | String | エンドユーザの母親の旧姓は、セキュリティ上の質問として使用されます。 | No | Gemma |
| MemorablePlace | String | エンドユーザーへのセキュリティ上の質問 | No | Chester |
| Gender | enum | エンドユーザーの性別 | No | Male |
| MobilePhoneNumber | String | エンドユーザの携帯電話番号 | No | 07812911581 |
| HomePhoneNumber | String | エンドユーザの電話番号 | No | 01612374891 |
| HomeHouseName HomeHouseFlatNumber HomeStreet HomeDistrict HomeTownCity HomeCounty HomePostcode HomeCountry |
String | エンドユーザーの住所 | No | Grove Avenue, Huyton, Liverpool, Merseyside, L16 8TY, United Kingdom |
| AccountTypeId | String | アカウントタイプを使用しない場合は0に設定し、そうでない場合は、このアカウントを設定するアカウントタイプのIDを渡します。 | No | 0 |
| NewUsersPassword | String | 更新されたユーザーのパスワード値 | No | iu8ytgy |
| InvoiceHouseName InvoiceHouseFlatNumber InvoiceStreet InvoiceDistrict InvoiceTownCity InvoiceCounty InvoicePostcode InvoiceCountry |
String | エンドユーザーのインボイスの住所 | No | Grove Avenue, Huyton, Liverpool, Merseyside, L16 7TY, United Kingdom |
| CustomAccountParameters[] | AccountParameterオブジェクトのコレクション | アカウントに対して設定するカスタム用のアカウント詳細のパラメータ、 又はカスタム用としてClientUserIdsを使用する場合は、コールのアカウントを識別するために使用します。 |
No | |
| socialServiceUserCredentials | A SocialServiceUserIdentifier object | ログインのために使用しているソーシャルサイトのユーザーの識別子。 | No | |
| AccountVerified | Boolean | アカウントが確認済みかどうか | No | 1 |
| Guid | String | ログインしているユーザーのセッショントークン | No | 2d30921d47e544e4 997477d2f7948bee |
| AutoPopulateClientUserId | Boolean | ClientUserIdが渡されず、これがtrueの場合、ClientUserIdはMPPアカウントIDと同じに設定されます。 trueに設定されていても、ClientUserIdが渡されない場合、エラーが発生します | No | 1 |
| IpAddress | String | エンドユーザのIPアドレス | No | 127.0.0.1 |
| NewUser | Boolean | trueに設定すると、渡されたEメールが一意の場合は新しいユーザーを作成し、falseに設定されている場合で、Eメールが既に存在する場合は既存のユーザーの詳細を更新します | No | 1 |