### Get Student Mapping Request Examples (Multiple Languages)

Source: https://developer.timeedit.com/reference/student-mapping

Examples of how to make a GET request to the /v3/student-mappings/ endpoint using different programming languages. These snippets demonstrate fetching student mapping data.

```Node.js
fetch('https://exam.eu.timeedit.net/api/v3/student-mappings/', {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
})
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('Error fetching student mappings:', error);
  });
```

```Ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://exam.eu.timeedit.net/api/v3/student-mappings/')

response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
  request = Net::HTTP::Get.new(uri)
  request['accept'] = 'application/json'
  http.request(request)
end

puts response.body
```

```PHP
<?php

$url = 'https://exam.eu.timeedit.net/api/v3/student-mappings/';

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('accept: application/json'));

$response = curl_exec($ch);

if ($response === false) {
    echo 'Curl error: ' . curl_error($ch);
} else {
    echo $response;
}

cartridge_close($ch);
?>
```

```Python
import requests

url = "https://exam.eu.timeedit.net/api/v3/student-mappings/"
headers = {
    "accept": "application/json"
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    student_mappings = response.json()
    print(student_mappings)
except requests.exceptions.RequestException as e:
    print(f"Error fetching student mappings: {e}")
```

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

### Get Reservation Situations Example Request

Source: https://developer.timeedit.com/reference/reservations-1

An example XML request to retrieve reservation situations. It specifies the desired type as 'group' and filters for active reservations.

```xml
<tns:types>
  <type>group</type>
</tns:types>
<tns:reservationsituation></tns:reservationsituation>
<tns:activeonly>true</tns:activeonly>
```

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

### GET /portal/members Request Examples in Multiple Languages

Source: https://developer.timeedit.com/reference/portal

Examples of making a GET request to the /portal/members endpoint, showing how to retrieve tasks for members. These examples cover various programming languages, illustrating different client implementations.

```shell
curl --request GET \
     --url 'https://portal/members?page=0&size=20' \
     --header 'accept: */*'
```

```javascript
const url = 'https://portal/members?page=0&size=20';

fetch(url, {
  method: 'GET',
  headers: {
    'accept': '*/*'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

```python
import requests

url = 'https://portal/members?page=0&size=20'
headers = {
    'accept': '*/*'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

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

### Get Reservation Situation Kinds Example Response

Source: https://developer.timeedit.com/reference/reservations-1

An example XML response showcasing available reservation situation kinds. Each kind includes a name and a description, which can be used with the getReservationSituations function.

```xml
<reservationsituationkinds>
    <reservationsituationkind>
        <name>RESERVATION</name>
        <description>...</description>
    </reservationsituationkind>
    <reservationsituationkind>
        <name>AVAILABILITY</name>
        <description>...</description>
    </reservationsituationkind>
</reservationsituationkinds>
```

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

### GET /v3/public-settings/ Request Examples

Source: https://developer.timeedit.com/reference/public-setting

Demonstrates how to make a GET request to the /v3/public-settings/ endpoint. This includes the base URL, required headers, and expected response format.

```shell
curl --request GET \
     --url https://exam.eu.timeedit.net/api/v3/public-settings/ \
     --header 'accept: application/json'
```

```node
const url = 'https://exam.eu.timeedit.net/api/v3/public-settings/';

fetch(url, {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://exam.eu.timeedit.net/api/v3/public-settings/')

response = Net::HTTP.get_response(uri)

puts response.body
```

```php
<?php

$url = 'https://exam.eu.timeedit.net/api/v3/public-settings/';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('accept: application/json'));

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}

curl_close($ch);

echo $response;
?>
```

```python
import requests

url = 'https://exam.eu.timeedit.net/api/v3/public-settings/'
headers = {'accept': 'application/json'}

response = requests.get(url, headers=headers)

print(response.json())
```

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

### Get Schedule Preferences (Ruby)

Source: https://developer.timeedit.com/reference/schedule-preference

Illustrates how to retrieve schedule preferences using Ruby's Net::HTTP library. This example shows the setup for a GET request to the specified API endpoint.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://import/v2/schedule-preference')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true # if you need HTTPS

