Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Contents

Table of Contents
maxLevel3
minLevel2
exclude.*Contents.*

Get Issuances

...

For an Incentive Code

Code Block
GET /companies/:id/incentives/codes/:code/issuances

...

Data ElementRequiredDescription

external_issuee_id

NoUnique external issuee idID.
codeNo

If provided, a specific code is issued.

referring_application

Only in pools requiring a campaign_registration.Application issuing the code.

referring_application_ref_id

Only in pools requiring a campaign_registration.Application reference idID.

Response

It returns an issuance entity if there was an available code.

An HTTP error code 422 is returned if there are not enough available codes to issue.

Code Issuance

The same code is issued when using the same issuee_id. An issuance entity is created after each successful issuance request.

...