GetClass

Met deze method kan informatie worden opgehaald over een lichting.

Let op: Gebruik geen GET-requests. Deze worden in plaintext verstuurd, en zijn dus niet veilig.

POST /service/apiservice.asmx/GetClass HTTP/1.1
Host: domein.pynter.nl
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string&classId=number

Bij het succesvol aanroepen ziet een respons er als volgt uit:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ApiResponseOfGroupClass>
  <Success>true</Success>
  <Contents></Contents>
</ApiResponseOfGroupClass>

De Contents bevat de volgende velden:

<!-- De unieke ID van de lichting. -->
<Id>number</Id>

<!-- De unieke ID van de groep die bij de lichting hoort. -->
<GroupId>number</GroupId>

<!-- De naam van de lichting. -->
<ClassName>string</ClassName>

<!-- Of de lichting zichtbaar is in de catalogus. -->
<IsVisibleCatalog>boolean</IsVisibleCatalog>

<!-- Of de lichting zichtbaar is in de kalender. -->
<IsVisibleCalendar>string</IsVisibleCalendar>

<!-- Of de lichting extern wordt aangeboden. -->
<OfferExternally>boolean</OfferExternally>

<!-- Het minimale aantal inschrijvingen voor de lichting. Kan ook leeg zijn, in dat geval heeft het XML-element de attribute xsi:nil="true". -->
<MinPersons>number</MinPersons>

<!-- Het maximale aantal inschrijvingen voor de lichting. Kan ook leeg zijn, in dat geval heeft het XML-element de attribute xsi:nil="true". -->
<MaxPersons>number</MaxPersons>

<!-- De memo voor de lichting. Hier kan extra informatie voor beheerders worden ingevuld. Deze is niet zichtbaar voor medewerkers. Dit eld bevat HTML. -->
<Memo>string</Memo>

<!-- Of de memo in de rapportage getoond moet worden. -->
<ShowMemoInReport>boolean</ShowMemoInReport>

<!-- Of de lichting gearchiveerd is. -->
<Archived>boolean</Archived>

<!-- Of de lichting geannuleerd is. -->
<Cancelled>boolean</Cancelled>

<!-- Of alleen medewerkers in een bepaalde divisie zich mogen inschrijven voor deze lichting. -->
<FilterByDivision>boolean</FilterByDivision>

<!-- Of deze lichting een wachtlijst heeft. -->
<HasWaitingList>boolean</HasWaitingList>

<!-- Het maximale aantal inschrijvingen voor de wachtlijst. Kan ook leeg (= onbeperkt) zijn, in dat geval heeft het XML-element de attribute xsi:nil="true". -->
<WaitingListCapacity>number</WaitingListCapacity>

<!-- De uiterlijke datum dat medewerkers hun inschrijving kunnen aanpassen. Kan ook leeg zijn, in dat geval heeft het XML-element de attribute xsi:nil="true". -->
<EditDeadline>datetime</EditDeadline>

<!-- De uiterlijke datum dat medewerkers zich voor de lichting kunnen inschrijgen. Kan ook leeg zijn, in dat geval heeft het XML-element de attribute xsi:nil="true". -->
<RegistrationDeadline>datetime</RegistrationDeadline>

<!-- Het aantal dagen voor de eerste datum van de training voordat de medewerker toegang krijgt tot de inhoud van de opleiding. Kan ook leeg zijn, in dat geval heeft het XML-element de attribute xsi:nil="true". -->
<LockDaysTillStart>datetime</LockDaysTillStart>

<!-- De manier waarop de opleiding wordt afgerond. Mogelijke waarden: "Normal", "Stream", "ETicket". -->
<CompletionType>int</CompletionType>

<!-- Of de training nog in de bewerkmodus staat. -->
<IsUnderConstruction>boolean</IsUnderConstruction>

<!-- Lijst van data voor de lichting. Zie hieronder. -->
<Data />

<!-- Lijst van medewerkers die voor de lichting zijn ingeschreven. Deze informatie wordt in dit API-endpoint niet meegegeven. -->
<Members/>

<!-- Lijst van edities voor PE-online. Deze informatie wordt in dit API-endpoint niet meegegeven. -->
<Editions/>

<!-- Lijst van divisies die zich voor deze lichting kunnen inschrijven. Deze informatie wordt in dit API-endpoint niet meegegeven. -->
<GroupClassDivisions/>

<!-- Lijst van wachtlijstingschrijvingen. Deze informatie wordt in dit API-endpoint niet meegegeven. -->
<WaitingListEnrollments/>

Het Data-veld bevat de contactmomenten van de lichting. Hierin zitten een of meer elementen van het type GroupClassDate. Hierin zitten de volgende velden:

<!-- De unieke ID van het contactmoment. -->
<Id>number</Id>

<!-- De unieke ID van de lichting. -->
<ClassId>number</ClassId>

<!-- De datum van het contactmoment. -->
<Date>datetime</Date>

<!-- De starttijd van het contactmoment. -->
<From>string</From>

<!-- De eindtijd van het contactmoment -->
<Till>string</Till>

<!-- De naam van de locatie van het contactmoment. -->
<LocationName>string</LocationName>

<!-- Het adres van de locatie van het contactmoment. -->
<LocationAddress>string</LocationAddress>

<!-- De unieke ID van de PE-Online meeting. -->
<MeetingId>number</MeetingId>

<!-- De unieke ID van een module, indien gekoppeld. -->
<TaskId>number</TaskId>

<!-- Of er een stream beschikbaar is voor dit contactmoment. -->
<StreamAvailable>boolean</StreamAvailable>

<!-- De unieke code waarmee de stream gejoind kan worden. -->
<StreamPassword>string</StreamPassword>

<!-- Extra informatie die op het E-Ticket getoond wordt. -->
<EticketInformation>string</EticketInformation>

<!-- De unieke ID van de TopDesk-reservering, indien relevant. -->
<ReservationId>number</ReservationId>

<!-- Trainers voor dit contactmoment. Dit element wordt in deze API endpoint niet teruggegeven. -->
<Trainers />

<!-- Locaties voor TopDesk. Dit element wordt in deze API endpoint niet teruggegeven. -->
<TopDeskLocations />

<!-- Meetings voor PE-Online. Dit element wordt in deze API endpoint niet teruggegeven. -->
<Meetings />