request = Net::HTTP::Get.new(uri.request_uri)
request['accept'] = '*/*'

response = http.request(request)
puts response.body
```

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

### Get Cancelled Reservation Sort Orders XML Example

Source: https://developer.timeedit.com/reference/cancellations-1

This example shows a request to get available sort orders for cancelled reservations. The request is minimal, primarily requiring a login object.

```xml
-
```

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

### GET /import/person Request Examples (cURL, Node.js, Python)

Source: https://developer.timeedit.com/reference/person-1

Demonstrates how to make a GET request to the /import/person endpoint using cURL, Node.js, and Python. These examples show how to specify query parameters like 'active', 'page', and 'size' for filtering and pagination. The 'accept' header is also included.

```shell
curl --request GET \
     --url 'https://import/person?active=true&page=0&size=20' \
     --header 'accept: */*'
```

```javascript
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://import/person',
  params: {
    active: 'true',
    page: '0',
    size: '20'
  },
  headers: {
    'accept': '*/*'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});
```

```python
import requests

url = "https://import/person"
params = {
    "active": "true",
    "page": "0",
    "size": "20"
}
headers = {
    "accept": "*/*"
}

response = requests.get(url, params=params, headers=headers)

print(response.json())
```

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

### Get Student Seatings (Ruby)

Source: https://developer.timeedit.com/reference/student-seating

Ruby code example for retrieving student seatings using the 'net/http' library. It illustrates constructing the HTTP GET request with the correct URL and headers.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://exam.eu.timeedit.net/api/v3/student-seatings/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.request_uri)
request['accept'] = 'application/json'

response = http.request(request)
puts response.body
```

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

### Import Reservations XML Example

Source: https://developer.timeedit.com/reference/reservations-1

This XML snippet demonstrates the structure of a request to import reservations. It includes reservation details such as start and end times, associated objects (staff, activity, company, etc.), and custom fields like comments. The `allowIncomplete` and `reservationsituation` elements control import behavior.

```xml
<tns:reservations>
    <reservation>
        <begin>20190605T103000</begin>
        <end>20190605T120000</end>
        <objects>
            <object>
                <type>staff</type>
                <value>d7ae3d30-6510-4cf3-8f5f-f4fb238e488d</value>
            </object>
            <object>
                <type>staff</type>
                <value>2ff60334-86ee-4834-867a-8b9c4de072e0</value>
            </object>
            <object>
                <type>activity</type>
                <value>fe1835f8-97c8-400b-9440-19e07e216c5e</value>
            </object>
            <object>
                <type>company</type>
                <value>be7a66d4-7ba2-4e86-b3ea-1f436b7adc63</value>
            </object>
            <object>
                <type>project</type>
                <value>45e7140c-a38c-410b-9fa0-c1708af1b390</value>
            </object>
            <object>
                <type>contact</type>
                <value>4d10f5a3-7b4d-4716-99ab-e84de13efbfe</value>
            </object>
            <object>
                <type>place</type>
                <value>3becbee1-d3b8-4998-8af2-21aa34f06f89</value>
            </object>
        </objects>
        <fields>
            <field>
                <extid>reservation.comment</extid>
                <value>Bring pencil</value>
            </field>
        </fields>
        <organizations>
            <organization></organization>
        </organizations>
    </reservation>
</tns:reservations>
<tns:allowincomplete>true</tns:allowincomplete>
<tns:reservationsituation></tns:reservationsituation>
```

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

### Make API Calls with Bearer Token (cURL)

Source: https://developer.timeedit.com/reference/getting-started

This cURL example illustrates how to make subsequent API calls after obtaining an access token. The access token is used as a Bearer token in the 'Authorization' header for authenticated requests.

```curl
curl --request POST \
     --url https://api.timeedit.net/v1/... \
     --header 'Authorization: Bearer [Insert token here]' \
     --header 'accept: application/json'
```

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

### Import Reservations XML Example

Source: https://developer.timeedit.com/reference/reservations-1

