Back to endpoints

Get activities by program id

GET PublicApi/{rewriteUrl}/{language}/Programs/{id}/Activities

?limit={limit}

&idStart={idStart}

&showHidden={showHidden}

Returns a list of activities ordered by id, with the option to show hidden activities

Request Information

URI Parameters

PARAMETERS
rewriteUrl (string)

Unique, url-friendly organization token. Part of base url

 Required
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

 Required
id (integer)

Program id

 Required
limit (integer)

Pagination limit in number of results per page. Min value is 5, max value is 250. Default is 250

 Optional
idStart (integer)

Starting item id to return in pagination. Default is 0

 Optional
showHidden (boolean)

Option to return hidden items.

Default value is False

 Optional

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Items ()
Page (PageInfo)

Response Formats

CODE SAMPLE JSON 
{
  "Items": [
    {
      "Id": 11,
      "Name": "Crawl 2",
      "Description": "Crawl intermediaire",
      "ResponsibleName": "Julie Joncas",
      "Prerequisite": "Natation 1",
      "Note": "Vous devez apporter votre planche",
      "ThirdPartyUrl": "third/party",
      "ExtraInformation": "Sujet a contraintes meteo",
      "Url": "activity/url",
      "IsTeam": false,
      "IsTeamRegistration": false,
      "Fee": 0.0,
      "Start": "2022-09-01T00:00:00-04:00",
      "End": "2022-09-01T00:00:00-04:00",
      "LegacyLocation": "rue Decelles",
      "HashId": null,
      "Price": 0.0,
      "DropInPrice": 0.0,
      "Schedule": [
        {
          "StartTime": "00:00:00",
          "EndTime": "00:00:00",
          "StartDate": "2022-09-01T00:00:00-04:00",
          "EndDate": "2022-09-01T00:00:00-04:00",
          "RecurenceEndDate": "2022-09-01T00:00:00-04:00",
          "Occurences": 10,
          "Staff": [],
          "Facilities": [
            {
              "Id": 1,
              "Name": "Natatorium de Verdun",
              "Address": {
                "Telephone": "514 926 8888",
                "AddressLine1": "7000 boul Lasalle",
                "AddressLine2": "Building 2",
                "City": "Verdun",
                "ZipPostalCode": "H4G 1A1",
                "StateProvince": "QC",
                "Country": "Canada",
                "Latitude": 41.3176,
                "Longitude": 135.5858
              }
            }
          ],
          "ExceptOccurences": [
            {
              "StartDate": "2022-09-01T00:00:00-04:00",
              "EndDate": "2022-09-01T00:00:00-04:00"
            }
          ],
          "Days": [
            "Tuesday",
            "Friday"
          ],
          "DayMask": 0
        }
      ],
      "Age": {
        "Max": 99,
        "Min": 0,
        "Months": false
      },
      "TaxCredit": {
        "Artistic": 0.0,
        "Physical": 0.0
      },
      "MaxAttendance": 20,
      "SpotsRemaining": 12,
      "SpotsReserved": 5,
      "RegistrationRevenue": 88.0,
      "SessionRevenue": 7.9228162514264338E+28,
      "DropinRevenue": -7.9228162514264338E+28,
      "MerchandiseRevenue": 0.0,
      "ShortScheduleString": "Sundays 16h-17h",
      "HasSessionEnabled": false,
      "HasDropInEnabled": false,
      "AgeSummary": "0-99",
      "OrganizationId": 0,
      "SubCategoryName": "Intermediaire",
      "ProgramId": 0,
      "CategoryId": 0,
      "SubCategoryId": 0,
      "SubCategoryPosition": 0,
      "Status": "Normal",
      "CategoryName": "Swimming",
      "ProgramName": "Ete 2019 - adultes",
      "PictureUrl": "img/natation.jpg",
      "TagIds": []
    },
    {
      "Id": 11,
      "Name": "Crawl 2",
      "Description": "Crawl intermediaire",
      "ResponsibleName": "Julie Joncas",
      "Prerequisite": "Natation 1",
      "Note": "Vous devez apporter votre planche",
      "ThirdPartyUrl": "third/party",
      "ExtraInformation": "Sujet a contraintes meteo",
      "Url": "activity/url",
      "IsTeam": false,
      "IsTeamRegistration": false,
      "Fee": 0.0,
      "Start": "2022-09-01T00:00:00-04:00",
      "End": "2022-09-01T00:00:00-04:00",
      "LegacyLocation": "rue Decelles",
      "HashId": null,
      "Price": 0.0,
      "DropInPrice": 0.0,
      "Schedule": [
        {
          "StartTime": "00:00:00",
          "EndTime": "00:00:00",
          "StartDate": "2022-09-01T00:00:00-04:00",
          "EndDate": "2022-09-01T00:00:00-04:00",
          "RecurenceEndDate": "2022-09-01T00:00:00-04:00",
          "Occurences": 10,
          "Staff": [],
          "Facilities": [
            {
              "Id": 1,
              "Name": "Natatorium de Verdun",
              "Address": {
                "Telephone": "514 926 8888",
                "AddressLine1": "7000 boul Lasalle",
                "AddressLine2": "Building 2",
                "City": "Verdun",
                "ZipPostalCode": "H4G 1A1",
                "StateProvince": "QC",
                "Country": "Canada",
                "Latitude": 41.3176,
                "Longitude": 135.5858
              }
            }
          ],
          "ExceptOccurences": [
            {
              "StartDate": "2022-09-01T00:00:00-04:00",
              "EndDate": "2022-09-01T00:00:00-04:00"
            }
          ],
          "Days": [
            "Tuesday",
            "Friday"
          ],
          "DayMask": 0
        }
      ],
      "Age": {
        "Max": 99,
        "Min": 0,
        "Months": false
      },
      "TaxCredit": {
        "Artistic": 0.0,
        "Physical": 0.0
      },
      "MaxAttendance": 20,
      "SpotsRemaining": 12,
      "SpotsReserved": 5,
      "RegistrationRevenue": 88.0,
      "SessionRevenue": 7.9228162514264338E+28,
      "DropinRevenue": -7.9228162514264338E+28,
      "MerchandiseRevenue": 0.0,
      "ShortScheduleString": "Sundays 16h-17h",
      "HasSessionEnabled": false,
      "HasDropInEnabled": false,
      "AgeSummary": "0-99",
      "OrganizationId": 0,
      "SubCategoryName": "Intermediaire",
      "ProgramId": 0,
      "CategoryId": 0,
      "SubCategoryId": 0,
      "SubCategoryPosition": 0,
      "Status": "Normal",
      "CategoryName": "Swimming",
      "ProgramName": "Ete 2019 - adultes",
      "PictureUrl": "img/natation.jpg",
      "TagIds": []
    }
  ],
  "Page": {
    "NextId": 1,
    "Next": "string 1"
  }
}