SOAP-Guide Easyflex

https://soapguide.easyflex.net
Admin
Documentation for Easyflex's SOAP webservice, enabling access and management of data related to...
Tokens:6,494
Snippets:17
Trust Score:6.4
Update:11 months ago
Show doc for...
Tokens:
Raw
### ef_opleidingen_read

Source: https://soapguide.easyflex.net/index

Retrieves education details based on the provided ef_opleiding_idnr. Use this endpoint to get detailed information about a specific education.

```APIDOC
## ef_opleidingen_read

### Description
Retrieves education details by ID.

### Method
SOAP

### Endpoint
/ef_opleidingen_read

### Parameters
#### Path Parameters
- **ef_opleiding_idnr** (integer) - Required - The ID of the education to retrieve.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_opleidingen_read>
         <ef_opleiding_idnr>123</ef_opleiding_idnr>
      </soap:ef_opleidingen_read>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_opleiding_idnr** (integer) - The ID of the education.
- **ef_opleiding_naam** (string) - The name of the education.
- **ef_opleiding_omschrijving** (string) - The description of the education.
- **ef_opleiding_children** (array) - Array of child education IDs.
- **ef_opleiding_parents** (array) - Array of parent education IDs.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_opleidingen_readResponse>
         <ef_opleiding_idnr>123</ef_opleiding_idnr>
         <ef_opleiding_naam>Education Name</ef_opleiding_naam>
         <ef_opleiding_omschrijving>Education Description</ef_opleiding_omschrijving>
         <ef_opleiding_children>...</ef_opleiding_children>
         <ef_opleiding_parents>...</ef_opleiding_parents>
      </ef_opleidingen_readResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_functies_read

Source: https://soapguide.easyflex.net/index

Retrieves function details based on the provided ef_functie_idnr. Use this endpoint to get detailed information about a specific function.

```APIDOC
## ef_functies_read

### Description
Retrieves function details by ID.

### Method
SOAP

### Endpoint
/ef_functies_read

### Parameters
#### Path Parameters
- **ef_functie_idnr** (integer) - Required - The ID of the function to retrieve.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_functies_read>
         <ef_functie_idnr>123</ef_functie_idnr>
      </soap:ef_functies_read>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_functie_idnr** (integer) - The ID of the function.
- **ef_functie_naam** (string) - The name of the function.
- **ef_functie_omschrijving** (string) - The description of the function.
- **ef_functie_children** (array) - Array of child function IDs.
- **ef_functie_parents** (array) - Array of parent function IDs.
- **ef_functie_sector** (string) - The sector of the function.
- **ef_functie_functiegroep** (string) - The function group of the function.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_functies_readResponse>
         <ef_functie_idnr>123</ef_functie_idnr>
         <ef_functie_naam>Function Name</ef_functie_naam>
         <ef_functie_omschrijving>Function Description</ef_functie_omschrijving>
         <ef_functie_children>...</ef_functie_children>
         <ef_functie_parents>...</ef_functie_parents>
         <ef_functie_sector>Sector</ef_functie_sector>
         <ef_functie_functiegroep>Function Group</ef_functie_functiegroep>
      </ef_functies_readResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_branches_read

Source: https://soapguide.easyflex.net/index

Retrieves branch details based on the provided ef_branche_idnr. Use this endpoint to get detailed information about a specific branch.

```APIDOC
## ef_branches_read

### Description
Retrieves branch details by ID.

### Method
SOAP

### Endpoint
/ef_branches_read

### Parameters
#### Path Parameters
- **ef_branche_idnr** (integer) - Required - The ID of the branch to retrieve.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_branches_read>
         <ef_branche_idnr>123</ef_branche_idnr>
      </soap:ef_branches_read>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_branche_idnr** (integer) - The ID of the branch.
- **ef_branche_naam** (string) - The name of the branch.
- **ef_branche_omschrijving** (string) - The description of the branch.
- **ef_branche_children** (array) - Array of child branch IDs.
- **ef_branche_parents** (array) - Array of parent branch IDs.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_branches_readResponse>
         <ef_branche_idnr>123</ef_branche_idnr>
         <ef_branche_naam>Branch Name</ef_branche_naam>
         <ef_branche_omschrijving>Branch Description</ef_branche_omschrijving>
         <ef_branche_children>...</ef_branche_children>
         <ef_branche_parents>...</ef_branche_parents>
      </ef_branches_readResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_opleidingen_search

Source: https://soapguide.easyflex.net/index

Searches for educations based on the provided ef_opleiding_zoek parameter. This endpoint allows you to find educations matching a specific search term.

```APIDOC
## ef_opleidingen_search