This XML snippet demonstrates the structure for importing reservations into TimeEdit. It includes details like reservation times, associated objects, custom fields, organizations, and user information for modification tracking. The import can optionally allow incomplete reservations and specify a reservation situation.

```xml
<tns:reservations>
    <reservation>
        <begin>20190605T103000</begin>
        <end>20190605T120000</end>
        <objects>
            <object>
                <type>room</type>
                <value>room_SomeGroupRoom</value>
            </object>
            <object>
                <type>student</type>
                <value>StudentObject</value>
            </object>
        </objects>
        <fields>
            <field>
                <extid>reservation.comment</extid>
                <value>This is very we study stuff</value>
            </field>
        </fields>
        <organizations>
            <organization>SomeOrg</organization>
        </organizations>
        <newmodifiedby>
            <loginname>StudentUserName</loginname>
            <authserver>Students_SAML2</authserver>
        </newmodifiedby>
    </reservation>
</tns:reservations>
<tns:allowincomplete>true</tns:allowincomplete>
<tns:reservationsituation>StudentGroupRoomBooking</tns:reservationsituation>
<tns:user>
    <loginname>StudentUserName</loginname>
    <authserver>Students_SAML2</authserver>
</tns:user>
```

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

### Get Schedule Preferences (Python)

Source: https://developer.timeedit.com/reference/schedule-preference

Shows how to get schedule preferences using Python's requests library. This example makes a GET request to the /import/v2/schedule-preference endpoint.

```python
import requests

url = "https://import/v2/schedule-preference"

headers = {
  'accept': '*/*'
}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### List Holidays PHP Request

Source: https://developer.timeedit.com/reference/holidays-1

Example of how to list holidays using PHP. This snippet demonstrates using Guzzle HTTP client to perform a GET request to the holidays API. It includes parameters for holiday region, type, start date, and end date, along with headers to accept JSON.

```php
<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;

$client = new Client();

$request = new Request('GET', 'https://api.timeedit.net/v1/holidays?holidayRegion=string&holidayType=string&startDate=1678886400&endDate=1681564800');

$headers = [
  'accept' => 'application/json'
];

try {
    $response = $client->send($request, ['headers' => $headers]);
    echo $response->getBody();
} catch (Exception $e) {
    echo 'Error: ' . $e->getMessage();
}

?>
```

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

### List Users (Ruby)

Source: https://developer.timeedit.com/reference/users-2

Example of how to list users using Ruby. This snippet shows how to perform a GET request to the users API.

```ruby
# Ruby example would go here, using a library like 'net/http' or 'httparty'
# For example:
# require 'net/http'
# require 'uri'
# 
# uri = URI.parse('https://api.timeedit.net/v1/users')
# Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
#   request = Net::HTTP::Get.new(uri)
#   request['accept'] = 'application/json'
# 
#   response = http.request(request)
#   puts response.body
# end
```

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

### XML Request Example for getReservations

Source: https://developer.timeedit.com/reference/reservations-1

This XML snippet demonstrates a request to the getReservations endpoint. It specifies the date range, search objects (a room with a specific external ID), reservation statuses, and the desired return fields for rooms and courses. It also sets parameters for pagination and sorting.

```xml
<tns:begintime>20191201T000000</tns:begintime>
<tns:endtime>20191224T000000</tns:endtime>
<tns:beginmodified></tns:beginmodified>
<tns:endmodified></tns:endmodified>
<tns:reservationsituation></tns:reservationsituation>
<tns:searchobjects>
  <object>
    <extid>the_external_id_of_a_room</extid>
    <type>room</type>
  </object>
</tns:searchobjects>
<tns:exactsearchfields>
</tns:exactsearchfields>
<tns:generalsearchfields>
</tns:generalsearchfields>
<tns:generalsearchstring></tns:generalsearchstring>
<tns:types>
</tns:types>
<tns:reservationstatuslist>
  <status>B_COMPLETE</status>
  <status>B_INCOMPLETE</status>
  <status>C_CONFIRMED</status>
  <status>C_PRELIMINARY</status>
</tns:reservationstatuslist>
<tns:allreservations>true</tns:allreservations>
<tns:sortorder>ID_ASCENDING</tns:sortorder>
<tns:returnfields>
  <field>reservation.commment</field>
