GET v4/activation_requests/:id - Read

This API  is used to retrieve pre-existing activation links for a particular user based on the provided access token. Only requests generated by the provided API key are returned.

 

Verb/URI

GET https://api.vitalsource.com/v4/activation_requests

Request Headers

X-VitalSource-API-Key: ABCDEFGHIJKLMNOP
Content-Type: application/json

Response

Response body

HTTP Code: 200 Ok
{
"id": "ALLCAPSNUMBERSALLCAPS",
"email": “sri.krisha@univ.edu”,
"send_email": true,
"status": "Notification sent",
"brand_destination_url": "https://bookshelf.vitalsource.com",
"activation_url": "https://api.vitalsource.com/v4/activation_requests/ALLCAPSNUMBERSALLCAPS/activate",
"expires_at": "Wed, 01 Jan 2019 19:28:13 +0000",
"activated_at": null,
"notification_sent_at": null
}

Response Descriptions

Name
Description
id Unique ID of the activation request
email Email provided on request
send_email Send email parameter provided on request
status Status of the link, values are Notification Sent, Activated, Expired. Links clicked will be marked as Activated, links expired (after 6 weeks) will be marked as Expired you can always re-request a new link.
brand_destination_url URL for the bookshelf reader where the user will be sent on click.
activation_url Activation URL that can be used for a one-time click access into users Bookshelf account
expires_at When the activation_url expires.
activated_at When the link was clicked, if nil it hasn't been clicked.
notification_sent When the email was sent, this is done asynchronously so it may be nil on first response.

 

Error Codes

HTTP & Error messages 
Message
Notes
200

Activation request already redeemed

Success. Errors provided simultaneously
403

Permission Denied

Verify that this ID was issued by this API key 
404

Activation Request not found

Verify your activation ID
404

Not found

Verify your activation ID

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.