# Search Classes

This operation searches GroupX Classes by date range. It returns only brief information about GroupX Classes.

#### Additional contracts
N/A

Endpoint: GET /classes
Version: 1.0

## Query parameters:

  - `locationId` (string, required)
    ClubMS Location ID, which indicates Location to search Classes in. This ID is returned by Canonical Locations API or provided manually to Netpulse admins.

##### Possible reasons of validation errors:
* missing => 400
* notFound => 404

  - `endDateTime` (string, required)
    Defines end of the timerange for Class search

##### Possible reasons of validation errors:
* missing => 400
* wrongFormat => 400
* lessThanStartDateTime => 400

  - `startDateTime` (string, required)
    Defines start of the timerange for Class search

##### Possible reasons of validation errors:
* missing => 400
* wrongFormat => 400
* greaterThanEndDateTime => 400

## Header parameters:

  - `X-User-Secret` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-User-ID` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-User-Locale` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-NP-Location-Configuration` (string)
    !Professional Services onlysee 'Additional Data HTTP Headers' for details.

  - `X-NP-Location-Timezone` (string)
    !Professional Services onlysee 'Additional Data HTTP Headers' for details.

  - `X-Location-Secret` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-Location-ID` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-NP-Location-Group-Configuration` (string)
    !Professional Services onlysee 'Additional Data HTTP Headers' for details.

  - `X-Location-Group-Secret` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-Location-Group-ID` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-NP-Chain-Configuration` (string)
    !Professional Services onlysee 'Additional Data HTTP Headers' for details.

  - `X-Chain-Secret` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-Chain-ID` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-NP-Client-Configuration` (string)
    !Professional Services onlysee 'Additional Data HTTP Headers' for details.

  - `X-Client-Secret` (string)
    see 'Additional Data HTTP Headers' for details.

  - `X-Client-ID` (string)
    see 'Additional Data HTTP Headers' for details.

## Response 200 fields (application/json):

  - `brief` (object)
    Brief details of the groupX class for bulk retrieval

  - `brief.id` (string, required)
    Unique ID of the GroupX Class in the ClubMS. This is the same ID that's used in getClassDetails operation

  - `brief.name` (string, required)
    Name of the Class (e.g. 'Yoga 24', 'TRX Small Group', 'Body Pump')

  - `brief.startDateTime` (string, required)
    Start date/time of the GroupX Class in UTC timezone

  - `brief.endDateTime` (string, required)
    End date/time of the GroupX Class in UTC timezone

  - `brief.locationId` (string)
    Unique ID of the location in ClubMS that this class belongs to. This is the same ID as returned by Canonical Locations API or as manually provided to Netpulse admins for locations configuration.

  - `brief.free` (boolean)
    Indicates that the class is free (not paid)

  - `brief.waitlisted` (boolean)
    Indicates whether the given exerciser is in the waitlist of this class

  - `brief.childCare` (boolean)
    Defines if child care option is available for the Class

  - `brief.reservable` (boolean)
    Defines if Class is reservable

  - `brief.instructor` (object)
    Required property Information about Intructor who leads the Class

  - `brief.instructor.firstName` (string)

  - `brief.instructor.lastName` (string)

  - `brief.instructor.fullName` (string, required)

  - `brief.instructor.customInfo` (array)
    Key-Value map to represent additional information of an entity.
Partners could contain diverse information of same entities. This type designed to store that information.

  - `brief.instructor.customInfo.key` (string, required)

  - `brief.instructor.customInfo.value` (string, required)

  - `brief.activity` (object)
    Required property Information about Activity of the Class

  - `brief.activity.name` (string, required)
    Name of the Class activity (e.g. 'Yoga 24', 'TRX Small Group', 'Body Pump'), often it is the same as groupX class name, but it might be also a more general name (depends on ClubMS, e.g. 'Yoga', 'TRX')