</tns:returnfields>
<tns:returntypes>
  <typefield>
    <type>room</type>
    <field>room.name</field>
    <field>room.seats</field>
  </typefield>
  <typefield>
    <type>course</type>
    <field>course.name</field>
    <field>course.code</field>
  </typefield>
</tns:returntypes>
<tns:beginindex>0</tns:beginindex>
<tns:numberofreservations>1000</tns:numberofreservations>
```

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

### Get Modifiable Reservation Fields Example

Source: https://developer.timeedit.com/reference/reservations-1

This XML snippet shows an example request for the getModifiableReservationFields function. It specifies the reservation ID for which to retrieve modifiable fields.

```xml
<tns:reservation>6559</tns:reservation>
```

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

### List Users (PHP)

Source: https://developer.timeedit.com/reference/users-2

Example of how to list users using PHP. This snippet illustrates making a GET request to the users endpoint.

```php
// PHP example would go here, using cURL or file_get_contents
// For example:
// $ch = curl_init();
// curl_setopt($ch, CURLOPT_URL, 'https://api.timeedit.net/v1/users');
// curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// curl_setopt($ch, CURLOPT_HTTPHEADER, array('accept: application/json'));
// 
// $response = curl_exec($ch);
// curl_close($ch);
// 
// echo $response;
```

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

### Get Request Settings using Python

Source: https://developer.timeedit.com/reference/request-setting

This Python snippet demonstrates fetching request settings from the API. It uses the 'requests' library to perform a GET request and prints the JSON response. Make sure to install the 'requests' library (`pip install requests`).

```python
import requests

url = "https://exam.eu.timeedit.net/api/v3/request-settings/"
headers = {
    "accept": "application/json"
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"Error making request: {e}")
```

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

### POST /v3/room-bookings/

Source: https://developer.timeedit.com/reference/post_v3-room-bookings

Creates a room booking. This endpoint allows you to schedule an exam in a specific room for a given date and time, specifying the number of supervisors needed.

```APIDOC
## POST /v3/room-bookings/

### Description
Creates a room booking. This endpoint allows you to schedule an exam in a specific room for a given date and time, specifying the number of supervisors needed.

### Method
POST

### Endpoint
/v3/room-bookings/

### Parameters
#### Request Body
- **organizationId** (string) - Required - The ID of the organization.
- **date** (string) - Required - The date of the booking in `date-time` format.
- **roomExtId** (string) - Optional - The external ID of the room.
- **room** (string) - Required - The name of the room.
- **roomId** (number) - Optional - The ID of the room.
- **startTime** (number) - Optional - The start time of the booking.
- **endTime** (number) - Optional - The end time of the booking.
- **prepStartTime** (number) - Optional - The preparation start time.
- **postEndTime** (number) - Optional - The post-exam end time.
- **examSlot** (string) - Required - The exam slot identifier.
- **examSlotId** (number) - Optional - The ID of the exam slot.
- **supervisorsNeeded** (number) - Required - The number of supervisors required.
- **comment** (string) - Optional - Additional comments for the booking.
- **teExtId** (string) - Optional - The external ID from TimeEdit.
- **deletedAt** (string) - Optional - The deletion timestamp in `date-time` format.
- **scheduledExams** (array of strings) - Optional - List of scheduled exam identifiers.
- **roomBookingId** (number) - Optional - The ID of the room booking.
- **updatedAt** (string) - Optional - The update timestamp in `date-time` format.
- **createdAt** (string) - Optional - The creation timestamp in `date-time` format.
- **deleted** (boolean) - Optional - Indicates if the booking is deleted.
- **id** (string) - Optional - The unique identifier for the booking.

### Request Example
```json
[
  {
    "roomId": 12345,
    "examSlotId": 67890,
    "date": "2023-10-27T10:00:00Z",
    "supervisorsNeeded": 5
  }
]
```

