Retrieve Subscriptions By Id

API Documentation

Retrieve Subscriptions By Id

The Subscription Detail API provides detailed information about marketing subscriptions and is used to display relevant courses and classes based on specific site requirements. Below is the detailed explanation of how the API handles displaying classes and courses on a site like Nicosia.

Endpoint:

Get /
GET /api/v1/marketing/subscriptions/{subscriptionId}

Request Parameters

Id Int (Required)

The Id of the subscription (unique identifier)

Response

Name String(Not Nullable)

Name of the subscription (e.g., “Nexus Human Reseller Program”).

Description String(Nullable)

Detailed description of the subscription.

CenterId Int(Not Nullable)

Unique identifier for the center

Center String(Not Nullable)

Center associated with the subscription (e.g., “Nicosia”).

centerSiteID Int(Nullable)

SiteID of the center associated with the subscription

CenterSiteCode String(Nullable)

CenterSiteCode of the center associated with the subscription

AllCourses Boolean(Nullable)

Indicates if the subscription covers all courses.

allClubs boolean(Nullable)

Indicates if the subscription covers all clubs.

modalityId Int(Nullable)

Unique identifier for the course modality

modality String(Nullable)

Modality type (e.g., Online LIVE).

pricingId Int(Nullable)

Unique identifier for the price

pricing string(Nullable)

Pricing model (e.g., Local prices only).

supplemental boolean(Nullable)

Indicates if the subscription includes supplemental materials.

includeChildren boolean(Nullable)

Indicates if the subscription includes child centers

deliveryCenters array(Nullable)

Centers covered by this subscription.

courses array(Nullable)

Courses covered by this subscription.

excludedClassInstances array(Nullable)

Number of excluded class instances.

excludedCourseInstances array(Nullable)

Number of excluded course instances.

classes array(Nullable)

Detailed class information (newly added).

				
					{
  "success": true,
  "message": "Data retrieved successfully.",
  "data": {
    "name": "Nexus Human Reseller Program",
    "description": null,
    "centerId": 1404,
    "center": "Nicosia",
    "centerSiteId": 7934,
    "centerSiteCode": "NCO",
    "allCourses": false,
    "allClubs": false,
    "modalityId": 3,
    "modality": "Online LIVE",
    "pricingId": 0,
    "pricing": "Local prices only",
    "supplemental": false,
    "includeChildren": true,
    "deliveryCenters": [
      "Nexus Human Reseller Program"
    ],
    "courses": [
      46146,
      46147,
      56595
    ],
    "excludedClassInstances": [
      1842071,
      1841987
    ],
    "excludedCourseInstances": [],
    "classes": [
      {
        "courseID": 46146,
        "classID": 1842070,
        "ownerID": 2711514,
        "startDateTime": "2024-09-23 08:30:00",
        "endDateTime": "2024-09-25 16:00:00",
        "timeLastUpdated": "2024-02-23 09:54:38",
        "startDate": "2024-09-23",
        "endDate": "2024-09-25",
        "startTime": "08:30:00",
        "endTime": "16:00:00",
        "cancelled": false,
        "name": "PRINCE2®: Foundation 7th Edition",
        "gtr": false,
        "hostingSiteID": 0,
        "hostingSiteCode": null,
        "franchiseId": null,
        "confirmationStatusId": 0,
        "status": "Scheduled",
        "deliveryTypeId": 2,
        "deliveryType": "Virtual",
        "deliveryCenterId": 1493,
        "deliveryCenter": "Nexus Human Reseller Program",
        "billingCenterId": 1493,
        "billingCenter": "Nexus Human Reseller Program",
        "pricing": [
          {
            "courseId": 46146,
            "organizationId": 1404,
            "extranetSiteId": 7934,
            "price": 1100,
            "productCode": "NH95009S-OLL",
            "extranetSiteCOde": "NCO"
          },
          {
            "courseId": 46146,
            "organizationId": 1404,
            "extranetSiteId": 7934,
            "price": 1100,
            "productCode": "NH95009S-ILT",
            "extranetSiteCOde": "NCO"
          }
        ]
      },
      {
        "courseID": 46147,
        "classID": 1842074,
        "ownerID": 2711514,
        "startDateTime": "2024-09-26 08:30:00",
        "endDateTime": "2024-09-27 16:00:00",
        "timeLastUpdated": "2024-02-23 09:57:45",
        "startDate": "2024-09-26",
        "endDate": "2024-09-27",
        "startTime": "08:30:00",
        "endTime": "16:00:00",
        "cancelled": false,
        "name": "PRINCE2®: Practitioner 7th Edition",
        "gtr": false,
        "hostingSiteID": 0,
        "hostingSiteCode": null,
        "franchiseId": null,
        "confirmationStatusId": 0,
        "status": "Scheduled",
        "deliveryTypeId": 2,
        "deliveryType": "Virtual",
        "deliveryCenterId": 1493,
        "deliveryCenter": "Nexus Human Reseller Program",
        "billingCenterId": 1493,
        "billingCenter": "Nexus Human Reseller Program",
        "pricing": [
          {
            "courseId": 46147,
            "organizationId": 1404,
            "extranetSiteId": 7934,
            "price": 900,
            "productCode": "",
            "extranetSiteCOde": "NCO"
          },
          {
            "courseId": 46147,
            "organizationId": 1404,
            "extranetSiteId": 7934,
            "price": 900,
            "productCode": "NH95010S-OLL",
            "extranetSiteCOde": "NCO"
          }
        ]
      }
    ]
  }
}