Versions Compared

Key

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

...

As a supplier, if you have been assigned a guaranteed allocation on a survey, then this you should have confidence in sending against the “guaranteed_allocation_remaining” allocation.

This allocation will be communicated in the supplier_completes object:

Code Block
      "supplier_completes": {
        "needed": 24,
        "achieved": 3,
        "remaining": 21,
        "guaranteed_allocation": 10,
        "guaranteed_allocation_remaining": 7
      },

...

The value of “guaranteed_allocation_remaining” is calculated by ”guaranteed_allocation” - ”achieved”

Note

The Guaranteed Allocation is a supplement to the value of “remaining” value. Be sure to reference the “remaining” value as the main source of truth when determining if completes are available to deliver against.

In the case where Soft Launch is enabled, the value in “remaining” may be lower than the “guaranteed_allocation_remaining” until the Soft Launch period is over.

Request

...

GET $apihost/$basepath/surveys/:surveyId

...