GetPaginatedLearningPortfolioContent
GetPaginatedLearningPortfolioContent kan gebruikt worden om alle leervoortgang van alle niet geanonimiseerde in dienst gebruikers op te halen. Deze method is vergelijkbaar met GetAllLearningPortfolioContent, maar hier kan pagina-informatie worden meegegeven. Elke rij in het resultaat geeft de status voor de opleiding in relatie tot de gebruiker weer. Daarnaast bevat elke rij extra informatie, zoals de trede, informatie over de opleiding en informatie over de gebruiker.
Het ophalen van de leervoortgang van een niet geanonimiseerde in dienst gebruiker binnen Pynter via de GetPaginatedLearningPortfolioContent endpoint kan er als volgt uit zien:
POST /service/apiservice.asmx HTTP/1.1
Host: domein.pynter.nl
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetPaginatedLearningPortfolioContent xmlns="/service/ApiService.asmx">
<username>string</username>
<password>string</password>
<size>int</size>
<index>int</size>
</GetPaginatedLearningPortfolioContent>
</soap12:Body>
</soap12:Envelope>
Voor extra configuratie zijn er twee optionele parameters beschikbaar:
<!-- Kan gebruikt worden om aan te geven of eerder behaalde opleidingen, die niet actief in of op het leeraanbod / thuispagina van de gebruiker staan mee worden gegeven. -->
<!-- Staat standaard op False. -->
<includeContentNotInPortfolio>bool</includeContentNotInPortfolio>
<!-- Kan gebruikt worden om aan te geven of de voortgang van inactieve trainingen mee worden gegeven. -->
<!-- Staat standaard op False. -->
<includeInactiveTrainings>bool</includeInactiveTrainings>
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"?>
<ApiResponseOfLearningPortfolioContentPaginated 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>
<TotalItems>402444</TotalItems>
<Size>100</Size>
<Index>1</Index>
<TotalPages>4025</TotalPages>
<Items></Items>
</Contents>
</ApiResponseOfLearningPortfolioContentPaginated>
De Items zal een collectie van LearningPortfolioContentCached bevatten. LearningPortfolioContentCached is als volgt gestructureerd:
<LearningPortfolioContentCached>
<!-- De titel van de trede. -->
<StepTitle>int</StepTitle>
<!-- De introductie van de trede. -->
<StepIntroduction>string</StepIntroduction>
<!-- De volgorde index van de trede. -->
<StepOrder>int</StepOrder>
<!-- De titel van de training. -->
<TrainingTitle>string</TrainingTitle>
<!-- Of de training verplicht is. -->
<TrainingIsMandatory>string</TrainingIsMandatory>
<!-- OPTIONEEL: De naam van de afbeelding van de training op Pynter. -->
<TrainingImageName>string</TrainingImageName>
<!-- OPTIONEEL: De unieke identificatie van de persoon in het Provisioning systeem. -->
<PersonExternalIdentifier>string</PersonExternalIdentifier>
<!-- OPTIONEEL: De unieke identificatie van de leidinggevende van de persoon in het provisioning systeem. -->
<ManagerExternalIdentifier>string</ManagerExternalIdentifier>
<!-- De voornaam van de persoon. -->
<PersonFirstName>string</PersonFirstName>
<!-- De tussenvoegsels van de cursist. Leeg wanneer deze geen waarde heeft. -->
<PersonNameInsertion>string</PersonNameInsertion>
<!-- De achternaam van de cursist. -->
<PersonFamilyName>string</PersonFamilyName>
<!-- Het unieke identificatie nummer van de reden voor het dimmen als dit het geval is. (Alleen van toepassing als er redenen voor dimmen beschikbaar zijn voor de cursist.) -->
<DimReasonId>int</DimReasonId>
<!-- Of deze cursist de drempel voor het mogen openen van deze opleiding behaald heeft. -->
<TrainingThresholdIsMet>bool</TrainingThresholdIsMet>
<!-- Of deze cursist de opleiding handmatig toegevoegd heeft vanuit de catalogus. -->
<TrainingIsManuallyAdded>bool</TrainingIsManuallyAdded>
<!-- OPTIONEEL: Wanneer de cursist de opleiding voor het laatst gestart heeft. Heeft een waarde als dit van toepassing is. -->
<TrainingStartedAt>DateTime</TrainingStartedAt>
<!-- OPTIONEEL: Wanneer de cursist de opleiding voor het laatst afgerond heeft. Heeft een waarde als dit van toepassing is. -->
<TrainingFinishedAt>DateTime</TrainingFinishedAt>
<!-- Tot wanneer het behaalde resultaat geldig is voor de cursist. Geen waarde als er nog geen resultaat is of als het resultaat oneindig geldig is. -->
<TrainingValidUntil>DateTime</TrainingValidUntil>
<!-- De status van de persoon in relatie tot de opleiding:
0: Niet in aanbod (intern gebruik.)
1: Gedimd
2: Wel in aanbod maar nog niet gestart
3: Gestart (TrainingStartedAt kolom heeft een waarde.)
4: Afgerond (TrainingFinishedAt kolom heeft een waarde. TrainingValidUntil kolom heeft een waarde als dit toepassing is.)
5: Dreigt te verlopen (3 maanden van tevoren.)
6: Verlopen
-->
<LearningPortfolioStatus>Status</LearningPortfolioStatus>
<!-- Of de training in het aanbod van de gebruiker zit. Bevat alleen False waardes wanneer de optionele includeContentNotInPortfolio parameter True is. -->
<InPortfolio>bool</InPortfolio>
<!-- Het aantal actieve trainingen waar de persoon een status voor heeft in dezelfde trede als dit resultaat waar InPortfolio gelijk is aan true. -->
<TrainingsInPortfolioForPersonInStepCount>int</TrainingsInPortfolioForPersonInStepCount>
<!-- Het aantal actieve trainingen die de persoon afgerond heeft in dezelfde trede als dit resultaat waar InPortfolio zowel True als False kan zijn. -->
<TrainingsFinishedForPersonInStepCount>int</TrainingsFinishedForPersonInStepCount>
<!-- Het aantal actieve trainingen die de persoon afgerond heeft in dezelfde trede als dit resultaat waar InPortfolio gelijk is aan True. -->
<TrainingsInPortfolioFinishedForPersonInStepCount>int</TrainingsInPortfolioFinishedForPersonInStepCount>
</LearningPortfolioContentCached>
Training is een collectieve naam voor Opleiding en Opleidingsblok.