Баримт бичиг / API лавлах
Урамшуулал
Шимтгэлийн дүрэм.
GET/v1/workspaces/{workspaceId}/groups/{groupId}/rewards
Rewards of one group.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хариу: 200 RewardDto[]
POST/v1/workspaces/{workspaceId}/groups/{groupId}/rewards
Create a reward in a group (409 when the group already has that kind).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | path | string | тийм | |
Хүсэлтийн бие (CreateReward)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
kind | string | тийм | `click`, `lead`, `sale`, `referral`, `retainer`. |
scope | string | | `group` (default; one per kind and group) or `override` (a reward created to be used as a partner or link override). |
amountType | string | | `flat` (default) or `percentage`. |
amount | integer (int64) | | Flat: whole MNT. Percentage: basis points (1 percent = 100). Default 0. |
saleDurationMonths | integer (int32) | | |
lifetime | boolean | | |
referral | null | ReferralTerms | | |
retainer | null | RetainerTerms | | |
conditions | ConditionBlock[] | | |
description | string | | Headline, max 100 characters. |
tooltip | string | | Markdown tooltip, max 2000 characters. |
note | string | | Included in the partner notification (R69). |
Хариу: 201 RewardDto
PUT/v1/workspaces/{workspaceId}/links/{linkId}/discount
Set the link-level discount (R56).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм | |
Хүсэлтийн бие (DiscountInput)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
type | string | тийм | |
amount | integer (int64) | тийм | |
maxDurationMonths | integer (int32) | | |
note | string | | |
Хариу: 200 DiscountDto
DELETE/v1/workspaces/{workspaceId}/links/{linkId}/discount
Remove the link-level discount.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм | |
Хариу: 204
PUT/v1/workspaces/{workspaceId}/links/{linkId}/rewards/{kind}
Set the link-level reward of a kind.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм | |
kind | path | string | тийм | |
Хүсэлтийн бие (SetOverride)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
rewardId | string | тийм | A reward of the same kind (a group reward or one created with `scope: override`). |
note | string | | |
Хариу: 200 RewardDto
DELETE/v1/workspaces/{workspaceId}/links/{linkId}/rewards/{kind}
Remove the link-level reward.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
linkId | path | string | тийм | |
kind | path | string | тийм | |
Хариу: 204
PUT/v1/workspaces/{workspaceId}/partners/{partnerId}/discount
Set the partner-level discount (R56).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | path | string | тийм | |
Хүсэлтийн бие (DiscountInput)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
type | string | тийм | |
amount | integer (int64) | тийм | |
maxDurationMonths | integer (int32) | | |
note | string | | |
Хариу: 200 DiscountDto
DELETE/v1/workspaces/{workspaceId}/partners/{partnerId}/discount
Remove the partner-level discount.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | path | string | тийм | |
Хариу: 204
GET/v1/workspaces/{workspaceId}/partners/{partnerId}/overrides
Overrides of one partner and of its links, and who referred it.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | path | string | тийм | |
Хариу: 200 PartnerOverridesDto
POST/v1/workspaces/{workspaceId}/partners/{partnerId}/referrer
Attribute a referrer to a partner that has none (R45). Cannot be undone.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | path | string | тийм | |
Хүсэлтийн бие (SetReferrer)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
referrerPartnerId | string | тийм | The referring partner. |
backfill | boolean | | Also create referral commissions for qualifying past events (R45). |
Хариу: 204
PUT/v1/workspaces/{workspaceId}/partners/{partnerId}/rewards/{kind}
Set the partner-level reward of a kind (R17-R19, R22-R24).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | path | string | тийм | |
kind | path | string | тийм | |
Хүсэлтийн бие (SetOverride)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
rewardId | string | тийм | A reward of the same kind (a group reward or one created with `scope: override`). |
note | string | | |
Хариу: 200 RewardDto
DELETE/v1/workspaces/{workspaceId}/partners/{partnerId}/rewards/{kind}
Remove the partner-level reward (the group reward applies again).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
partnerId | path | string | тийм | |
kind | path | string | тийм | |
Хариу: 204
GET/v1/workspaces/{workspaceId}/program/override-summary
Partners that carry at least one override or a referrer.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 OverrideSummaryRow[]
GET/v1/workspaces/{workspaceId}/rewards
All rewards of the workspace.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
groupId | query | string | | |
scope | query | string | | `group` (default) or `override`. |
Хариу: 200 RewardDto[]
GET/v1/workspaces/{workspaceId}/rewards/overview
Every group of the program with its rewards and discount (the rewards editor's data).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 GroupRewards[]
GET/v1/workspaces/{workspaceId}/rewards/{rewardId}
One reward.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
rewardId | path | string | тийм | |
Хариу: 200 RewardDto
PATCH/v1/workspaces/{workspaceId}/rewards/{rewardId}
Edit a reward. Existing commissions are never rewritten (R70); the edit applies to events processed from now on (R71) and is recorded in the revision history (R72).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
rewardId | path | string | тийм | |
Хүсэлтийн бие (UpdateReward)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
amountType | string | | |
amount | integer (int64) | | |
saleDurationMonths | integer (int32) | | `null` clears (a sale reward then pays the first sale only). |
lifetime | boolean | | |
referral | null | ReferralTerms | | |
retainer | null | RetainerTerms | | |
conditions | array | | Replaces the whole ordered list. |
description | string | | `null` reverts to the generated text. |
tooltip | string | | |
note | string | | Message for the partners, kept in the revision history (R72). |
Хариу: 200 RewardDto
DELETE/v1/workspaces/{workspaceId}/rewards/{rewardId}
Delete a reward; 409 while overrides reference it (R20, R74). Past commissions remain.
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
rewardId | path | string | тийм | |
Хариу: 204
GET/v1/workspaces/{workspaceId}/rewards/{rewardId}/references
Partners and links that use the reward as an override (R20).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
rewardId | path | string | тийм | |
Хариу: 200 Reference[]
GET/v1/workspaces/{workspaceId}/rewards/{rewardId}/revisions
Edit history of a reward, newest first (R72).
Шаардлагатай API түлхүүрийн хамрах хүрээ: groups.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
rewardId | path | string | тийм | |
Хариу: 200 Revision[]