Skip to main content

GetCatalog

Met deze method kan de inhoud van de catalogus worden opgehaald.

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

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

username=string&password=string

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"?>
<ApiResponseOfListOfCatalogItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tempuri.org/">
    <Success>true</Success>
    <Contents></Contents>
</ApiResponseOfListOfCatalogItem>

De Contents zal een collectie van CatalogItem bevatten. CatalogItem is als volgt gestructureerd:

<CatalogItem>
  <!-- De naam van een trede. -->
  <Title>string</Title>

  <!-- De categorieen in een trede. -->
  <CatSubject>

    <!-- Een categorie in een trede. Hier kunnen er meerdere van zijn. -->
    <CatSubject>

      <!-- De titel van een categorie in een trede. -->
      <Subject>string</Subject>

      <!-- De trainingen in deze categorie. -->
      <CatTrainingInfo>

        <!-- Een training in de categorie. Hier kunnen er meerdere van zijn. -->
        <CatTrainingInfo>

          <!-- De titel van de opleiding -->
          <Title>string</Title>

          <!-- URL naar de afbeelding van de training, als er een is ingesteld. -->
          <Image>string</Image>

          <!-- Beschrijving vna de opleiding. Bevat HTML-opmaak. -->
          <Description>string</Description>

          <!-- Unieke ID van de opleiding -->
          <Id>number</Id>

          <!-- Kosten -->
          <costs>string</costs>

          <!-- De trainers voor deze opleiding. -->
          <Trainers>
            
            <!-- Informatie over een trainer. Hier kunnen er meerdere van zijn. -->
            <UserInfo>

              <!-- Unieke ID van de trainer. -->
              <Id>number</Id>

              <!-- Volledige naam van de trainer in de vorm "Voornaam van Achternaam". -->
              <Name>string</Name>

              <!-- Emailadres van de trainer -->
              <EmailAddress>string</EmailAddress>
            </UserInfo>
          </Trainers>

          <!-- Als de opleiding fysieke opleidingsmomenten heeft worden deze hier neergezet. -->
          <TrainingData>

            <!-- Informatie over een opleidingslichting. Hier kunnen er meerdere van zijn. -->
            <TrainingData>

              <!-- De unieke ID van de lichting. -->
              <subscriptionId>number</subscriptionId>
            
              <!-- De unieke ID van de groep. -->
              <groupId>number</groupId>
            
              <!-- De naam van de lichting. -->
              <ClassName>string</ClassName>
            
              <!-- De datum van de lichting. -->
              <Date>string</Date>
            
              <!-- Het tijdstip van de lichting. -->
              <Time>string</Time>
            
              <!-- De locatie van de lichting. -->
              <Location>string</Location>
            
              <!-- Het adres van de locatie. -->
              <Adress>string</Adress>
            
              <!-- Het aantal beschikbare plaatsen. -->
              <AvailablePlaces>number</AvailablePlaces>
            
              <!-- Geeft aan of er een wachtlijst is. -->
              <HasWaitingList>boolean</HasWaitingList>

              <!-- De lichtingspecifieke trainers. -->
              <Trainers>
                    
                <!-- Informatie over een trainer. Hier kunnen er meerdere van zijn. -->
                <UserInfo>
    
                  <!-- Unieke ID van de trainer. -->
                  <Id>number</Id>
    
                  <!-- Volledige naam van de trainer in de vorm "Voornaam van Achternaam". -->
                  <Name>string</Name>
    
                  <!-- Emailadres van de trainer -->
                  <EmailAddress>string</EmailAddress>
                  
                </UserInfo>
                
              </Trainers>
              
            </TrainingData> 
            
          </TrainingData>

          <!-- Dit element is altijd leeg. -->
          <Sites />

          <!-- Dit element is altijd leeg. -->
          <RelatedTrainings />
          
        </CatTrainingInfo>
        
      </CatTrainingInfo>
      
    </CatSubject>
  </CatSubject>
</CatalogItem>