### Response
#### Success Response (200)
- **organizationId** (string) - The ID of the organization.
- **date** (string) - The date of the booking in `date-time` format.
- **roomExtId** (string) - The external ID of the room.
- **room** (string) - The name of the room.
- **roomId** (number) - The ID of the room.
- **startTime** (number) - The start time of the booking.
- **endTime** (number) - The end time of the booking.
- **prepStartTime** (number) - The preparation start time.
- **postEndTime** (number) - The post-exam end time.
- **examSlot** (string) - The exam slot identifier.
- **examSlotId** (number) - The ID of the exam slot.
- **supervisorsNeeded** (number) - The number of supervisors required.
- **comment** (string) - Additional comments for the booking.
- **teExtId** (string) - The external ID from TimeEdit.
- **deletedAt** (string) - The deletion timestamp in `date-time` format.
- **scheduledExams** (array of strings) - List of scheduled exam identifiers.
- **roomBookingId** (number) - The ID of the room booking.
- **updatedAt** (string) - The update timestamp in `date-time` format.
- **createdAt** (string) - The creation timestamp in `date-time` format.
- **deleted** (boolean) - Indicates if the booking is deleted.
- **id** (string) - The unique identifier for the booking.

#### Response Example
```json
{
  "organizationId": "org123",
  "date": "2023-10-27T10:00:00Z",
  "room": "Conference Room A",
  "examSlot": "Morning Session",
  "supervisorsNeeded": 5,
  "roomBookingId": 98765,
  "createdAt": "2023-10-26T14:30:00Z"
}
```
```

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

### GET Organization Node.js Request

Source: https://developer.timeedit.com/reference/organizations-1

Example Node.js code using the 'axios' library to make a GET request to the Organization API. It shows how to configure the request with the base URL, organizationId, and accept header.

```javascript
const axios = require('axios');

async function getOrganization(organizationId) {
  const url = `https://api.timeedit.net/v1/organizations/${organizationId}`;
  try {
    const response = await axios.get(url, {
      headers: {
        'accept': 'application/json'
      }
    });
    return response.data;
  } catch (error) {
    console.error('Error fetching organization:', error);
    throw error;
  }
}

// Example usage:
// getOrganization('your_organization_id').then(data => console.log(data));
```

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

### GET Organization cURL Request

Source: https://developer.timeedit.com/reference/organizations-1

Example cURL command to retrieve organization details. It demonstrates the GET request method, the target URL with a placeholder for organizationId, and the necessary accept header for JSON response.

```shell
curl --request GET \
     --url https://api.timeedit.net/v1/organizations/organizationId \
     --header 'accept: application/json'
```

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

### List Users (Node.js)

Source: https://developer.timeedit.com/reference/users-2

Example of how to list users using Node.js. This snippet demonstrates making a GET request to the users endpoint.

```javascript
// Node.js example would go here, using a library like 'axios' or 'node-fetch'
// For example:
// const axios = require('axios');
// 
// axios.get('https://api.timeedit.net/v1/users', {
//   headers: {
//     'accept': 'application/json'
//   }
// })
// .then(response => {
//   console.log(response.data);
// })
// .catch(error => {
//   console.error(error);
// });
```

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

### Configuration Object

Source: https://developer.timeedit.com/reference/get_time-rules-timeruleid

Details the configuration object, including various time-related settings such as importStep, minimumLength, maximumLength, defaultLength, and time slot selection.

```APIDOC
## Configuration Object

### Description
This object defines various configuration parameters for time-based operations, including default durations, length constraints, and specific time slot selections.

### Properties

- **importStep** (integer, int64) - Example: 3600. The step size for importing time data.
- **minimumLength** (integer, int64) - Example: 900. The minimum allowed duration in seconds.
- **maximumLength** (integer, int64) - Example: 86400. The maximum allowed duration in seconds.
- **defaultLength** (integer, int64) - Example: 7200. The default duration in seconds.
- **beginOffset** (integer, int64) - Example: 0. An offset in seconds from the beginning of a period.
- **timeSlotSelection** (array) - Represents a selection of time slots for a given period.
  - **items** (object)
    - **weekdays** (array, string) - Enum: ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"]. Example: "MON". Specifies the days of the week.
    - **times** (array, object)
      - **clockTimeStart** (integer, int64) - Example: 28800. The start time of the slot in seconds since midnight.
      - **clockTimeEnd** (integer, int64) - Example: 36000. The end time of the slot in seconds since midnight.
