Ophalen van gebruikers
GetAllBasicPersonInfo
Het ophalen van een niet geanonimiseerde in dienst gebruiker binnen Pynter via de GetAllBasicPersonInfo endpoint kan er als volgt uit zien:
POST /service/apiservice.asmx HTTP/1.1
Host: domein.acc.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>
<GetAllBasicPersonInfo xmlns="http://tempuri.org/">
<username>string</username>
<password>string</password>
</GetAllBasicPersonInfo>
</soap12:Body>
</soap12:Envelope>
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"?>
<ApiResponseOfListOfBasicPersonInfo 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>
<!-- Weggelaten voor leesbaarheid, zie hieronder -->
</Contents>
</ApiResponseOfListOfBasicPersonInfo>
De Contents zal een collectie van BasicPersonInfo bevatten. BasicPersonInfo is als volgt gestructureerd:
<BasicPersonInfo>
<!-- De unieke identificatie van de persoon binnen Pynter. -->
<PynterId>int</PynterId>
<!-- OPTIONEEL: Het medewerkernummer voor deze persoon afkomstig uit het provisioning systeem. Is een uniek nummer. -->
<ExternalId>string</ExternalId>
<!-- De voornaam. -->
<FirstName>string</FirstName>
<!-- OPTIONEEL: Het tussenvoegsel. -->
<Insertion>string</Insertion>
<!-- De achternaam exclusief tussenvoegsel. -->
<FamilyName>string</FamilyName>
<!-- Een zakelijk e-mailadres voor de persoon. -->
<Email>string</Email>
<!-- Het autorisatieniveau van de persoon. -->
<!-- Zie de opmerking onder dit blok voor meer uitleg. -->
<AccountLevel></AccountLevel>
<!-- De unieke identificatie van de leidinggevende van de persoon binnen Pynter. -->
<ManagerPynterId>int<ManagerPynterId>
<!-- OPTIONEEL: Het medewerkernummer voor de leidinggevende afkomstig uit het provisioning systeem. Is een uniek nummer. -->
<ManagerExternalId>string</ManagerExternalId>
<!-- De voornaam van de leidinggevende. -->
<ManagerFirstName>string</ManagerFirstName>
<!-- OPTIONEEL: Het tussenvoegsel van de leidinggevende. -->
<ManagerInsertion>string</ManagerInsertion>
<!-- De achternaam exclusief tussenvoegsel van de leidinggevende. -->
<ManagerFamilyName>string</ManagerFamilyName>
<!-- De naam van de functie. -->
<Function>string</Function>
<!-- De naam van de divisie / locatie van de persoon. -->
<Division>string</Division>
<!-- Of de medewerker hun account geactiveerd heeft door in te loggen. -->
<HasActivatedAccount>boolean</HasActivatedAccount>
<!-- Of de medewerker uit dienst is. -->
<IsDismissed>boolean</IsDismissed>
</BasicPersonInfo>
Voor meer informatie over AccountLevel kan je de pagina over Autorisatie inzien.
GetPersonByPynterId
Het ophalen van een gebruiker binnen Pynter via de GetPersonByPynterId endpoint kan er als volgt uit zien:
POST /service/apiservice.asmx HTTP/1.1
Host: domein.acc.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>
<GetPersonByPynterId xmlns="/service/ApiService.asmx">
<username>string</username>
<password>string</password>
<pynterPersonId>int</pynterPersonId>
</GetPersonByPynterId>
</soap12:Body>
</soap12:Envelope>
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"?>
<ApiResponseOfPerson xmlns="/service/ApiService.asmx">
<Success>boolean</Success>
<Contents xmlns="ApiPerson"></Contents>
<Error>string</Error>
</ApiResponseOfPerson>
De Contents zal de volgende waarden van een ApiPerson bevatten:
<ApiPerson>
<!-- De unieke identificatie van de persoon binnen Pynter. -->
<Id>int</Id>
<!-- Het medewerkernummer voor deze persoon. Kan gebruikt worden om de persoon op te wijzigen of op te halen. Moet uniek zijn. -->
<ExternalIdentifier>string</ExternalIdentifier>
<!-- De voornaam. -->
<FirstName>string</FirstName>
<!-- OPTIONEEL: Het tussenvoegsel. -->
<Insertion>string</Insertion>
<!-- De achternaam exclusief tussenvoegsel. -->
<FamilyName>string</FamilyName>
<!-- Een zakelijk e-mailadres voor de persoon. -->
<Email>string</Email>
<!-- Het autorisatieniveau van de persoon. -->
<!-- Zie de opmerking onder dit blok voor meer uitleg. -->
<AccountLevel></AccountLevel>
<!-- Of deze persoon een manager is of niet. -->
<IsManager>boolean</IsManager>
<!-- De naam van de functie. -->
<FunctionName>string</FunctionName>
<!-- De unieke identificatie van de functie binnen Pynter. -->
<FunctionId>int</FunctionId>
<!-- De naam van de divisie / locatie van de persoon. -->
<DivisionName>string</DivisionName>
<!-- De unieke identificatie van de divisie binnen Pynter. -->
<DivisionId>int</DivisionId>
<!-- De kostenplaats voor de persoon. -->
<CostCentre>string</CostCentre>
<!-- OPTIONEEL: De telefoonnummer. -->
<PhoneNumber>string</PhoneNumber>
<!-- OPTIONEEL: Wanneer het contract van kracht is. -->
<ContractStartTime>datetime</ContractStartTime>
<!-- OPTIONEEL: Wanneer het contract afloopt. -->
<ContractEndTime>datetime</ContractEndTime>
<!-- De unieke identificatie van de manager voor deze persoon binnen Pynter. -->
<ManagerId>int</ManagerId>
</personCreate>
Voor meer informatie over AccountLevel kan je de pagina over Autorisatie inzien.
GetPersonByExternalId
Het ophalen van een gebruiker binnen Pynter via de GetPersonByExternalId endpoint kan er als volgt uit zien:
POST /service/apiservice.asmx HTTP/1.1
Host: domein.acc.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>
<GetPersonByExternalId xmlns="/service/ApiService.asmx">
<username>string</username>
<password>string</password>
<externalId>int</externalId>
</GetPersonByExternalId>
</soap12:Body>
</soap12:Envelope>
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"?>
<ApiResponseOfPerson xmlns="/service/ApiService.asmx">
<Success>boolean</Success>
<Contents xmlns="ApiPerson"></Contents>
<Error>string</Error>
</ApiResponseOfPerson>
De Contents zal de volgende waarden van een ApiPerson bevatten:
<ApiPerson>
<!-- De unieke identificatie van de persoon binnen Pynter. -->
<Id>int</Id>
<!-- Het medewerkernummer voor deze persoon. Kan gebruikt worden om de persoon op te wijzigen of op te halen. Moet uniek zijn. -->
<ExternalIdentifier>string</ExternalIdentifier>
<!-- De voornaam. -->
<FirstName>string</FirstName>
<!-- OPTIONEEL: Het tussenvoegsel. -->
<Insertion>string</Insertion>
<!-- De achternaam exclusief tussenvoegsel. -->
<FamilyName>string</FamilyName>
<!-- Een zakelijk e-mailadres voor de persoon. -->
<Email>string</Email>
<!-- Het autorisatieniveau van de persoon. -->
<!-- Zie de opmerking onder dit blok voor meer uitleg. -->
<AccountLevel></AccountLevel>
<!-- Of deze persoon een manager is of niet. -->
<IsManager>boolean</IsManager>
<!-- De naam van de functie. -->
<FunctionName>string</FunctionName>
<!-- De unieke identificatie van de functie binnen Pynter. -->
<FunctionId>int</FunctionId>
<!-- De naam van de divisie / locatie van de persoon. -->
<DivisionName>string</DivisionName>
<!-- De unieke identificatie van de divisie binnen Pynter. -->
<DivisionId>int</DivisionId>
<!-- De kostenplaats voor de persoon. -->
<CostCentre>string</CostCentre>
<!-- OPTIONEEL: De telefoonnummer. -->
<PhoneNumber>string</PhoneNumber>
<!-- OPTIONEEL: Wanneer het contract van kracht is. -->
<ContractStartTime>datetime</ContractStartTime>
<!-- OPTIONEEL: Wanneer het contract afloopt. -->
<ContractEndTime>datetime</ContractEndTime>
<!-- De unieke identificatie van de manager voor deze persoon binnen Pynter. -->
<ManagerId>int</ManagerId>
</personCreate>
Voor meer informatie over AccountLevel kan je de pagina over Autorisatie inzien.
GetPersonByEmail
Het ophalen van een gebruiker binnen Pynter via de GetPersonByEmail endpoint kan er als volgt uit zien:
POST /service/apiservice.asmx HTTP/1.1
Host: domein.acc.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>
<GetPersonByEmail xmlns="/service/ApiService.asmx">
<username>string</username>
<password>string</password>
<email>int</email>
</GetPersonByEmail>
</soap12:Body>
</soap12:Envelope>
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"?>
<ApiResponseOfPerson xmlns="/service/ApiService.asmx">
<Success>boolean</Success>
<Contents xmlns="ApiPerson"></Contents>
<Error>string</Error>
</ApiResponseOfPerson>
De Contents zal de volgende waarden van een ApiPerson bevatten:
<ApiPerson>
<!-- De unieke identificatie van de persoon binnen Pynter. -->
<Id>int</Id>
<!-- Het medewerkernummer voor deze persoon. Kan gebruikt worden om de persoon op te wijzigen of op te halen. Moet uniek zijn. -->
<ExternalIdentifier>string</ExternalIdentifier>
<!-- De voornaam. -->
<FirstName>string</FirstName>
<!-- OPTIONEEL: Het tussenvoegsel. -->
<Insertion>string</Insertion>
<!-- De achternaam exclusief tussenvoegsel. -->
<FamilyName>string</FamilyName>
<!-- Een zakelijk e-mailadres voor de persoon. -->
<Email>string</Email>
<!-- Het autorisatieniveau van de persoon. -->
<!-- Zie de opmerking onder dit blok voor meer uitleg. -->
<AccountLevel></AccountLevel>
<!-- Of deze persoon een manager is of niet. -->
<IsManager>boolean</IsManager>
<!-- De naam van de functie. -->
<FunctionName>string</FunctionName>
<!-- De unieke identificatie van de functie binnen Pynter. -->
<FunctionId>int</FunctionId>
<!-- De naam van de divisie / locatie van de persoon. -->
<DivisionName>string</DivisionName>
<!-- De unieke identificatie van de divisie binnen Pynter. -->
<DivisionId>int</DivisionId>
<!-- De kostenplaats voor de persoon. -->
<CostCentre>string</CostCentre>
<!-- OPTIONEEL: De telefoonnummer. -->
<PhoneNumber>string</PhoneNumber>
<!-- OPTIONEEL: Wanneer het contract van kracht is. -->
<ContractStartTime>datetime</ContractStartTime>
<!-- OPTIONEEL: Wanneer het contract afloopt. -->
<ContractEndTime>datetime</ContractEndTime>
<!-- De unieke identificatie van de manager voor deze persoon binnen Pynter. -->
<ManagerId>int</ManagerId>
</personCreate>
Voor meer informatie over AccountLevel kan je de pagina over Autorisatie inzien.