Pearson
Always Learning

In order to read a subscription, you must send an HTTP GET to our system. You may also Create a New Subscription, or Delete an Existing Subscription.

Resource URLs

GET https://prospero.ecollege.com/v1/subscription/{subscriptionId}
GET https://prospero.ecollege.com/v1/subscriptions/principal/{principalId}

Request HTTP Header

Name Description Required?
Authorization Include the Authorization header (including signature token) as described in Subscription API Authentication. Yes

Authentication Token Base String

The signature token base string for Delete Subscription is simply whatever parameter value you send in the URI. So if you use this HTTP request:

GET https://prospero.ecollege.com/v1/subscription/00000cbd-f51e-3fcf-aab2-944f0dfa96f1

Then the token base string is simply:

00000cbd-f51e-3fcf-aab2-944f0dfa96f1

Proceed by prefixing it with the timestamp and creating the hash, as described in the Authentication process.

Response Body Format

{
  "subscription": {
      "id": "{subscriptionId}",
      "principal_id": "subscriptionPrincipalId}",
      "callback_url": "{subscriptionCallbackUrl}",
      "wsdl_uri": "{subscriptionWsdlUri}",
      "queue_name": "{subscriptionQueueName}",
      "date_created": "{subscriptionDateCreated}",
      "date_cancelled": "{subscriptionDateCancelled}",
      "tags": [
        {
          "tag": {
          "id": "{tagid}",
          "type": "{tagMessageType}",
          "value": "{tagValue}"
        }
      }
    ]
  }
}

Response Body Parameters

Name Description Valid Values
subscriptionId The ID assigned to the subscription Any
subscriptionPrincipalId The ID for the principal holding this subscription Principal ID
subscriptionCallbackUrl The callback URL for this subscription URI
subscriptionWsdlUri If applicable, the WSDL URI for this subscription URI
subscriptionQueueName The queue managing this subscription Any
subscriptionDateCreated The creation date of this subscription Date
subscriptionDateCancelled The cancellation date of this subscription. Blank if not cancelled. Date
tagId The identifier for the tag Any
tagMessageType The type of filter applied by the tag Any
tagValue The value of the filter applied by the tag Any

Example Response

{
  "subscription" : {
    "id" : "00000cbd-f51e-3fcf-aab2944f0dfa96f1",
    "principal_id" : "PDNTEST",
    "callback_url" : "http://example.com/receive/pdn.test",
    "wsdl_uri" : "",
    "queue_name" : "Sub-00000cbd-f51e-3fcf-aab2-944f0dfa96f1",
    "date_created" : "2014-02-11T17:07:54Z",
    "date_cancelled" : "",
    "tags" : [
      {
        "tag" : {
          "id" : "MessageType: pearson.ls.gradebook.grade.created",
          "type" : "MessageType",
          "value" : "pearson.ls.gradebook.grade.created"
        }
      },
      {
        "tag" : {
          "id" : "UserId:012345678",
          "type" : "UserId",
          "value" : "012345678"
        }
      }
    ]
  }
}

In order to read a subscription, you must send an HTTP GET to our system. You may also Create a New Subscription, or Delete an Existing Subscription.

Resource URLs

GET https://prospero.ecollege.com/v1/subscription/{subscriptionId}
GET https://prospero.ecollege.com/v1/subscriptions/principal/{principalId}

Request HTTP Header

Name Description Required?
Authorization Include the Authorization header (including signature token) as described in Subscription API Authentication. Yes

Authentication Token Base String

The signature token base string for Delete Subscription is simply whatever parameter value you send in the URI. So if you use this HTTP request:

GET https://prospero.ecollege.com/v1/subscription/00000cbd-f51e-3fcf-aab2-944f0dfa96f1

Then the token base string is simply:

00000cbd-f51e-3fcf-aab2-944f0dfa96f1

Proceed by prefixing it with the timestamp and creating the hash, as described in the Authentication process.

Response Body Format

{
  "subscription": {
      "id": "{subscriptionId}",
      "principal_id": "subscriptionPrincipalId}",
      "callback_url": "{subscriptionCallbackUrl}",
      "wsdl_uri": "{subscriptionWsdlUri}",
      "queue_name": "{subscriptionQueueName}",
      "date_created": "{subscriptionDateCreated}",
      "date_cancelled": "{subscriptionDateCancelled}",
      "tags": [
        {
          "tag": {
          "id": "{tagid}",
          "type": "{tagMessageType}",
          "value": "{tagValue}"
        }
      }
    ]
  }
}

Response Body Parameters

Name Description Valid Values
subscriptionId The ID assigned to the subscription Any
subscriptionPrincipalId The ID for the principal holding this subscription Principal ID
subscriptionCallbackUrl The callback URL for this subscription URI
subscriptionWsdlUri If applicable, the WSDL URI for this subscription URI
subscriptionQueueName The queue managing this subscription Any
subscriptionDateCreated The creation date of this subscription Date
subscriptionDateCancelled The cancellation date of this subscription. Blank if not cancelled. Date
tagId The identifier for the tag Any
tagMessageType The type of filter applied by the tag Any
tagValue The value of the filter applied by the tag Any

Example Response

{
  "subscription" : {
    "id" : "00000cbd-f51e-3fcf-aab2944f0dfa96f1",
    "principal_id" : "PDNTEST",
    "callback_url" : "http://example.com/receive/pdn.test",
    "wsdl_uri" : "",
    "queue_name" : "Sub-00000cbd-f51e-3fcf-aab2-944f0dfa96f1",
    "date_created" : "2014-02-11T17:07:54Z",
    "date_cancelled" : "",
    "tags" : [
      {
        "tag" : {
          "id" : "MessageType: pearson.ls.gradebook.grade.created",
          "type" : "MessageType",
          "value" : "pearson.ls.gradebook.grade.created"
        }
      },
      {
        "tag" : {
          "id" : "UserId:012345678",
          "type" : "UserId",
          "value" : "012345678"
        }
      }
    ]
  }
}
3156 reads
Always Learning
Pearson