### Description
Searches for educations based on a search term.

### Method
SOAP

### Endpoint
/ef_opleidingen_search

### Parameters
#### Path Parameters
- **ef_opleiding_zoek** (string) - Required - The search term to use.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_opleidingen_search>
         <ef_opleiding_zoek>search term</ef_opleiding_zoek>
      </soap:ef_opleidingen_search>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_opleiding_idnr** (integer) - The ID of the education.
- **ef_opleiding_naam** (string) - The name of the education.
- **ef_opleiding_omschrijving** (string) - The description of the education.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_opleidingen_searchResponse>
         <ef_opleiding_idnr>123</ef_opleiding_idnr>
         <ef_opleiding_naam>Education Name</ef_opleiding_naam>
         <ef_opleiding_omschrijving>Education Description</ef_opleiding_omschrijving>
      </ef_opleidingen_searchResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_vaardigheden_children

Source: https://soapguide.easyflex.net/index

Retrieves child skills based on the provided ef_vaardigheid_idnr. Use this for navigating the skill hierarchy.

```APIDOC
## ef_vaardigheden_children

### Description
Retrieves child skills based on a parent skill ID.

### Method
SOAP

### Endpoint
/ef_vaardigheden_children

```

--------------------------------

### ef_functies_search

Source: https://soapguide.easyflex.net/index

Searches for functions based on the provided ef_functie_zoek parameter. This endpoint allows you to find functions matching a specific search term.

```APIDOC
## ef_functies_search

### Description
Searches for functions based on a search term.

### Method
SOAP

### Endpoint
/ef_functies_search

### Parameters
#### Path Parameters
- **ef_functie_zoek** (string) - Required - The search term to use.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_functies_search>
         <ef_functie_zoek>search term</ef_functie_zoek>
      </soap:ef_functies_search>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_functie_idnr** (integer) - The ID of the function.
- **ef_functie_naam** (string) - The name of the function.
- **ef_functie_omschrijving** (string) - The description of the function.
- **ef_functie_sector** (string) - The sector of the function.
- **ef_functie_functiegroep** (string) - The function group of the function.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_functies_searchResponse>
         <ef_functie_idnr>123</ef_functie_idnr>
         <ef_functie_naam>Function Name</ef_functie_naam>
         <ef_functie_omschrijving>Function Description</ef_functie_omschrijving>
         <ef_functie_sector>Sector</ef_functie_sector>
         <ef_functie_functiegroep>Function Group</ef_functie_functiegroep>
      </ef_functies_searchResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_opleidingen_children

Source: https://soapguide.easyflex.net/index

Retrieves child educations based on the provided ef_opleiding_idnr. This endpoint helps in navigating the education hierarchy.

```APIDOC
## ef_opleidingen_children

### Description
Retrieves child educations based on a parent education ID.

### Method
SOAP

### Endpoint
/ef_opleidingen_children

### Parameters
#### Path Parameters
- **ef_opleiding_idnr** (integer) - Required - The ID of the parent education.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_opleidingen_children>
         <ef_opleiding_idnr>123</ef_opleiding_idnr>
      </soap:ef_opleidingen_children>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_opleiding_idnr** (integer) - The ID of the child education.
- **ef_opleiding_naam** (string) - The name of the child education.
- **ef_opleiding_omschrijving** (string) - The description of the child education.
- **ef_opleiding_children** (array) - Array of child education IDs.
- **ef_opleiding_parents** (array) - Array of parent education IDs.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_opleidingen_childrenResponse>
         <ef_opleiding_idnr>456</ef_opleiding_idnr>
         <ef_opleiding_naam>Child Education Name</ef_opleiding_naam>
         <ef_opleiding_omschrijving>Child Education Description</ef_opleiding_omschrijving>
         <ef_opleiding_children>...</ef_opleiding_children>
         <ef_opleiding_parents>...</ef_opleiding_parents>
      </ef_opleidingen_childrenResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_opleidingen_parents

Source: https://soapguide.easyflex.net/index

Retrieves parent educations based on the provided ef_opleiding_idnr. This API helps in navigating up the education hierarchy.

