PureSpectrum Supplier API

Supplier API endpoints that allow suppliers to retrieve profile information for a specific PSID, with strict validation to ensure the PSID belongs to the supplier associated with the provided access token.

Only profile data related to the following question types will be returned:

Core profiling questions

Extended profiling questions

Custom profiling questions

HTTP Request:

GET: {{baseURL}}/suppliers/v2/psid/:PSID profile/

HEADER Parameters

Parameter	Type	Required	Description
Access-token	string	Yes	Token used to identify the authenticity of the user.

Response


{
    "PSID": "d311d85f-f26e-f0d7-7d3b-fff24858ff0b",
    "profile": [
        {
            "qualificationCode": 212,
            "answerId": [
                35
            ]
        },
        {
            "qualificationCode": 211,
            "answerId": [
                111
            ]
        },
        {
            "qualificationCode": 219,
            "answerId": [
                111
            ]
        },
}

Error Response (PSID Not Found)


{
    "statusCode": 404,
    "msg": "PSID not found"
}

Error Response (Token is not valid)


{
    "status": "Failure",
    "msg": "Invalid token"
}

HTTP Response Codes

Response	Status	Description
200	OK
404	Not Found	PSID not found
401	Failure	Invalid Token