applyRecommendations: зөвлөмж хэрэглэх

Энэ арга зөвлөмжүүдийг ID-гаар нь хэрэглэж, хүссэн зөвлөмж бүрийн амжилт болон алдааны дэлгэрэнгүйг буцаана.

Параметрүүд

• `recommendationIds` — Хэрэглэх зөвлөмжүүдийн ID; Заавал; Array of strings; Хүчинтэй зөвлөмжийн ID байх бөгөөд нэг компанид хамаарах ёстой. Жишээ: "recommendationIds": [ "68480f4e11e8dc005bb0f9e7", "6853e32b4783f7a2f15582c4", "6853e32b4783f7a2f15582cf" ]

Ерөнхий параметрүүд

Эдгээр нь Public API-ийн бүх аргад нийтлэг параметрүүд юм.

• `id` — Хүсэлтийг тохирох хариутай нь холбох танигч нэмнэ. Хүлээн авагч хариунд ижил утгыг буцаадаг тул дуудлага бүрийг хялбар хянах боломжтой; Заавал; String; Нэмэлт шаардлагагүй. Жишээ: "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
• `method` — Хүсэлт илгээхэд ашиглаж буй аргын нэр; Заавал; String; Хүчинтэй аргын нэр байх ёстой. Жишээ: "method": "methodName"
• `jsonrpc` — Хүсэлт болон хариунд ашиглагдах JSON-RPC-ийн хувилбар; Заавал; Integer; Боломжит ганц утга нь 2.0. Жишээ: "jsonrpc": "2.0"
• `params` — Хүсэлтийн тохиргоог агуулсан объект; Заавал; Object; Нэмэлт шаардлагагүй. Жишээ: "params": {...}

params объект дотор:

• `page` — Үр дүнгийн хуудасны дугаар; Заавал биш; Integer; Анхны утга: 1.
• `perPage` — Нэг хуудсанд харуулах үр дүнгийн тоо; Заавал биш; Integer; Дээд хязгаар нь нэг хуудсанд 100 мөр. Анхны утга: 30.

Буцаах утга

• `appliedRecommendations` — Array of strings; Амжилттай хэрэглэгдсэн зөвлөмжүүдийн ID.
• `failedRecommendations` — Array of objects; Объект бүр хэрэглэж чадаагүй зөвлөмжийн мэдээллийг агуулна.

Объектууд

failedRecommendations

• `recommendationId` — String; Зөвлөмжийн ID.
• `error` — String; Зөвлөмжийг хэрэглэх үед гарсан алдааны тайлбар.
• `errorCode` — Integer; Алдааны код.

Жишээ

Хүсэлт:

{
  "params": {
    "recommendationIds": [
      "68480f4e11e8dc005bb0f9e7",
      "6853e32b4783f7a2f15582c4",
      "6853e32b4783f7a2f15582cf"
    ],
    "companyId": "67fe8595d4db0d536908ec92"
  },
  "jsonrpc": "2.0",
  "method": "applyRecommendations",
  "id": "b7e2c1d4-9f8a-4c2e-8b1a-ef1234567890"
}

Хариу:

{
  "id": "b7e2c1d4-9f8a-4c2e-8b1a-ef1234567890",
  "jsonrpc": "2.0",
  "result": {
    "appliedRecommendations": [],
    "failedRecommendations": [
      {
        "recommendationId": "68480f4e11e8dc005bb0f9e7",
        "error": "Recommendation already applied.",
        "errorCode": 3432
      },
      {
        "recommendationId": "6853e32b4783f7a2f15582c4",
        "error": "Recommendation already applied.",
        "errorCode": 3432
      },
      {
        "recommendationId": "6853e32b4783f7a2f15582cf",
        "error": "Recommendation not found.",
        "errorCode": 3432
      }
    ]
  }
}