```APIDOC
## ef_opleidingen_parents

### Description
Retrieves parent educations based on a child education ID.

### Method
SOAP

### Endpoint
/ef_opleidingen_parents

### Parameters
#### Path Parameters
- **ef_opleiding_idnr** (integer) - Required - The ID of the child education.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_opleidingen_parents>
         <ef_opleiding_idnr>456</ef_opleiding_idnr>
      </soap:ef_opleidingen_parents>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_opleiding_idnr** (integer) - The ID of the parent education.
- **ef_opleiding_naam** (string) - The name of the parent education.
- **ef_opleiding_omschrijving** (string) - The description of the parent education.
- **ef_opleiding_children** (array) - Array of child education IDs.
- **ef_opleiding_parents** (array) - Array of parent education IDs.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_opleidingen_parentsResponse>
         <ef_opleiding_idnr>123</ef_opleiding_idnr>
         <ef_opleiding_naam>Parent Education Name</ef_opleiding_naam>
         <ef_opleiding_omschrijving>Parent Education Description</ef_opleiding_omschrijving>
         <ef_opleiding_children>...</ef_opleiding_children>
         <ef_opleiding_parents>...</ef_opleiding_parents>
      </ef_opleidingen_parentsResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_landen

Source: https://soapguide.easyflex.net/index

Retrieves a list of countries. This endpoint provides information about available countries, including their code, name, and nationality.

```APIDOC
## ef_landen

### Description
Retrieves a list of countries.

### Method
SOAP

### Endpoint
/ef_landen

### Parameters
N/A

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_landen/>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_land_code** (string) - The country code.
- **ef_land_naam** (string) - The country name.
- **ef_land_nationaliteit** (string) - The country's nationality.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_landenResponse>
         <ef_land_code>NL</ef_land_code>
         <ef_land_naam>Netherlands</ef_land_naam>
         <ef_land_nationaliteit>Dutch</ef_land_nationaliteit>
      </ef_landenResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_branches_search

Source: https://soapguide.easyflex.net/index

Searches for branches based on the provided ef_branche_zoek parameter. This endpoint allows you to find branches matching a specific search term.

```APIDOC
## ef_branches_search

### Description
Searches for branches based on a search term.

### Method
SOAP

### Endpoint
/ef_branches_search

### Parameters
#### Path Parameters
- **ef_branche_zoek** (string) - Required - The search term to use.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_branches_search>
         <ef_branche_zoek>search term</ef_branche_zoek>
      </soap:ef_branches_search>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_branche_idnr** (integer) - The ID of the branch.
- **ef_branche_naam** (string) - The name of the branch.
- **ef_branche_omschrijving** (string) - The description of the branch.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_branches_searchResponse>
         <ef_branche_idnr>123</ef_branche_idnr>
         <ef_branche_naam>Branch Name</ef_branche_naam>
         <ef_branche_omschrijving>Branch Description</ef_branche_omschrijving>
      </ef_branches_searchResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_functies_parents

Source: https://soapguide.easyflex.net/index

Retrieves parent functions based on the provided ef_functie_idnr. This API helps in navigating up the function hierarchy.

```APIDOC
## ef_functies_parents

### Description
Retrieves parent functions based on a child function ID.

### Method
SOAP

### Endpoint
/ef_functies_parents

### Parameters
#### Path Parameters
- **ef_functie_idnr** (integer) - Required - The ID of the child function.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_functies_parents>
         <ef_functie_idnr>456</ef_functie_idnr>
      </soap:ef_functies_parents>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_functie_idnr** (integer) - The ID of the parent function.
- **ef_functie_naam** (string) - The name of the parent function.
- **ef_functie_omschrijving** (string) - The description of the parent function.
- **ef_functie_children** (array) - Array of child function IDs.
- **ef_functie_parents** (array) - Array of parent function IDs.
- **ef_functie_sector** (string) - The sector of the function.
- **ef_functie_functiegroep** (string) - The function group of the function.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_functies_parentsResponse>
         <ef_functie_idnr>123</ef_functie_idnr>
         <ef_functie_naam>Parent Function Name</ef_functie_naam>
         <ef_functie_omschrijving>Parent Function Description</ef_functie_omschrijving>
         <ef_functie_children>...</ef_functie_children>
         <ef_functie_parents>...</ef_functie_parents>
         <ef_functie_sector>Sector</ef_functie_sector>
         <ef_functie_functiegroep>Function Group</ef_functie_functiegroep>
      </ef_functies_parentsResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_branches_children