- **absoluteStartTime** (integer, int64) - Example: 0. An absolute start time.
- **absoluteEndTime** (integer, int64) - Example: 0. An absolute end time.
- **relativeStartTime** (integer, int64) - Example: -3600. A relative start time in seconds.
- **relativeEndTime** (integer, int64) - Example: 3600. A relative end time in seconds.
- **useStartTimeToOpenNextDay** (boolean) - Flag to indicate if the start time should open the next day.
- **useSeparateCancellationRules** (boolean) - Flag to indicate if separate cancellation rules should be used.
- **absoluteCancellationStartTime** (integer, int64) - Example: 0. An absolute start time for cancellations.
- **absoluteCancellationEndTime** (integer, int64) - Example: 0. An absolute end time for cancellations.
- **relativeCancellationStartTime** (integer, int64) - Example: -3600. A relative start time for cancellations in seconds.
- **relativeCancellationEndTime** (integer, int64) - Example: 3600. A relative end time for cancellations in seconds.
- **reservationPeriod1** (string) - Enum: ["NONE", "RESERVATION_PERIOD", "DAY", "WEEK", "MONTH", "YEAR"]. Example: "DAY". Defines the reservation period type.
```

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

### Get Exam Comments List (PHP)

Source: https://developer.timeedit.com/reference/exam-comment

Shows how to get exam comments using PHP. This example uses cURL to perform the GET request, setting the URL and the 'accept' header for the response.

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, 'https://exam.eu.timeedit.net/api/v3/exam-comments/');
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
  'accept: application/json'
));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:", $err;
} else {
  echo $response;
}

?>
```

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

### List Users (Python)

Source: https://developer.timeedit.com/reference/users-2

Example of how to list users using Python. This snippet shows how to send a GET request to the users API.

```python
# Python example would go here, using the 'requests' library
# For example:
# import requests
# 
# url = 'https://api.timeedit.net/v1/users'
# headers = {'accept': 'application/json'}
# 
# response = requests.get(url, headers=headers)
# 
# print(response.json())
```

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

### Import Reservations with Double Objects XML Example

Source: https://developer.timeedit.com/reference/reservations-1

This XML example showcases the `importReservations` functionality with the `double="true"` attribute for objects, indicating that these objects can be linked to multiple reservations. It includes standard reservation details and custom fields.

```xml
<tns:reservations>
    <reservation>
        <begin>20190605T103000</begin>
        <end>20190605T120000</end>
        <objects>
            <object double="true">
                <type>staff</type>
                <value>d7ae3d30-6510-4cf3-8f5f-f4fb238e488d</value>
            </object>
            <object double="true">
                <type>staff</type>
                <value>2ff60334-86ee-4834-867a-8b9c4de072e0</value>
            </object>
            <object>
                <type>activity</type>
                <value>fe1835f8-97c8-400b-9440-19e07e216c5e</value>
            </object>
            <object>
                <type>company</type>
                <value>be7a66d4-7ba2-4e86-b3ea-1f436b7adc63</value>
            </object>
            <object>
                <type>project</type>
                <value>45e7140c-a38c-410b-9fa0-c1708af1b390</value>
            </object>
            <object>
                <type>contact</type>
                <value>4d10f5a3-7b4d-4716-99ab-e84de13efbfe</value>
            </object>
            <object>
                <type>place</type>
                <value>3becbee1-d3b8-4998-8af2-21aa34f06f89</value>
            </object>
        </objects>
        <fields>
            <field>
                <extid>reservation.comment</extid>
                <value>Bring pencil</value>
            </field>
        </fields>
        <organizations>
            <organization>SomeOrg</organization>
        </organizations>
    </reservation>
</tns:reservations>
<tns:allowincomplete>true</tns:allowincomplete>
<tns:reservationsituation></tns:reservationsituation>
```

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

### Fetch Specifications with GET Request (Python)

