OSosano

Retrieves all collections for a given configId based on jurisdiction

Changed on

Uses the configId embedded in the Unified Consent API key to retrieve an aggregate of all applicable collections of privacy protocols for a given jurisdiction. The type can either be 'draft' or 'published'. If the type is not provided, the default is 'published'. If the jurisdiction is not provided, IP geolocation is used to determine the jurisdiction. The response merges the configuration's default collection, the collections of the jurisdiction's parents and the jurisdiction's own collection, so 'us-ca' also returns the 'us' protocols. When nothing matches, the response has no collection.

get/v2/collections

Request

Query parameters

jurisdictionstring

A country code, optionally followed by more specific levels separated by '-', such as 'us', 'us-ca' or 'ca-qc'. Case-insensitive. Use a value from the jurisdictions array of the response.

type'published' | 'draft'

Response

The collection for the jurisdiction and every jurisdiction available for the configuration

jurisdictionsstring[]

Every jurisdiction that has a collection in this configuration, whichever one was requested.

Changes

  • 669b3b5b4d06Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • dedbbc618db6Revision changes
    • breaking

      the query request parameter type was restricted to a list of enum values

    • breaking

      for the query request parameter type, default value published was added

    • info

      added the new enum value draft to the query request parameter type

    • info

      added the new enum value published to the query request parameter type