Source: https://soapguide.easyflex.net/index

Retrieves child branches based on the provided ef_branche_idnr. This endpoint allows you to navigate the branch hierarchy within EasyFlex.

```APIDOC
## ef_branches_children

### Description
Retrieves child branches based on a parent branch ID.

### Method
SOAP

### Endpoint
/ef_branches_children

### Parameters
#### Path Parameters
- **ef_branche_idnr** (integer) - Required - The ID of the parent branch.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_branches_children>
         <ef_branche_idnr>123</ef_branche_idnr>
      </soap:ef_branches_children>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_branche_idnr** (integer) - The ID of the child branch.
- **ef_branche_naam** (string) - The name of the child branch.
- **ef_branche_omschrijving** (string) - The description of the child branch.
- **ef_branche_children** (array) - Array of child branch IDs.
- **ef_branche_parents** (array) - Array of parent branch IDs.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_branches_childrenResponse>
         <ef_branche_idnr>456</ef_branche_idnr>
         <ef_branche_naam>Child Branch Name</ef_branche_naam>
         <ef_branche_omschrijving>Child Branch Description</ef_branche_omschrijving>
         <ef_branche_children>...</ef_branche_children>
         <ef_branche_parents>...</ef_branche_parents>
      </ef_branches_childrenResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_functies_children

Source: https://soapguide.easyflex.net/index

Retrieves child functions based on the provided ef_functie_idnr. This is useful for navigating the function hierarchy.

```APIDOC
## ef_functies_children

### Description
Retrieves child functions based on a parent function ID.

### Method
SOAP

### Endpoint
/ef_functies_children

### Parameters
#### Path Parameters
- **ef_functie_idnr** (integer) - Required - The ID of the parent function.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_functies_children>
         <ef_functie_idnr>123</ef_functie_idnr>
      </soap:ef_functies_children>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_functie_idnr** (integer) - The ID of the child function.
- **ef_functie_naam** (string) - The name of the child function.
- **ef_functie_omschrijving** (string) - The description of the child function.
- **ef_functie_children** (array) - Array of child function IDs.
- **ef_functie_parents** (array) - Array of parent function IDs.
- **ef_functie_sector** (string) - The sector of the function.
- **ef_functie_functiegroep** (string) - The function group of the function.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_functies_childrenResponse>
         <ef_functie_idnr>456</ef_functie_idnr>
         <ef_functie_naam>Child Function Name</ef_functie_naam>
         <ef_functie_omschrijving>Child Function Description</ef_functie_omschrijving>
         <ef_functie_children>...</ef_functie_children>
         <ef_functie_parents>...</ef_functie_parents>
         <ef_functie_sector>Sector</ef_functie_sector>
         <ef_functie_functiegroep>Function Group</ef_functie_functiegroep>
      </ef_functies_childrenResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

--------------------------------

### ef_branches_parents

Source: https://soapguide.easyflex.net/index

Retrieves parent branches based on the provided ef_branche_idnr. This API endpoint is useful for traversing up the branch hierarchy.

```APIDOC
## ef_branches_parents

### Description
Retrieves parent branches based on a child branch ID.

### Method
SOAP

### Endpoint
/ef_branches_parents

### Parameters
#### Path Parameters
- **ef_branche_idnr** (integer) - Required - The ID of the child branch.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="SOAP-Guide">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ef_branches_parents>
         <ef_branche_idnr>456</ef_branche_idnr>
      </soap:ef_branches_parents>
   </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **ef_branche_idnr** (integer) - The ID of the parent branch.
- **ef_branche_naam** (string) - The name of the parent branch.
- **ef_branche_omschrijving** (string) - The description of the parent branch.
- **ef_branche_children** (array) - Array of child branch IDs.
- **ef_branche_parents** (array) - Array of parent branch IDs.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ef_branches_parentsResponse>
         <ef_branche_idnr>123</ef_branche_idnr>
         <ef_branche_naam>Parent Branch Name</ef_branche_naam>
         <ef_branche_omschrijving>Parent Branch Description</ef_branche_omschrijving>
         <ef_branche_children>...</ef_branche_children>
         <ef_branche_parents>...</ef_branche_parents>
      </ef_branches_parentsResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```
Tokens:
Raw