Versions Compared

Key

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

An Incentive Code Issuance issuance entity is a record of an Issuance of an Incentive Code.

...

The following is the JSON representation of an Incentive Code entity within the Application Program Interfaces ( APIs).

Code Block
{
  "id": 8,
  "external_issuee_id": "user@mycompany.com",
  "issuee_id": "0eef8961-7568-485b-9b13-fc7dbd1cf712",
  "referring_application": "system",
  "referring_application_ref_id": "1234",
  "incentive_code": {
    "code": "aabb-ccdd",
    "url": "/companies/:id/incentives/codes/:code"
  },
  "incentive_pool": {
    "id": 1,
    "url": "/companies/:id/incentives/pools/:pool_id"
  },
  "updated_at": "2017-02-13T18:34:36Z",
  "created_at": "2017-02-13T18:34:36Z"
}

...

Data ElementTypeDescription

id

Integer

Vibes unique identifier for each Issuanceissuance.

external_issuee_idStringUnique external issuee ID.
issuee_idStringVibes generated issuee ID.
referring_applicationStringApplication issuing the code.
referring_application_ref_idStringApplication reference ID (campaign ID).

incentive_code

Object

An object describing this Issuanceissuance's Incentive Code.
incentive_code.codeStringIncentive Code.

incentive_code.url

String

Incentive Code's URL.

incentive_pool

Object

An object describing this Issuanceissuance's Pool.

incentive_pool.idIntegerThe unique identifier for the pool.
incentive_pool.urlStringThe URL to access the Incentive pool resource.
created_atTimestampIssuance date.
updated_atTimestampThe date this Issuance issuance was last updated.

Get Issuances for an Incentive Code

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

Response

An array of all Issuances issuances for the given code.

Issue an Incentive Code

...

Data ElementRequiredDescription

external_issuee_id

NoUnique external issuee ID.
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 ID.

Response

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

...

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