7.11 - 7.20
Table of contents
- 7.11 Get_HintInfo
- 7.12 Auth_Hint
- 7.13 Get_NewPassword
- 7.14 Set_OldPoint(未使用)
- 7.15 Get_AgrFlg(LCVアプリ専用)
- 7.16 Set_AgrFlg(LCVアプリ専用)
- 7.17 Get_ProductCategory
- 7.18 Get_MeishoCategory
- 7.19 Get_Shops
- 7.20 Set_PointMst
7.11 Get_HintInfo
概要
パスワードを忘れた時のヒント一覧を取得する。
URL
https://(指定されたURL)/Get_HintInfo.aspx
Request
| 必須 | 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|---|
| なし |
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | String | 200 | ステータス内容 |
| Hints | (class) | ヒントリスト(配列) | |
| HintCode | String | 30 | ヒントCD |
| HintValue | String | 100 | ヒントの内容(例:母親の旧姓は?) |
実行例 http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Get_HintInfo.aspx
結果例
成功)
{"StatusCode":0,"Status":"OK","Hints":[{"HintCode":"01","HintValue":"母親の旧姓は?"},{"HintCode":"02","HintValue":"お気に入りの本は?"}]}
失敗)
{"StatusCode":"-41001","Status":"ヒントリストがありません"}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -41001 | ヒントリストがありません |
| -41002~-41099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_MEISHO | 参照のみ(名称区分=HNT) |
7.12 Auth_Hint
概要
名前、メールアドレスを指定して、パスワード忘れ時のヒントを取得する。
URL
https://(指定されたURL)/ Auth_Hint.aspx
Request
| 必須 | 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|---|
| ○ | name | string | 100 | 顧客が設定した名前 |
| ○ | string | 200 | 顧客が設定したEmail | |
| uuid | string | 300 | 端末固有ID |
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | string | 200 | ステータス内容 |
| Code | string | 30 | 顧客CD |
| HintCode | String | 30 | ヒントCD |
| HintValue | String | 100 | ヒントの日本語(例:母親の旧姓は?) |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Auth_Hint.aspx?Name=********&Email=********&uuid=000111222eeefff
結果例
成功)
{"StatusCode":0,"Status":"OK","Code":"1234","HintCode":"02","HintValue":"お気に入りの本は?"}
失敗)
{“StatusCode”:“-42002”,“Status”:“該当顧客が存在しません”,”Code”:null,”HintCode”:null,”HintValue:null}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -42001 | パラメータが不足しています |
| -42002 | 該当顧客が存在しません |
| -42003 | 該当顧客が複数存在します |
| -42004~-42099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_KOKYAKU_LOGIN | 参照のみ |
7.13 Get_NewPassword
概要
パスワード忘れ時のヒントと答えが適合したら、新しいパスワードを発行、取得する。
URL
https://(指定されたURL)/Get_NewPassword.aspx
Request
| 必須 | 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|---|
| ○ | Code | string | 30 | 顧客CD |
| ○ | hintcode | String | 30 | ヒントCD |
| ○ | Hintans | String | 100 | ユーザが入力したヒントへの答え |
| ○ | Uuid | string | 300 | 端末固有ID |
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | string | 200 | ステータス内容 |
| LoginId | string | 200 | ユーザのログインID |
| Password | string | 200 | 新しく発行したパスワード |
| TokenID | string | 64 | TokenID (ログイン済みにする場合はTokenIDを返す必要があります) |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Get_NewPassword.aspx?code=***&hintcode=01&hintans=xxxxxx&uuid=xxxxx
結果例
成功)
{"StatusCode":0,"Status":"OK","LoginId":"894","Password":"V1Rqn4ji5uI1","TokenID":"6a888e4837ed3796507894e60318afdff8fc799ac73"}
失敗)
{“StatusCode”:“-43002”,“Status”:“該当顧客が存在しません”}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -43001 | パラメータが不足しています |
| -43002 | 該当顧客が存在しません |
| -43003 | ヒントコードが違います |
| -43004 | ヒントの答えが違います |
| -43005 | 顧客ログインマスタ更新エラー |
| -43006~-43099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_KOKYAKU_LOGIN | 参照、更新(PASS : 新規生成されたパスワード, UUID : 入力パラメータuuid) |
7.14 Set_OldPoint(未使用)
概要
旧PVの移行用ポイント残高テーブルからカード番号かメールアドレスを指定してポイントを移行する。
URL
https://(指定されたURL)/Set_OldPoint.aspx
Request
| 必須 | 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|---|
| ○ | Code | string | 30 | 顧客CD |
| ○ | Oldcard | string | 30 | 旧PVに登録してあるカード番号(空白であれば無視) |
| ○ | Oldmail | string | 200 | 旧PVに登録してあるメールアドレス(空白であれば無視) |
| ○ | Flag | int | 1 | 0:ステータスチェックのみ、 1:ポイント移行を実行 |
※oldcard と oldmail の両方とも1文字以上の文字列が指定されていた場合、oldcardを優先する
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | string | 200 | ステータス内容 |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Set_OldPoint.aspx?code=********&oldcard=******&oldmail=&flag=1
結果例
成功)
{"StatusCode":0,"Status":"210ポイント移行しました"}
失敗)
{“StatusCode”:“-44002”,“Status”:“該当顧客が存在しません”}
Status
| StatusCode | Status |
|---|---|
| 0 | [FLAG=0の場合] {0}ポイントあります [FLAG=1の場合] {0}ポイント移行しました |
| -44001 | パラメータが不足しています |
| -44002 | 該当顧客が存在しません |
| -44003 | ポイント移行は1回しか行えません |
| -44004 | 移行対象のポイントがありません |
| -44005 | 既にポイント移行済みになっています |
| -44006~-44099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_KOKYAKU_LOGIN | 参照 |
| HC$TRAN_POINT_RIREKI | 追加(顧客CD = HC$master_kokyakuの顧客CD, ランク = HC$master_kokyakuのポイントランク,ポイント計上日 = api実行日, 取引区分= 99, 発生区分= 6, 付与ポイント数= HC$OLD_POINTのPoint, 備考 = ‘ポイント移行’) |
| HC$POINT_REAL | 追加 or 変更 Realポイント : HC$OLD_POINTのPoint数を加算 |
| HC$OLD_POINT | 参照、変更(移行FLG= 1,移行日= api実行日時 “yyyyMMdd HHmmss”, 新LCVID= 顧客CD,予備01= UserAgent (最大190桁), 予備02= 端末IPアドレス, 予備03= 追加したHC$tran_point_rirekiのseq_no) |
| HC$MASTER_KOKYAKU | 参照、変更 (会員登録日 = api実行日,最終更新日 = api実行日) 顧客区分が0のときのみ : 顧客区分 = 9 |
7.15 Get_AgrFlg(LCVアプリ専用)
概要
顧客CDを送信しその顧客CDの規約Flgを取得する。
<br> ※LCVスマートフォンアプリ専用のため、他システムより使用する場合は要相談
URL
https://(指定されたURL)/ Get_AgrFlg.aspx
Request
| 必須 | 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|---|
| ○ | Code | string | 30 | 顧客 CD |
新規作成の場合はSet_LoginInfoのResponseから顧客CDを取得する
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | string | 200 | ステータス内容 |
| AgrFlg | string | 1 | 規約FLG 0 規約未同意 1 規約同意済 |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Get_AgrFlg.aspx?code=********
結果例
成功)
{“StatusCode”:“0”,“Status”:“OK”,”AgrFlg”.”0” }
失敗)
{“StatusCode”:“-44002”,“Status”:“内部エラー”}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -8002 | 顧客CDが存在しません |
| -44006~-44099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_KOKYAKU | 参照 |
7.16 Set_AgrFlg(LCVアプリ専用)
概要
顧客CDを送信し、その顧客の規約FLGを1に変更する。
<br> ※LCVスマートフォンアプリ専用のため、他システムより使用する場合は要相談
URL
https://(指定されたURL)/Set_AgrFlg.aspx
Request
| 必須 | 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|---|
| ○ | Code | string | 30 | 顧客CD |
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | string | 200 | ステータス内容 |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/Set_AgrFlg.aspx?code=********
結果例
成功)
{“StatusCode”:“0”,“Status”:“OK”}
失敗)
{“StatusCode”:“-34004”,“Status”:“他で修正されているため更新できません。”}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -34001 | パラメータが不足しています。 |
| -34004 | 他で修正されているため更新できません。 |
| -34005~-34099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_KOKYAKU | 修正 |
7.17 Get_ProductCategory
概要
商品マスタの各カテゴリ一覧を取得する。
URL
https://(指定されたURL)/Get_ProductCategory.aspx
Request
| 属性 | 最大桁数 | 摘要 | ||
|---|---|---|---|---|
| ○ | Kubun | string | 3 | BRD, ITM, B01-B06 商品分類を示すいずれかの3桁文字列 |
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | String | 200 | ステータス内容 |
| Category | (class) | カテゴリリスト(配列) | |
| KubunCode | String | 3 | 分類CD (BRD, ITEM, B01-B06 etc) |
| KubunName | String | 100 | 分類名 (ブランド、アイテムなど) |
| MeishoCode | String | 14 | 名称CD |
| MeishoName | String | 100 | 名称 (ジャケット、アクセサリなど) |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/ Get_ProductCategory.aspx?Kubun=BRD
結果例
成功)
{"StatusCode":0,"Status":"OK","Category":[{"KubunCode":"BRD","KubunName":"ブランド”,”MeishoCode”:”001”,MeishoName:”グッチ”},
{"KubunCode":"BRD","KubunName":"ブランド”,”MeishoCode”:”002”,MeishoName:”ヴィトン”}]}
失敗)
{"StatusCode":"-45001","Status":"該当区分がありません"}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -45001 | 該当区分がありません |
| -45002~-45099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_MEISHO | 参照のみ(名称区分=BRD, ITEM, B01-B06) |
7.18 Get_MeishoCategory
概要
名称マスタの各カテゴリ一覧を取得する。
URL
https://(指定されたURL)/Get_MeishoCategory.aspx
Request
| 属性 | 最大桁数 | 摘要 | ||
|---|---|---|---|---|
| ○ | Kubun | string | 3 | K01-K10など3桁文字列 (K01-10は顧客のDivision1-10、PRKはポイントランク) |
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | String | 200 | ステータス内容 |
| Category | (class) | カテゴリリスト(配列) | |
| KubunCode | String | 3 | 分類CD (K01-K10,PRK etc) |
| KubunName | String | 100 | 分類名 (ポイントランク、DM有無など) |
| MeishoCode | String | 14 | 名称CD |
| MeishoName | String | 100 | 名称 (ジャケット、アクセサリなど) |
| Option1 | String | 100 | 予備項目1 (PRKの場合、次のポイントランク必要金額) |
| Option2 | String | 100 | 予備項目2 |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/ Get_MeishoCategory.aspx?Kubun=PRK
結果例
成功)
{"StatusCode":0,"Status":"OK","Category":[{"KubunCode":"PRK","KubunName":"ポイントランク”,”MeishoCode”:”1”,MeishoName:”未使用”,Option1:”99999999”,
Option2:””},{"KubunCode":"PRK","KubunName":"ポイントランク”,”MeishoCode”:”2”,MeishoName:”ブラック会員” ,Option1:”99999999”,Option2:””},
{"KubunCode":"PRK","KubunName":"ポイントランク”,”MeishoCode”:”3”,MeishoName:”プラチナ会員” ,Option1:”200001”,Option2:””},
{"KubunCode":"PRK","KubunName":"ポイントランク”,”MeishoCode”:”4”,MeishoName:”ゴールド会員” ,Option1:”50001”,Option2:””},
{"KubunCode":"PRK","KubunName":"ポイントランク”,”MeishoCode”:”5”,MeishoName:”一般会員” ,Option1:”0”,Option2:””}]}
失敗)
{"StatusCode":"-46002","Status":"システムエラー"}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -46002~-46099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_MEISHO | 参照のみ |
・補足説明
Kubun = PRK の場合、Option1にはそのポイントランクに必要な累計購買金額がセットされる。
ランクは5が最も低く, 1が最も高い(固定)。
上記の結果例では、ランク5の一般会員は0がセットされているので必要累計購買金額は0円、
ランク4のゴールド会員は50001円以上で次のランク3は 200001円なので、ランク4ゴールド会員は50,001円-200,000円までの累計購買金額の顧客が該当する。
この情報と、Get_UserInfoで取得できる顧客情報のランク(Rank)、累計購入金額(TotalSalesAmount)を比較することで、次のランクアップまでの必要金額が 算出される。(顧客情報Rankの値-1に等しいMeishoCode値のOption1の金額と累計購入金額TotalSalesAmountの比較)
Kubun = IDX の場合、分類コード、分類名の一覧を返す。
指定した区分が存在しないか、データが一件もない場合、おなじ「該当区分がありません」
エラーを返す。
7.19 Get_Shops
概要
店舗マスタの一覧を取得する。
URL
https://(指定されたURL)/Get_Shops.aspx
Request
| 属性 | 最大桁数 | 摘要 | ||
|---|---|---|---|---|
| なし |
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | String | 200 | ステータス内容 |
| Shops | (class) | 店舗リスト(配列) | |
| Code | String | 8 | 店舗CD |
| Name | String | 100 | 店舗名 |
| Kana | String | 80 | カナ名称 |
| Ryaku | String | 80 | 略称 |
| Postalcode | string | 30 | 郵便番号 |
| Address1 | string | 300 | 住所1 (都道府県) |
| Address2 | string | 300 | 住所2 |
| Address3 | string | 300 | 住所3 |
| Tel | string | 40 | TEL |
| Fax | string | 40 | FAX |
| Memo1 | string | 240 | メモ1 |
| Memo2 | string | 240 | メモ2 |
| Memo3 | string | 240 | メモ3 |
| Memo4 | string | 240 | メモ4 |
| Memo5 | string | 240 | メモ5 |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/ Get_Shops.aspx
結果例
成功)
{"StatusCode":0,"Status":"OK","Category":[{"Code":"00020003",”Name”:"ショップODA清水店",”Kana”:””, ”Ryaku”:””, ”PostalCode”:”1120001”,
“Address1”:”東京都”, “Address2”:”港区赤坂”, “Address3”:”2-2-1ABCビル”,”TEL”:”0312342222”,”FAX”:”0312342223”,”Memo1”:””,…..}]}
失敗)
{"StatusCode":"-47099","Status":"システムエラー"}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -47001~-47099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_TOKUI | 参照のみ |
7.20 Set_PointMst
概要
ポイントマスタを登録・修正・削除する。
URL
https://(指定されたURL)/Set_PointMst.aspx
Request
| 必須 | 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|---|
| ○ | Mode | string | 1 | 処理種別を表す1文字。 C:登録、M:修正,D:削除 |
| ○ | Code | string | 20 | ポイントCD |
| Name | string | 200 | クーポン名 (登録時必須) | |
| Memo | string | 1000 | クーポン説明 (登録時必須) | |
| StartDate | string | 14 | 利用開始日 (登録時必須) | |
| EndDate | string | 14 | 利用終了日 (登録時必須) | |
| Count | number | 10 | 利用回数 (0:無制限,1-n 利用回数) (登録時必須) | |
| DiscountAmount | number | 10 | 割引額 | |
| DiscountRate | number | 10 | 割引率 (nn %) | |
| AddPoint | number | 10 | 付与ポイント | |
| Brand | string | 80 | ブランド | |
| Item | string | 80 | アイテム | |
| Hinban | string | 80 | 品番 | |
| Bunrui1 | string | 80 | 商品分類1 | |
| Bunrui2 | string | 80 | 商品分類2 | |
| Bunrui3 | string | 80 | 商品分類3 | |
| Bunrui4 | string | 80 | 商品分類4 | |
| Bunrui5 | string | 80 | 商品分類5 | |
| Bunrui6 | string | 80 | 商品分類6 |
Response
| 名前 | 属性 | 最大桁数 | 摘要 |
|---|---|---|---|
| StatusCode | int | 6 | ステータスコード |
| Status | string | 200 | ステータス内容 |
実行例
http://ap01.dtpnet.co.jp:85/cv.net_adi-mo/isql/api/ Set_PointMst.aspx?Mode=C&Code=1234567890123&Name=秋セールクーポン&********
結果例
成功)
“StatusCode”:“0”,“Status”:“OK”}
失敗)
{“StatusCode”:“-48001”,“Status”:“コードが重複しています。”}
Status
| StatusCode | Status |
|---|---|
| 0 | OK |
| -48001 | コードが重複しています。 (mode=Cの場合) |
| -48002 | 対象データがありません。 (mode=M,Dの場合) |
| -48003~-48099 | 内部エラー: (エラー内容詳細) |
使用テーブル
| テーブル名 | 内容 |
|---|---|
| HC$MASTER_COUPON | 追加、修正、削除 |