Source: https://developer.timeedit.com/reference/specification

This Python code snippet shows how to make a GET request to the /import/v2/specification endpoint using the 'requests' library. It includes setting the 'accept' header and handling potential errors during the request. Ensure the 'requests' library is installed (`pip install requests`).

```python
import requests

url = "https://import/v2/specification"
headers = {
  'accept': '*/*'
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"Error fetching specifications: {e}")
```

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

### GET Room Bookings Request (Python)

Source: https://developer.timeedit.com/reference/room-booking

This snippet illustrates how to retrieve room bookings using Python with the 'requests' library. It sends a GET request to the API endpoint, specifying the 'accept' header for JSON. You need to have the 'requests' library installed (`pip install requests`).

```Python
import requests

url = "https://exam.eu.timeedit.net/api/v3/room-bookings/"
headers = {
    "accept": "application/json"
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"Error fetching room bookings: {e}")

```

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

### SOAP Register Function Example

Source: https://developer.timeedit.com/reference/the-data-model

This section demonstrates a sample SOAP call to the register function, including necessary headers and the XML payload.

```APIDOC
## SOAP Register Function Example

### Description
An example of a SOAP call to the register function. This demonstrates the required HTTP headers and the XML structure for the request.

### Method
POST

### Endpoint
`https://cloud.timeedit.net/api/v3/soap` (This is an assumed endpoint based on common SOAP practices and the Host header provided)

### Headers
- **Content-Type**: `text/xml;charset=UTF-8`
- **SOAPAction**: `"register"`
- **Host**: `cloud.timeedit.net`
- **User-Agent**: `SampleClient`

### Request Body
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tns="http://www.timeedit.se/timeedit3/version3">
   <soapenv:Header/>
   <soapenv:Body>
      <tns:register>
         <tns:certificate>Base64-encoded-certificate-goes-here</tns:certificate>
      </tns:register>
   </soapenv:Body>
</soapenv:Envelope>
```

### Request Example
```json
{
  "headers": {
    "Content-Type": "text/xml;charset=UTF-8",
    "SOAPAction": "register",
    "Host": "cloud.timeedit.net",
    "User-Agent": "SampleClient"
  },
  "body": "<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:tns=\"http://www.timeedit.se/timeedit3/version3\">\n   <soapenv:Header/>\n   <soapenv:Body>\n      <tns:register>\n         <tns:certificate>Base64-encoded-certificate-goes-here</tns:certificate>\n      </tns:register>\n   </soapenv:Body>\n</soapenv:Envelope>"
}
```

### Response
#### Success Response (200)
*   **response** (string) - A SOAP XML response indicating success or failure of the registration.

#### Response Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <tns:registerResponse xmlns:tns="http://www.timeedit.se/timeedit3/version3">
         <tns:success>true</tns:success>
         <tns:message>Registration successful</tns:message>
      </tns:registerResponse>
   </soapenv:Body>
</soapenv:Envelope>
```
```

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

### GET Room Bookings Request (Node.js)

Source: https://developer.timeedit.com/reference/room-booking

This snippet shows how to fetch room bookings using Node.js with the 'axios' library. It constructs the GET request to the specified URL, including the 'accept' header. You will need to install 'axios' (`npm install axios`) and handle authentication appropriately.

```JavaScript
const axios = require('axios');

const url = 'https://exam.eu.timeedit.net/api/v3/room-bookings/';

axios.get(url, {
  headers: {
    'accept': 'application/json'
  }
})
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error('Error fetching room bookings:', error);
  });

```

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

### List Reservation Templates (Ruby)

Source: https://developer.timeedit.com/reference/reservation-templates-1

This snippet illustrates how to list reservation templates using Ruby's Net::HTTP library. It sets up the HTTP request with the appropriate URL and headers.

```ruby
require 'uri'
require 'net/http'

uri = URI.parse('https://api.timeedit.net/v1/reservation-templates')

Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
  request = Net::HTTP::Get.new(uri)
  request['accept'] = 'application/json'

  response = http.request(request)
  puts response.body
