基本コマンド構文

すべての WebSphere Commerce のショッピング・フローのコマンドには、以下の基本構文があります。

    http://host_name/path/Command?parameter1=value&parameter2=value&parameter3=value

以下は説明です:

この線路スタイルの構文図を読むには、左上隅から始めて、線を (線路と見なして) たどってください。以下の規則に留意してください:

  • host_name および path は、製品をインストールした方法によって判別されます。
  • コマンド名の後の区切り文字は ? です。連続しているパラメーター間の区切り文字は & です。先頭パラメーターの前には & を使用する必要はありません。
  • パラメーターの値は、一般に、構文図の中で、ストリングの場合は s で示されます。 パラメーターに事前定義されたコードが必要な場合、あるいはデータ・タイプに対して不明確な制限が課されている場合、そのことが説明内に明記されます。   
  • 線は左から右へとたどる一方、主線上にあるパラメーターで回避できないもの (URL など) がある場合には、これはそのパラメーターが必須であることを示しています。
  • パラメーターが主線上から外れていて (langId など)、回避できる場合には、そのパラメーターはオプションです。
  • パラメーターに左側に戻っている線がある (listId など) 場合には、そのパラメーターは、以下のように繰り返し使用できることを示しています。
  • &listId=1&listId=2&listId=3

    次の構文図は、必須パラメーターの代替セットの説明です: いずれかを使用してください:

    &logonId=s&challengeAnswer=s 

    または

    &logonPassword=s&logonPasswordOld=s&logonPasswordVerify=s
    

    次の構文図は、必須である場合もあるパラメーター memberId を示しています。 これは破線で図示されています。 OrgEntityAdd の説明で、いつパラメーターが必須であり、いつオプションであるかの説明が見つかります。

    パラメーター

    コマンドの大部分で利用可能な共通パラメーターが幾つかあります:

    storeId
    コマンドと特定ストアを関連付けます。これは、コマンドがストアの有効範囲内でしか作動しないように強制するので、これはモール・レベルで作動するコマンドで特に役立ちます。
    langId
    コマンドの継続中に使用される言語を指定します。 このパラメーターの値は LANGUAGE テーブルに保管されます。  指定される言語がサポートされる場合にはデフォルト言語が変更されます。 指定された言語がサポートされない場合には、ストアまたはサイトのデフォルト言語が使用されます。
    forUser
    別のユーザーによって行おうとしているアクション対象のユーザーのログオン ID を指定します。 このパラメーターを使用できるのは、 顧客サービス担当者、顧客サービス・スーパーバイザー、 オペレーション・マネージャー、 物流管理マネージャー、 マーチャント、 セラーなど、 オーダーを処理する権限がある個人だけです。  このパラメーターは、 顧客が購入の完了に際して援助を求めた場合のコール・センターでの設定に使用できます。  この場合、コール・センターのオペレーターがログインして、 コールしている顧客の ID を使用してオーダーを完了します。 
    forUserId
    forUser と同様ですが、ユーザーは USERS テーブル中にある内部ユーザー ID によって識別されます。
    URL
    コマンドの成功時に呼び出される Web アドレス。  このパラメーターの値は、以下によって決定されます。 まず、URL 以外のコマンドに対する入力パラメーターを指定します。 このコマンドによって生成される、追加の名前と値の対を追加します。 名前の競合が発生した場合には置き換えます。 最後に URL にある名前と値の対を追加します。名前の競合が発生した場合には置き換えます。


    例を表示するときに、URL がしばしば複数行にわたって表示されます。 読みやすくするために、それは以下のように調整されます。
         http://myhostname/webapp/wcs/stores/servlet/AddressUpdate?addressId=128
         &firstName=Jeffery&URL=/webapp/wcs/stores/servlet/


    URL コマンドは単一行に現れるのが普通であることに注意してください。

    関連参照

    IBM 著作権