JSON format for POSTed auto_assign parameter

This additional JSON data forms part of PfP’s verifiable audit trail for calculating its share of revenue.

• country string the two-letter country code representing the country of currency denomination in which your organisation sold the assessment
• assessment_each_price double the retail price (excl sales tax) that each assessment in the assignment was sold for
• total_extras_price double the total price (excl sales tax) the user paid for any commissionable upsells or value-adds per your organisation’s contract

For example (an auto_assign JSON value):

[
  {
    "country": "US",
    "assessment_each_price": 13.75,
    "total_extras_price": 0,
    "data": [
        {
            "key": "AI",
            "target": "self"
        }
    ]
  }
]

In the above, a user will be created and assigned one assessment, for which they paid (retail) US $13.75 (the “each” price no matter how many were assigned). The user did not purchase any commissionable extras.

The auto_assign JSON object (when POSTed by an org with a revenue-sharing agreement with PfP) represents a promise by the org that the end-user (or the org’s bulk/wholesale customer) really have paid the per-assessment price given in the object.

Example output

In the example below, the full output of the user creation response is shown.

{
    "message": "User created",
    "data": {
        "uuid": "eaf3ed7e-6b7a-4ff7-8caa-c5c94610a0fc",
        "sex": "F",
        "country": "GB",
        "occupation": {
            "code": "1312",
            "name": "Aquaculture and fisheries production managers"
        },
        "member_of": {
            "name": "Example Corp",
            "type": "Company",
            "uuid": "66a1fab1-2a24-4460-8036-7fb2e8925129"
        },
        "assignments": {
            "uuid": "931972df-4848-4b61-8b0a-173a0a9e60fc",
            "denomination_country": "US",
            "assessments": [
                {
                    "assessment_key": "AI",
                    "assessment_uuid": "03ba3bfa-2392-4f68-9d4f-e9602283dde9",
                    "assessment_context": "self (f)",
                    "target_type": "person",
                    "target_uuid": "eaf3ed7e-6b7a-4ff7-8caa-c5c94610a0fc"
                }
            ]
        }
    }
}