end
```

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

### GET Organization Python Request

Source: https://developer.timeedit.com/reference/organizations-1

Example Python code utilizing the 'requests' library to make a GET request to the Organization API. It shows how to construct the URL, set the 'accept' header, and handle the JSON response.

```python
import requests

def get_organization(organization_id):
    url = f"https://api.timeedit.net/v1/organizations/{organization_id}"
    headers = {
        'accept': 'application/json'
    }
    
    try:
        response = requests.get(url, headers=headers)
        response.raise_for_status()  # Raise an exception for bad status codes (4xx or 5xx)
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Error fetching organization: {e}")
        return None

# Example usage:
# organization_data = get_organization('your_organization_id')
# if organization_data:
#     print(organization_data)
```

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

### Time Slot Configuration

Source: https://developer.timeedit.com/reference/get_time-rules

This section details the configuration parameters for setting up time slots, including minimum and maximum durations, step intervals, and time selection options.

```APIDOC
## Time Slot Configuration Details

### Description
Provides detailed configuration options for managing time slots, including length constraints, scheduling intervals, and specific time windows.

### Method
N/A (Configuration details)

### Endpoint
N/A (Configuration details)

### Parameters
#### Request Body
- **minimumStep** (integer, int64) - Example: 3600 - The minimum step in seconds for time increments.
- **beginStep** (integer, int64) - Example: 3600 - The step in seconds at which scheduling begins.
- **importStep** (integer, int64) - Example: 3600 - The step in seconds used for imports.
- **minimumLength** (integer, int64) - Example: 900 - The minimum duration of a time slot in seconds.
- **maximumLength** (integer, int64) - Example: 86400 - The maximum duration of a time slot in seconds.
- **defaultLength** (integer, int64) - Example: 7200 - The default duration of a time slot in seconds.
- **beginOffset** (integer, int64) - Example: 0 - The offset in seconds from the start of the day.
- **timeSlotSelection** (array) - Defines specific time windows for scheduling.
  - **weekdays** (array of strings) - Enum: ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"] - Example: "MON" - The days of the week the time slot applies to.
  - **times** (array of objects) - Defines specific time ranges within a day.
    - **clockTimeStart** (integer, int64) - Example: 28800 - The start time in seconds from midnight.
    - **clockTimeEnd** (integer, int64) - Example: 36000 - The end time in seconds from midnight.
- **absoluteStartTime** (integer, int64) - Example: 0 - The absolute start time for a slot.
- **absoluteEndTime** (integer, int64) - Example: 0 - The absolute end time for a slot.
- **relativeStartTime** (integer, int64) - Example: -3600 - The start time relative to an event.
- **relativeEndTime** (integer, int64) - Example: 3600 - The end time relative to an event.
- **useStartTimeToOpenNextDay** (boolean) - Flag to use the start time to open the next day.
- **useSeparateCancellationRules** (boolean) - Flag to use separate rules for cancellations.
- **absoluteCancellationStartTime** (integer, int64) - Example: 0 - The absolute start time for cancellations.
- **absoluteCancellationEndTime** (integer, int64) - Example: 0 - The absolute end time for cancellations.

### Request Example
```json
{
  "minimumStep": 3600,
  "beginStep": 3600,
  "importStep": 3600,
  "minimumLength": 900,
  "maximumLength": 86400,
  "defaultLength": 7200,
  "beginOffset": 0,
  "timeSlotSelection": [
    {
      "weekdays": ["MON"],
      "times": [
        {
          "clockTimeStart": 28800,
          "clockTimeEnd": 36000
        }
      ]
    }
  ],
  "absoluteStartTime": 0,
  "absoluteEndTime": 0,
  "relativeStartTime": -3600,
  "relativeEndTime": 3600,
  "useStartTimeToOpenNextDay": false,
  "useSeparateCancellationRules": false,
  "absoluteCancellationStartTime": 0,
  "absoluteCancellationEndTime": 0
}
```

### Response
#### Success Response (200)
- **Configuration Confirmation** (object) - Indicates successful application of the time slot configuration.

#### Response Example
```json
{
  "message": "Time slot configuration updated successfully."
}
```
```