selfservice.api.rotaone.com
Open in
urlscan Pro
51.105.74.161
Public Scan
Submitted URL: https://selfservice.api.rotaone.com/
Effective URL: https://selfservice.api.rotaone.com/swagger/ui/index
Submission: On November 07 via automatic, source certstream-suspicious — Scanned from GB
Effective URL: https://selfservice.api.rotaone.com/swagger/ui/index
Submission: On November 07 via automatic, source certstream-suspicious — Scanned from GB
Form analysis 147 forms found in the DOM
<form id="api_selector">
<div class="input"><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"></div>
<div class="input"><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"></div>
<div class="input"><a id="explore" class="header__btn" href="#" data-sw-translate="">Explore</a></div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="massetScanDto0.22539599599628324">assetScanDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="assetScanDto" id="massetScanDto0.22539599599628324"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2894522495483449" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2894522495483449">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AssetScanDto {</span>
<div><span class="propName ">Data</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Latitude</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Longitude</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Status</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">Note</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Data": "string",
"Latitude": 0,
"Longitude": 0,
"Status": 1,
"Note": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<AssetScanDto>
<Data>string</Data>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<Status>1</Status>
<Note>string</Note>
</AssetScanDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.6788598005597017">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.6788598005597017" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.6031013089463666">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.6031013089463666" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.22161267879397162">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.22161267879397162" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mavailabilityInputDto0.3497631704393076">availabilityInputDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="availabilityInputDto" id="mavailabilityInputDto0.3497631704393076"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7774910364299767" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7774910364299767">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AvailabilityInputDto {</span>
<div><span class="propName ">UnavailableDays</span> (<span class="propType">Array[AvailabilityDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">StartDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">AvailabilityDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonIdNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">StartDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AvailabiltyHoursFullMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Id</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OrganisationId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CustomTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Status</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">CreatedDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">UpdatedDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">HistoryCreated</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">HistoryStart</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">HistoryEnd</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">UserId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Terminate</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"UnavailableDays": [
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"PersonIdNumber": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"StartDate": "2024-11-07T02:04:38.758Z",
"EndDate": "2024-11-07T02:04:38.758Z",
"AvailabiltyHoursFullMonth": "string",
"Id": 0,
"OrganisationId": 0,
"CustomTypeId": 0,
"Status": 0,
"CreatedDate": "2024-11-07T02:04:38.758Z",
"UpdatedDate": "2024-11-07T02:04:38.758Z",
"HistoryCreated": "2024-11-07T02:04:38.758Z",
"HistoryStart": "2024-11-07T02:04:38.758Z",
"HistoryEnd": "2024-11-07T02:04:38.758Z",
"UserId": "string",
"Terminate": true
}
],
"PersonKey": "00000000-0000-0000-0000-000000000000",
"StartDate": "2024-11-07T02:04:38.758Z",
"EndDate": "2024-11-07T02:04:38.758Z"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<AvailabilityInputDto>
<UnavailableDays>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<PersonIdNumber>string</PersonIdNumber>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<AvailabiltyHoursFullMonth>string</AvailabiltyHoursFullMonth>
<Id>1</Id>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Status>0</Status>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<UpdatedDate>1970-01-01T00:00:00.001Z</UpdatedDate>
<HistoryCreated>1970-01-01T00:00:00.001Z</HistoryCreated>
<HistoryStart>1970-01-01T00:00:00.001Z</HistoryStart>
<HistoryEnd>1970-01-01T00:00:00.001Z</HistoryEnd>
<UserId>string</UserId>
<Terminate>true</Terminate>
</UnavailableDays>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</AvailabilityInputDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectorOnlineStatusDto0.21845927101792162">connectorOnlineStatusDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="connectorOnlineStatusDto" id="mconnectorOnlineStatusDto0.21845927101792162"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7175541226673228" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7175541226673228">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConnectorOnlineStatusDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">ConnectorOnlineStatus</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"ConnectorOnlineStatus": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ConnectorOnlineStatusDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<ConnectorOnlineStatus>0</ConnectorOnlineStatus>
</ConnectorOnlineStatusDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectivityStatus0.8648717632878182">connectivityStatus</label></td>
<td>
<input class="parameter required" minlength="1" name="connectivityStatus" placeholder="(required)" id="mconnectivityStatus0.8648717632878182" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mconnectorGuid0.9739080723161953">connectorGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="connectorGuid" placeholder="(required)" id="mconnectorGuid0.9739080723161953" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectors0.2865578710462089">connectors</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="connectors" id="mconnectors0.2865578710462089"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7669867773381664" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7669867773381664">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConnectorMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectors0.6381672000176617">connectors</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="connectors" id="mconnectors0.6381672000176617"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.40410588381953416" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.40410588381953416">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConnectorMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectors0.8905216550238375">connectors</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="connectors" id="mconnectors0.8905216550238375"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.47454631809230263" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.47454631809230263">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConnectorMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectors0.5277899096060528">connectors</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="connectors" id="mconnectors0.5277899096060528"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.11987838882238533" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.11987838882238533">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConnectorMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectors0.021720591767914188">connectors</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="connectors" id="mconnectors0.021720591767914188"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9161289276422011" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9161289276422011">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConnectorMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectors0.947765430944649">connectors</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="connectors" id="mconnectors0.947765430944649"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.02787390383716537" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.02787390383716537">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConnectorMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectors0.019059517243561253">connectors</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="connectors" id="mconnectors0.019059517243561253"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9694518067731999" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9694518067731999">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ConnectorMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No Content</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mOrganisationGuid0.026626644290008494">OrganisationGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="OrganisationGuid" placeholder="(required)" id="mOrganisationGuid0.026626644290008494" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mperipheralMessage0.8725455594671057">peripheralMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="peripheralMessage" id="mperipheralMessage0.8725455594671057"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9716162646933129" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9716162646933129">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PeripheralMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PeripheralId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SerialNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IpAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ModelNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FirmwareVersion</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"PeripheralId": "string",
"Name": "string",
"SerialNumber": "string",
"IpAddress": "string",
"ModelNumber": "string",
"FirmwareVersion": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<PeripheralMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<PeripheralId>string</PeripheralId>
<Name>string</Name>
<SerialNumber>string</SerialNumber>
<IpAddress>string</IpAddress>
<ModelNumber>string</ModelNumber>
<FirmwareVersion>string</FirmwareVersion>
</PeripheralMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="minputDeviceMessage0.018797600386957436">inputDeviceMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="inputDeviceMessage" id="minputDeviceMessage0.018797600386957436"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5436874334253603" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5436874334253603">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">InputDeviceMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InputDeviceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InputDeviceName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InputDoorName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"InputDeviceId": "string",
"InputDeviceName": "string",
"InputDoorName": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<InputDeviceMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<InputDeviceId>string</InputDeviceId>
<InputDeviceName>string</InputDeviceName>
<InputDoorName>string</InputDoorName>
</InputDeviceMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcryptoGraphyDto0.7184875211240778">cryptoGraphyDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="cryptoGraphyDto" id="mcryptoGraphyDto0.7184875211240778"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4820163076176136" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4820163076176136">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CryptoGraphyDto {</span>
<div><span class="propName ">Text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Text": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<CryptoGraphyDto>
<Text>string</Text>
</CryptoGraphyDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcryptoGraphyDto0.2661907518670079">cryptoGraphyDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="cryptoGraphyDto" id="mcryptoGraphyDto0.2661907518670079"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8340790793324389" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8340790793324389">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CryptoGraphyDto {</span>
<div><span class="propName ">Text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Text": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<CryptoGraphyDto>
<Text>string</Text>
</CryptoGraphyDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcustomTypes0.7355159552249415">customTypes</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="customTypes" id="mcustomTypes0.7355159552249415"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6075100684560482" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6075100684560482">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomTypeMessageDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Jobs</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Payrates</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Persons</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"Jobs": true,
"Payrates": true,
"Persons": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<CustomTypeMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<Jobs>true</Jobs>
<Payrates>true</Payrates>
<Persons>true</Persons>
</CustomTypeMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcustomTypes0.40207307528397407">customTypes</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="customTypes" id="mcustomTypes0.40207307528397407"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.049331785552713336" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.049331785552713336">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomTypeMessageDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Jobs</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Payrates</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Persons</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"Jobs": true,
"Payrates": true,
"Persons": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<CustomTypeMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<Jobs>true</Jobs>
<Payrates>true</Payrates>
<Persons>true</Persons>
</CustomTypeMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mfileEntityType0.007704120814698845">fileEntityType</label></td>
<td>
<select class="parameter required " name="fileEntityType" id="mfileEntityType0.007704120814698845">
<option value="1"> 1 </option>
<option value="2"> 2 </option>
<option value="3"> 3 </option>
</select>
</td>
<td class="markdown">
<p><strong></strong></p>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mfileEntityId0.5299681818034596">fileEntityId</label></td>
<td>
<input class="parameter required" minlength="1" name="fileEntityId" placeholder="(required)" id="mfileEntityId0.5299681818034596" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdocumentSecurityStatusLevel0.14563431983398756">documentSecurityStatusLevel</label></td>
<td>
<select class="parameter required " name="documentSecurityStatusLevel" id="mdocumentSecurityStatusLevel0.14563431983398756">
<option value="1"> 1 </option>
<option value="2"> 2 </option>
<option value="3"> 3 </option>
<option value="4"> 4 </option>
<option value="5"> 5 </option>
<option value="6"> 6 </option>
<option value="7"> 7 </option>
<option value="8"> 8 </option>
<option value="9"> 9 </option>
</select>
</td>
<td class="markdown">
<p><strong></strong></p>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mfileEntitySubType0.14541132858424932">fileEntitySubType</label></td>
<td>
<select class="parameter " name="fileEntitySubType" id="mfileEntitySubType0.14541132858424932">
<option selected="" value=""></option>
<option value="1"> 1 </option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mfileEntitySubTypeEntityId0.39199466821648943">fileEntitySubTypeEntityId</label></td>
<td>
<input class="parameter" minlength="0" name="fileEntitySubTypeEntityId" placeholder="" id="mfileEntitySubTypeEntityId0.39199466821648943" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlatitude0.6966415808465118">latitude</label></td>
<td>
<input class="parameter" minlength="0" name="latitude" placeholder="" id="mlatitude0.6966415808465118" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">double</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlongitude0.3173299123114608">longitude</label></td>
<td>
<input class="parameter" minlength="0" name="longitude" placeholder="" id="mlongitude0.3173299123114608" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">double</span>
</td>
</tr>
<tr>
<td class="code"><label for="mnote0.9400559478366721">note</label></td>
<td>
<input class="parameter" minlength="0" name="note" placeholder="" id="mnote0.9400559478366721" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mfileEntityType0.09654343840265911">fileEntityType</label></td>
<td>
<select class="parameter required " name="fileEntityType" id="mfileEntityType0.09654343840265911">
<option value="1"> 1 </option>
<option value="2"> 2 </option>
<option value="3"> 3 </option>
</select>
</td>
<td class="markdown">
<p><strong></strong></p>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mfileReferenceId0.37927398945215796">fileReferenceId</label></td>
<td>
<input class="parameter required" minlength="1" name="fileReferenceId" placeholder="(required)" id="mfileReferenceId0.37927398945215796" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonkey0.6340180650835769">personkey</label></td>
<td>
<input class="parameter required" minlength="1" name="personkey" placeholder="(required)" id="mpersonkey0.6340180650835769" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.8218207542327962">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.8218207542327962" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mleaderboardKey0.8980781683454298">leaderboardKey</label></td>
<td>
<input class="parameter required" minlength="1" name="leaderboardKey" placeholder="(required)" id="mleaderboardKey0.8980781683454298" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdateRangeId0.5600852491792048">dateRangeId</label></td>
<td>
<input class="parameter required" minlength="1" name="dateRangeId" placeholder="(required)" id="mdateRangeId0.5600852491792048" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mpersonKey0.9839242410378102">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.9839242410378102" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectorId0.943550930806959">connectorId</label></td>
<td>
<input class="parameter required" minlength="1" name="connectorId" placeholder="(required)" id="mconnectorId0.943550930806959" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mconnectorId0.777345467086213">connectorId</label></td>
<td>
<input class="parameter required" minlength="1" name="connectorId" placeholder="(required)" id="mconnectorId0.777345467086213" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mgroup0.6632847309749821">group</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="group" id="mgroup0.6632847309749821"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3278281087123145" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3278281087123145">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GroupMessageDto {</span>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">GroupId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"GroupId": "string",
"Name": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<GroupMessageDto>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<GroupId>string</GroupId>
<Name>string</Name>
</GroupMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mgroupIdAttachments0.058305179427516673">groupIdAttachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="groupIdAttachments" id="mgroupIdAttachments0.058305179427516673"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.06510949515665554" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.06510949515665554">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UpdateConnectorGroupIdAttachmentDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">GroupId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">GroupConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"GroupId": "string",
"GroupConnectorId": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<UpdateConnectorGroupIdAttachmentDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<GroupId>string</GroupId>
<GroupConnectorId>string</GroupConnectorId>
</UpdateConnectorGroupIdAttachmentDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.13925418091838182">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.13925418091838182" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.2587787185697765">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.2587787185697765" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendRange0.3952186457568918">endRange</label></td>
<td>
<input class="parameter required" minlength="1" name="endRange" placeholder="(required)" id="mendRange0.3952186457568918" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mjobMessage0.7043117650794333">jobMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="jobMessage" id="mjobMessage0.7043117650794333"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8453567461072671" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8453567461072671">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">JobMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CustomTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Status</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomTypeId": 0,
"Status": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<JobMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<Name>string</Name>
<CustomTypeId>1</CustomTypeId>
<Status>true</Status>
</JobMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muserNameInputDto0.3500426005781485">userNameInputDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="userNameInputDto" id="muserNameInputDto0.3500426005781485"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.890240082210807" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.890240082210807">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SelfServiceUserNameInputDto {</span>
<div><span class="propName ">UserName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">VersionNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"UserName": "string",
"VersionNumber": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SelfServiceUserNameInputDto>
<UserName>string</UserName>
<VersionNumber>string</VersionNumber>
</SelfServiceUserNameInputDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mlogDto0.7760329361127267">logDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="logDto" id="mlogDto0.7760329361127267"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.18205258190738416" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.18205258190738416">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LogDto {</span>
<div><span class="propName ">Message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Message": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<LogDto>
<Message>string</Message>
</LogDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mswipeEvent0.3468036885035213">swipeEvent</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="swipeEvent" id="mswipeEvent0.3468036885035213"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7956844377542953" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7956844377542953">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SwipeEventDto {</span>
<div><span class="propName ">EventDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PeripheralId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IdNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SwipeEventId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SlotId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Direction</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"EventDateTime": "2024-11-07T02:04:38.837Z",
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"PeripheralId": "string",
"IdNumber": "string",
"SwipeEventId": "string",
"SlotId": 0,
"Direction": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SwipeEventDto>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<PeripheralId>string</PeripheralId>
<IdNumber>string</IdNumber>
<SwipeEventId>string</SwipeEventId>
<SlotId>1</SlotId>
<Direction>1</Direction>
</SwipeEventDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mswipe0.5447703729144029">swipe</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="swipe" id="mswipe0.5447703729144029"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7113938806934448" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7113938806934448">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MergeMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EventDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Direction</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">GroupId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">JobKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Latitude</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Longitude</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PeripheralId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PeripheralKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EventId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CredentialId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">UserId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.842Z",
"Direction": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"JobKey": "00000000-0000-0000-0000-000000000000",
"Latitude": 0,
"Longitude": 0,
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonId": "string",
"PeripheralId": "string",
"PeripheralKey": "string",
"EventId": "string",
"CredentialId": "string",
"UserId": "00000000-0000-0000-0000-000000000000"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<MergeMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<Direction>1</Direction>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonId>string</PersonId>
<PeripheralId>string</PeripheralId>
<PeripheralKey>string</PeripheralKey>
<EventId>string</EventId>
<CredentialId>string</CredentialId>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
</MergeMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="minputEvent0.3403343699403354">inputEvent</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="inputEvent" id="minputEvent0.3403343699403354"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7218042093321246" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7218042093321246">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">InputEventMessageDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorInputId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TriggerDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"ConnectorInputId": "string",
"TriggerDateTime": "2024-11-07T02:04:38.845Z"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<InputEventMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<ConnectorInputId>string</ConnectorInputId>
<TriggerDateTime>1970-01-01T00:00:00.001Z</TriggerDateTime>
</InputEventMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mswipeExtendedEvent0.2097161240241585">swipeExtendedEvent</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="swipeExtendedEvent" id="mswipeExtendedEvent0.2097161240241585"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1678904039488649" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1678904039488649">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SwipeExtendedEventDto {</span>
<div><span class="propName ">EventDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">GroupId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">JobKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Direction</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">Longitude</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Latitude</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"EventDateTime": "2024-11-07T02:04:38.847Z",
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"GroupId": "00000000-0000-0000-0000-000000000000",
"JobKey": "00000000-0000-0000-0000-000000000000",
"Direction": 1,
"Longitude": 0,
"Latitude": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SwipeExtendedEventDto>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<Direction>1</Direction>
<Longitude>1.1</Longitude>
<Latitude>1.1</Latitude>
</SwipeExtendedEventDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mattachAndRoundSwipeDto0.08236647896484106">attachAndRoundSwipeDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="attachAndRoundSwipeDto" id="mattachAndRoundSwipeDto0.08236647896484106"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3583249228002301" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3583249228002301">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AttachAndRoundSwipeDto {</span>
<div><span class="propName ">ProcessSwipeMergeRunIntervalHoursRange</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"ProcessSwipeMergeRunIntervalHoursRange": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<AttachAndRoundSwipeDto>
<ProcessSwipeMergeRunIntervalHoursRange>1</ProcessSwipeMergeRunIntervalHoursRange>
</AttachAndRoundSwipeDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mserverDateTime0.9765723876877617">serverDateTime</label></td>
<td>
<input class="parameter required" minlength="1" name="serverDateTime" placeholder="(required)" id="mserverDateTime0.9765723876877617" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mevacuationKey0.011270460784060354">evacuationKey</label></td>
<td>
<input class="parameter required" minlength="1" name="evacuationKey" placeholder="(required)" id="mevacuationKey0.011270460784060354" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.6349831698404844">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.6349831698404844"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.15100285120069867" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.15100285120069867">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ManageEvacuationDto {</span>
<div><span class="propName ">SitesJson</span> (<span class="propType">Array[EvacuationSitesPostDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ZonesJson</span> (<span class="propType">Array[EvacuationZonesPostDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SendNotification</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">EvacuationSitesPostDto {</span>
<div><span class="propName ">SiteKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EventDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Mode</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">EvacuationZonesPostDto {</span>
<div><span class="propName ">SiteKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ZoneKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EventDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Status</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"SitesJson": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.872Z",
"Mode": 0
}
],
"ZonesJson": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"ZoneKey": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.872Z",
"Status": 0
}
],
"SendNotification": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ManageEvacuationDto>
<SitesJson>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<Mode>1</Mode>
</SitesJson>
<ZonesJson>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<ZoneKey>00000000-0000-0000-0000-000000000000</ZoneKey>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<Status>1</Status>
</ZonesJson>
<SendNotification>true</SendNotification>
</ManageEvacuationDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mserverDateTime0.11742802549062081">serverDateTime</label></td>
<td>
<input class="parameter required" minlength="1" name="serverDateTime" placeholder="(required)" id="mserverDateTime0.11742802549062081" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mserverDateTime0.7318759807946462">serverDateTime</label></td>
<td>
<input class="parameter required" minlength="1" name="serverDateTime" placeholder="(required)" id="mserverDateTime0.7318759807946462" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.3627122991427687">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.3627122991427687"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.10192917325181439" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.10192917325181439">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserLocationDto {</span>
<div><span class="propName ">Latitude</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Longitude</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateTimeOffset</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ServerDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Latitude": 0,
"Longitude": 0,
"DateTimeOffset": "2024-11-07T02:04:38.877Z",
"ServerDateTime": "2024-11-07T02:04:38.877Z"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<UserLocationDto>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<DateTimeOffset>1970-01-01T00:00:00.001Z</DateTimeOffset>
<ServerDateTime>1970-01-01T00:00:00.001Z</ServerDateTime>
</UserLocationDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.23799830123898458">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.23799830123898458"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5576565121066186" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5576565121066186">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MusterdPostMakePersonSafeDto {</span>
<div><span class="propName ">People</span> (<span class="propType">Array[MakePersonSafeDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ServerDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">MakePersonSafeDto {</span>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MusterPointKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EventDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">MakeSafeOrUndoSafe</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"People": [
{
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonToken": "string",
"MusterPointKey": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.879Z",
"MakeSafeOrUndoSafe": 0
}
],
"ServerDateTime": "2024-11-07T02:04:38.879Z"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<MusterdPostMakePersonSafeDto>
<People>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonToken>string</PersonToken>
<MusterPointKey>00000000-0000-0000-0000-000000000000</MusterPointKey>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<MakeSafeOrUndoSafe>0</MakeSafeOrUndoSafe>
</People>
<ServerDateTime>1970-01-01T00:00:00.001Z</ServerDateTime>
</MusterdPostMakePersonSafeDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msendPushNotificationDto0.9356187481549276">sendPushNotificationDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="sendPushNotificationDto" id="msendPushNotificationDto0.9356187481549276"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9495709648936019" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9495709648936019">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SendPushNotificationDto {</span>
<div><span class="propWrap"><span class="propName ">MobileAppType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">UserIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKeys</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NotificationTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NotificationText</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">RotaOneSelfServiceAppRedirect</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2', '3', '4', '5',
'6', '7', '8', '9']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2, 3, 4, 5, 6, 7, 8, 9</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">OrganisationId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SenderUserId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SystemGenerated</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"MobileAppType": 0,
"UserIds": [
"string"
],
"PersonKeys": [
"00000000-0000-0000-0000-000000000000"
],
"NotificationTitle": "string",
"NotificationText": "string",
"RotaOneSelfServiceAppRedirect": 0,
"OrganisationId": 0,
"SenderUserId": "string",
"SystemGenerated": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SendPushNotificationDto>
<MobileAppType>0</MobileAppType>
<UserIds>string</UserIds>
<PersonKeys>00000000-0000-0000-0000-000000000000</PersonKeys>
<NotificationTitle>string</NotificationTitle>
<NotificationText>string</NotificationText>
<RotaOneSelfServiceAppRedirect>0</RotaOneSelfServiceAppRedirect>
<OrganisationId>1</OrganisationId>
<SenderUserId>string</SenderUserId>
<SystemGenerated>true</SystemGenerated>
</SendPushNotificationDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mapplyPersonTokenRequestDto0.015608551312449537">applyPersonTokenRequestDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="applyPersonTokenRequestDto" id="mapplyPersonTokenRequestDto0.015608551312449537"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.22669634859229548" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.22669634859229548">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApplyPersonTokenRequestDto {</span>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Token</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"PersonKey": "00000000-0000-0000-0000-000000000000",
"Token": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ApplyPersonTokenRequestDto>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<Token>string</Token>
</ApplyPersonTokenRequestDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.1385220589882452">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.1385220589882452"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3807394634357819" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3807394634357819">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PersonRegisterInputDto {</span>
<div><span class="propName ">SecureKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeStamp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DeviceToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DeviceTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">BundleId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DeviceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"SecureKey": "string",
"TimeStamp": "2024-11-07T02:04:38.885Z",
"DeviceToken": "string",
"DeviceTypeId": 1,
"BundleId": "string",
"DeviceId": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<PersonRegisterInputDto>
<SecureKey>string</SecureKey>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<DeviceToken>string</DeviceToken>
<DeviceTypeId>1</DeviceTypeId>
<BundleId>string</BundleId>
<DeviceId>string</DeviceId>
</PersonRegisterInputDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.02390360884967868">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.02390360884967868"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.33297898871393294" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.33297898871393294">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PersonRegisterInputDto {</span>
<div><span class="propName ">SecureKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeStamp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DeviceToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DeviceTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">BundleId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DeviceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"SecureKey": "string",
"TimeStamp": "2024-11-07T02:04:38.887Z",
"DeviceToken": "string",
"DeviceTypeId": 1,
"BundleId": "string",
"DeviceId": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<PersonRegisterInputDto>
<SecureKey>string</SecureKey>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<DeviceToken>string</DeviceToken>
<DeviceTypeId>1</DeviceTypeId>
<BundleId>string</BundleId>
<DeviceId>string</DeviceId>
</PersonRegisterInputDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="msendSmsRequestDto0.09841065459813336">sendSmsRequestDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="sendSmsRequestDto" id="msendSmsRequestDto0.09841065459813336"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9864539868428677" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9864539868428677">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SendSmsRequestDto {</span>
<div><span class="propName ">EvacuationKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"EvacuationKey": "00000000-0000-0000-0000-000000000000"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SendSmsRequestDto>
<EvacuationKey>00000000-0000-0000-0000-000000000000</EvacuationKey>
</SendSmsRequestDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmusterdSmsDetailDto0.8766964954373597">musterdSmsDetailDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="musterdSmsDetailDto" id="mmusterdSmsDetailDto0.8766964954373597"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3629092706146555" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3629092706146555">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MusterdSmsDetailDto {</span>
<div><span class="propName ">From</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Body</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">To</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Key</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"From": "string",
"Body": "string",
"To": "string",
"Key": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<MusterdSmsDetailDto>
<From>string</From>
<Body>string</Body>
<To>string</To>
<Key>string</Key>
</MusterdSmsDetailDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muserNameInputDto0.43009006494871316">userNameInputDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="userNameInputDto" id="muserNameInputDto0.43009006494871316"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7123333360540982" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7123333360540982">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MusterdUserNameInputDto {</span>
<div><span class="propName ">UserName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"UserName": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<MusterdUserNameInputDto>
<UserName>string</UserName>
</MusterdUserNameInputDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.39094774718443515">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.39094774718443515"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4082386161104483" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4082386161104483">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MusterdPostImSafeDto {</span>
<div><span class="propName ">Person</span> (<span class="propType">ImSafeDto</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ServerDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeStamp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">ImSafeDto {</span>
<div><span class="propName ">SecureKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MusterPointKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EventDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">MakeSafeOrUndoSafe</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Person": {
"SecureKey": "string",
"PersonToken": "string",
"MusterPointKey": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.900Z",
"MakeSafeOrUndoSafe": 0
},
"ServerDateTime": "2024-11-07T02:04:38.900Z",
"TimeStamp": "2024-11-07T02:04:38.900Z"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<MusterdPostImSafeDto>
<Person>
<SecureKey>string</SecureKey>
<PersonToken>string</PersonToken>
<MusterPointKey>00000000-0000-0000-0000-000000000000</MusterPointKey>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<MakeSafeOrUndoSafe>0</MakeSafeOrUndoSafe>
</Person>
<ServerDateTime>1970-01-01T00:00:00.001Z</ServerDateTime>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
</MusterdPostImSafeDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.21118466805789526">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.21118466805789526"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2444306405480554" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2444306405480554">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RegisterDto {</span>
<div><span class="propName ">DeviceToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DeviceTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">BundleId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DeviceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"DeviceToken": "string",
"DeviceTypeId": 1,
"BundleId": "string",
"DeviceId": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<RegisterDto>
<DeviceToken>string</DeviceToken>
<DeviceTypeId>1</DeviceTypeId>
<BundleId>string</BundleId>
<DeviceId>string</DeviceId>
</RegisterDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.7468898586272283">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.7468898586272283"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9833949783038252" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9833949783038252">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RegisterDto {</span>
<div><span class="propName ">DeviceToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">DeviceTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">BundleId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DeviceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"DeviceToken": "string",
"DeviceTypeId": 1,
"BundleId": "string",
"DeviceId": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<RegisterDto>
<DeviceToken>string</DeviceToken>
<DeviceTypeId>1</DeviceTypeId>
<BundleId>string</BundleId>
<DeviceId>string</DeviceId>
</RegisterDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdto0.47571826461873146">dto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="dto" id="mdto0.47571826461873146"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8463788224636857" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8463788224636857">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SendPushNotificationsToAppDto {</span>
<div><span class="propName ">DeviceTokens</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NotificationTitle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NotificationText</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">MobileAppType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">NotificationData</span> (<span class="propType">inline_model</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">inline_model {</span><span
class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"DeviceTokens": [
"string"
],
"NotificationTitle": "string",
"NotificationText": "string",
"MobileAppType": 0,
"NotificationData": {}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SendPushNotificationsToAppDto>
<DeviceTokens>string</DeviceTokens>
<NotificationTitle>string</NotificationTitle>
<NotificationText>string</NotificationText>
<MobileAppType>0</MobileAppType>
<NotificationData>
<!-- additional elements allowed -->
</NotificationData>
</SendPushNotificationsToAppDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpayRateMessage0.8382973617170857">payRateMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="payRateMessage" id="mpayRateMessage0.8382973617170857"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6661274435885014" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6661274435885014">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PayRateMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayRateId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">RateType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2', '3', '4', '5', '6', '7']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2, 3, 4, 5, 6, 7</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">RateTypeValue</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Status</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CustomTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"PayRateId": "string",
"Name": "string",
"RateType": 1,
"RateTypeValue": 0,
"Status": true,
"CustomTypeId": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<PayRateMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<PayRateId>string</PayRateId>
<Name>string</Name>
<RateType>1</RateType>
<RateTypeValue>1</RateTypeValue>
<Status>true</Status>
<CustomTypeId>1</CustomTypeId>
</PayRateMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mOrganisationGuid0.1811623849925137">OrganisationGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="OrganisationGuid" placeholder="(required)" id="mOrganisationGuid0.1811623849925137" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mConnectorGuid0.8334978410430418">ConnectorGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="ConnectorGuid" placeholder="(required)" id="mConnectorGuid0.8334978410430418" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mPayrateIds0.49523177336652857">PayrateIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="PayrateIds" id="mPayrateIds0.49523177336652857"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9743593518428575" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9743593518428575">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">Array[integer]</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpayrateIdAttachments0.9345240328833766">payrateIdAttachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="payrateIdAttachments" id="mpayrateIdAttachments0.9345240328833766"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7673699829510949" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7673699829510949">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UpdateConnectorPayrateIdAttachmentDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayrateId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayrateConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"PayrateId": "string",
"PayrateConnectorId": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<UpdateConnectorPayrateIdAttachmentDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<PayrateId>string</PayrateId>
<PayrateConnectorId>string</PayrateConnectorId>
</UpdateConnectorPayrateIdAttachmentDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mConnectorId0.5460205585144182">ConnectorId</label></td>
<td>
<input class="parameter required" minlength="1" name="ConnectorId" placeholder="(required)" id="mConnectorId0.5460205585144182" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mConnectorId0.49842365315141435">ConnectorId</label></td>
<td>
<input class="parameter required" minlength="1" name="ConnectorId" placeholder="(required)" id="mConnectorId0.49842365315141435" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mCommandId0.2713144050245393">CommandId</label></td>
<td>
<input class="parameter required" minlength="1" name="CommandId" placeholder="(required)" id="mCommandId0.2713144050245393" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpayrollMessage0.7821938873407297">payrollMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="payrollMessage" id="mpayrollMessage0.7821938873407297"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8577113472803295" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8577113472803295">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PayrollMessageDto {</span>
<div><span class="propName ">PersonKeys</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CommandId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"PersonKeys": [
"00000000-0000-0000-0000-000000000000"
],
"CommandId": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<PayrollMessageDto>
<PersonKeys>00000000-0000-0000-0000-000000000000</PersonKeys>
<CommandId>1</CommandId>
</PayrollMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpayrollMessage0.2844211686203941">payrollMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="payrollMessage" id="mpayrollMessage0.2844211686203941"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9325214055914564" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9325214055914564">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PayrollBatchMessageDto {</span>
<div><span class="propName ">PersonKeys</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CommandId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"PersonKeys": [
"00000000-0000-0000-0000-000000000000"
],
"CommandId": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<PayrollBatchMessageDto>
<PersonKeys>00000000-0000-0000-0000-000000000000</PersonKeys>
<CommandId>1</CommandId>
</PayrollBatchMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcommandId0.6884803301596745">commandId</label></td>
<td>
<input class="parameter required" minlength="1" name="commandId" placeholder="(required)" id="mcommandId0.6884803301596745" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcommandId0.5165350987064461">commandId</label></td>
<td>
<input class="parameter required" minlength="1" name="commandId" placeholder="(required)" id="mcommandId0.5165350987064461" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="morganisationGuid0.8064633257857046">organisationGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="organisationGuid" placeholder="(required)" id="morganisationGuid0.8064633257857046" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mprocessPayrulesDto0.6227847642604964">processPayrulesDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="processPayrulesDto" id="mprocessPayrulesDto0.6227847642604964"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8097097979620167" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8097097979620167">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcessPayRulesDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ProcessPayrulesRunIntervalHoursRange</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ProcessSwipeMergeRunIntervalHoursRange</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ProcessPayrulesRunIntervalHoursRange": 0,
"ProcessSwipeMergeRunIntervalHoursRange": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ProcessPayRulesDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ProcessPayrulesRunIntervalHoursRange>1</ProcessPayrulesRunIntervalHoursRange>
<ProcessSwipeMergeRunIntervalHoursRange>1</ProcessSwipeMergeRunIntervalHoursRange>
</ProcessPayRulesDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonMessage0.8298617875752397">personMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="personMessage" id="mpersonMessage0.8298617875752397"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.48328263224488954" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.48328263224488954">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PersonMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IdNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Title</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">FirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MiddleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">LastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">CustomTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Gender</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2', '3']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2, 3</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">DateOfBirth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">StartDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ProbationEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">NINumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonalEmail</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">WorkEmail</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayRates</span> (<span class="propType">Array[PersonPayRateMessageDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Groups</span> (<span class="propType">Array[PersonGroupDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Jobs</span> (<span class="propType">Array[PersonJobDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Qualifications</span> (<span class="propType">Array[PersonQualificationDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Tokens</span> (<span class="propType">Array[PersonTokenDto]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Contact</span> (<span class="propType">Array[PersonContactMessageDto]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">PersonPayRateMessageDto {</span>
<div><span class="propName ">PayrateId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayRateName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayRateValue</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PayRatePermValue</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">StartDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PersonGroupDto {</span>
<div><span class="propName ">GroupId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">StartDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PersonJobDto {</span>
<div><span class="propName ">JobName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PersonQualificationDto {</span>
<div><span class="propName ">QualificationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">QualificationName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PersonTokenDto {</span>
<div><span class="propName ">Token</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PersonContactMessageDto {</span>
<div><span class="propName ">Telephone1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Telephone2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Telephone3</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AddressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AddressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AddressLine3</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AddressLine4</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Town</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">County</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Postcode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"IdNumber": "string",
"Title": 0,
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"CustomTypeId": 0,
"Gender": 1,
"DateOfBirth": "2024-11-07T02:04:38.923Z",
"StartDate": "2024-11-07T02:04:38.923Z",
"EndDate": "2024-11-07T02:04:38.923Z",
"ProbationEndDate": "2024-11-07T02:04:38.923Z",
"NINumber": "string",
"PersonalEmail": "string",
"WorkEmail": "string",
"PayRates": [
{
"PayrateId": "string",
"PayRateName": "string",
"PayRateValue": 0,
"PayRatePermValue": 0,
"StartDate": "2024-11-07T02:04:38.923Z",
"EndDate": "2024-11-07T02:04:38.923Z"
}
],
"Groups": [
{
"GroupId": "string",
"Name": "string",
"StartDate": "2024-11-07T02:04:38.923Z",
"EndDate": "2024-11-07T02:04:38.923Z"
}
],
"Jobs": [
{
"JobName": "string"
}
],
"Qualifications": [
{
"QualificationId": "string",
"QualificationName": "string"
}
],
"Tokens": [
{
"Token": "string"
}
],
"Contact": [
{
"Telephone1": "string",
"Telephone2": "string",
"Telephone3": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"AddressLine4": "string",
"Town": "string",
"County": "string",
"Postcode": "string",
"Country": "string"
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<PersonMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<IdNumber>string</IdNumber>
<Title>1</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<LastName>string</LastName>
<CustomTypeId>1</CustomTypeId>
<Gender>1</Gender>
<DateOfBirth>1970-01-01T00:00:00.001Z</DateOfBirth>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<ProbationEndDate>1970-01-01T00:00:00.001Z</ProbationEndDate>
<NINumber>string</NINumber>
<PersonalEmail>string</PersonalEmail>
<WorkEmail>string</WorkEmail>
<PayRates>
<PayrateId>string</PayrateId>
<PayRateName>string</PayRateName>
<PayRateValue>1.1</PayRateValue>
<PayRatePermValue>1.1</PayRatePermValue>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</PayRates>
<Groups>
<GroupId>string</GroupId>
<Name>string</Name>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</Groups>
<Jobs>
<JobName>string</JobName>
</Jobs>
<Qualifications>
<QualificationId>string</QualificationId>
<QualificationName>string</QualificationName>
</Qualifications>
<Tokens>
<Token>string</Token>
</Tokens>
<Contact>
<Telephone1>string</Telephone1>
<Telephone2>string</Telephone2>
<Telephone3>string</Telephone3>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<AddressLine3>string</AddressLine3>
<AddressLine4>string</AddressLine4>
<Town>string</Town>
<County>string</County>
<Postcode>string</Postcode>
<Country>string</Country>
</Contact>
</PersonMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="morganisationGuid0.21824372415292226">organisationGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="organisationGuid" placeholder="(required)" id="morganisationGuid0.21824372415292226" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mconnectorGuid0.8290811782425713">connectorGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="connectorGuid" placeholder="(required)" id="mconnectorGuid0.8290811782425713" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mgetExpiredGroupAttachments0.8095532076482226">getExpiredGroupAttachments</label></td>
<td>
<select class="parameter " name="getExpiredGroupAttachments" id="mgetExpiredGroupAttachments0.8095532076482226">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonIds0.5341599179109744">personIds</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="personIds" id="mpersonIds0.5341599179109744"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3380170188948528" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3380170188948528">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">Array[integer]</span></td>
</tr>
<tr>
<td class="code"><label for="msetUpdatedTime0.021667151616108216">setUpdatedTime</label></td>
<td>
<select class="parameter " name="setUpdatedTime" id="msetUpdatedTime0.021667151616108216">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonIdAttachments0.09995286215959553">personIdAttachments</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="personIdAttachments" id="mpersonIdAttachments0.09995286215959553"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9226764050627547" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9226764050627547">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UpdateConnectorPersonIdAttachmentDto {</span>
<div><span class="propName ">PersonId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"PersonId": "string",
"PersonConnectorId": "string",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"OrganisationId": "00000000-0000-0000-0000-000000000000"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<UpdateConnectorPersonIdAttachmentDto>
<PersonId>string</PersonId>
<PersonConnectorId>string</PersonConnectorId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
</UpdateConnectorPersonIdAttachmentDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonGroupAttachment0.19833881800428999">personGroupAttachment</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="personGroupAttachment" id="mpersonGroupAttachment0.19833881800428999"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.900170155875339" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.900170155875339">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RemovePersonGroupAttachmentDto {</span>
<div><span class="propName ">PersonId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">GroupKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"PersonId": 0,
"GroupKey": "00000000-0000-0000-0000-000000000000"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<RemovePersonGroupAttachmentDto>
<PersonId>1</PersonId>
<GroupKey>00000000-0000-0000-0000-000000000000</GroupKey>
</RemovePersonGroupAttachmentDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mqualificationMessage0.5042406391787142">qualificationMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="qualificationMessage" id="mqualificationMessage0.5042406391787142"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8086012779874179" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8086012779874179">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">QualificationMessageDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">QualificationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">QualificationName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">QualificationStatus</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"QualificationId": "string",
"QualificationName": "string",
"QualificationStatus": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<QualificationMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<QualificationId>string</QualificationId>
<QualificationName>string</QualificationName>
<QualificationStatus>true</QualificationStatus>
</QualificationMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="muserNameInputDto0.03444598224363182">userNameInputDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="userNameInputDto" id="muserNameInputDto0.03444598224363182"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5881758397611652" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5881758397611652">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SelfServiceUserNameInputDto {</span>
<div><span class="propName ">UserName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">VersionNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"UserName": "string",
"VersionNumber": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SelfServiceUserNameInputDto>
<UserName>string</UserName>
<VersionNumber>string</VersionNumber>
</SelfServiceUserNameInputDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="morganisationId0.8032192851871274">organisationId</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="organisationId" id="morganisationId0.8032192851871274"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5315948306644307" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5315948306644307">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="morganisationGuid0.783823537170032">organisationGuid</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="organisationGuid" id="morganisationGuid0.783823537170032"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3005237132399332" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3005237132399332">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.1796527950446143">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.1796527950446143" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.7685060394570342">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.7685060394570342" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.1542184871305754">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.1542184871305754" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mid0.5620589151258133">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5620589151258133" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.7830398644561927">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.7830398644561927" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mdate0.840282439563729">date</label></td>
<td>
<input class="parameter required" minlength="1" name="date" placeholder="(required)" id="mdate0.840282439563729" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.2526228170446754">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.2526228170446754" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.3230896635114642">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.3230896635114642" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.9614172898201667">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.9614172898201667" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.8457190586728831">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.8457190586728831" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.1489550641885482">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.1489550641885482" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.12509533664865113">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.12509533664865113" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.31116626418134086">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.31116626418134086" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.3614943489764906">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.3614943489764906" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.99895010537172">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.99895010537172" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.6468521213261145">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.6468521213261145" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.8641861459065756">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.8641861459065756" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.6017480677713756">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.6017480677713756" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.5715343834133093">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.5715343834133093" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.09613864802573913">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.09613864802573913" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.39461642103400796">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.39461642103400796" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.28857144151484926">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.28857144151484926" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.9537801672357826">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.9537801672357826" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.5081346322498896">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.5081346322498896" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="misAliveMessage0.3328797778517467">isAliveMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="isAliveMessage" id="misAliveMessage0.3328797778517467"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7204088872857328" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7204088872857328">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ClientAliveDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorIds</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MachineName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AwakeTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">VersionNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
],
"MachineName": "string",
"AwakeTime": "2024-11-07T02:04:39.020Z",
"VersionNumber": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ClientAliveDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
<MachineName>string</MachineName>
<AwakeTime>1970-01-01T00:00:00.001Z</AwakeTime>
<VersionNumber>string</VersionNumber>
</ClientAliveDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmessage0.6818468816625685">message</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="message" id="mmessage0.6818468816625685"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1857183353918921" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1857183353918921">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RotaOneConnectEventLogMessageDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeStamp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ClientVersion</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ClientName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MethodName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MessageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"TimeStamp": "2024-11-07T02:04:39.022Z",
"Message": "string",
"ClientVersion": "string",
"ClientName": "string",
"MethodName": "string",
"MessageType": "string",
"AllData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<RotaOneConnectEventLogMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<Message>string</Message>
<ClientVersion>string</ClientVersion>
<ClientName>string</ClientName>
<MethodName>string</MethodName>
<MessageType>string</MessageType>
<AllData>string</AllData>
</RotaOneConnectEventLogMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mname0.8688730685544002">name</label></td>
<td>
<input class="parameter required" minlength="1" name="name" placeholder="(required)" id="mname0.8688730685544002" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mInstanceGuid0.04423960994894682">InstanceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="InstanceGuid" placeholder="(required)" id="mInstanceGuid0.04423960994894682" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mOrganisationGuid0.8480522634108838">OrganisationGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="OrganisationGuid" placeholder="(required)" id="mOrganisationGuid0.8480522634108838" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmessage0.4259215373502432">message</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="message" id="mmessage0.4259215373502432"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7701607200715972" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7701607200715972">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CommandTypeDto {</span>
<div><span class="propName ">ConnectorGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">CommandType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2', '3', '4', '5']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2, 3, 4, 5</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"CommandType": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<CommandTypeDto>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<CommandType>0</CommandType>
</CommandTypeDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcommandId0.9296155001494493">commandId</label></td>
<td>
<input class="parameter required" minlength="1" name="commandId" placeholder="(required)" id="mcommandId0.9296155001494493" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbackupMessage0.8844978366498912">backupMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="backupMessage" id="mbackupMessage0.8844978366498912"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.31865929350226563" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.31865929350226563">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RotaOneConnectBackupMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">BackupFile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MachineName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"BackupFile": "string",
"MachineName": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<RotaOneConnectBackupMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<BackupFile>string</BackupFile>
<MachineName>string</MachineName>
</RotaOneConnectBackupMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mOrganisationId0.41120061681127185">OrganisationId</label></td>
<td>
<input class="parameter required" minlength="1" name="OrganisationId" placeholder="(required)" id="mOrganisationId0.41120061681127185" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mOrganisationId0.42028792346449606">OrganisationId</label></td>
<td>
<input class="parameter required" minlength="1" name="OrganisationId" placeholder="(required)" id="mOrganisationId0.42028792346449606" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mId0.6540359036058085">Id</label></td>
<td>
<input class="parameter required" minlength="1" name="Id" placeholder="(required)" id="mId0.6540359036058085" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mOrganisationId0.0567769746178961">OrganisationId</label></td>
<td>
<input class="parameter required" minlength="1" name="OrganisationId" placeholder="(required)" id="mOrganisationId0.0567769746178961" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mId0.06209734546094703">Id</label></td>
<td>
<input class="parameter required" minlength="1" name="Id" placeholder="(required)" id="mId0.06209734546094703" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mOrganisationId0.04619326702966142">OrganisationId</label></td>
<td>
<input class="parameter required" minlength="1" name="OrganisationId" placeholder="(required)" id="mOrganisationId0.04619326702966142" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="merrorMessage0.8889102549261216">errorMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="errorMessage" id="merrorMessage0.8889102549261216"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.30940719383772497" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.30940719383772497">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RotaOneConnectErrorLogMessageDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeStamp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ErrorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ClientName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">InnerException</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ClientVersion</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MethodName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ExceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"TimeStamp": "2024-11-07T02:04:39.032Z",
"ErrorMessage": "string",
"ClientName": "string",
"InnerException": "string",
"ClientVersion": "string",
"MethodName": "string",
"ExceptionType": "string",
"AllData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<RotaOneConnectErrorLogMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<ErrorMessage>string</ErrorMessage>
<ClientName>string</ClientName>
<InnerException>string</InnerException>
<ClientVersion>string</ClientVersion>
<MethodName>string</MethodName>
<ExceptionType>string</ExceptionType>
<AllData>string</AllData>
</RotaOneConnectErrorLogMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="meventMessage0.7787726926569565">eventMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="eventMessage" id="meventMessage0.7787726926569565"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2214185751049047" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2214185751049047">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RotaOneConnectEventLogMessageDto {</span>
<div><span class="propName ">OrganisationGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeStamp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ClientVersion</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ClientName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MethodName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">MessageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">AllData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"TimeStamp": "2024-11-07T02:04:39.034Z",
"Message": "string",
"ClientVersion": "string",
"ClientName": "string",
"MethodName": "string",
"MessageType": "string",
"AllData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<RotaOneConnectEventLogMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<Message>string</Message>
<ClientVersion>string</ClientVersion>
<ClientName>string</ClientName>
<MethodName>string</MethodName>
<MessageType>string</MessageType>
<AllData>string</AllData>
</RotaOneConnectEventLogMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselfServiceSettingsDto0.7848488520562784">selfServiceSettingsDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="selfServiceSettingsDto" id="mselfServiceSettingsDto0.7848488520562784"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.940115331661918" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.940115331661918">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SelfServiceSettingsDto {</span>
<div><span class="propName ">TimeOffRequestEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeOffRequestMobileApp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">UnallocatedSlotRequestEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">UnallocatedSlotRequestMobileApp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RotaNotification</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RotaUpdatesEmail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RotaUpdatesMobileApp</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"TimeOffRequestEmail": true,
"TimeOffRequestMobileApp": true,
"UnallocatedSlotRequestEmail": true,
"UnallocatedSlotRequestMobileApp": true,
"RotaNotification": true,
"RotaUpdatesEmail": true,
"RotaUpdatesMobileApp": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SelfServiceSettingsDto>
<TimeOffRequestEmail>true</TimeOffRequestEmail>
<TimeOffRequestMobileApp>true</TimeOffRequestMobileApp>
<UnallocatedSlotRequestEmail>true</UnallocatedSlotRequestEmail>
<UnallocatedSlotRequestMobileApp>true</UnallocatedSlotRequestMobileApp>
<RotaNotification>true</RotaNotification>
<RotaUpdatesEmail>true</RotaUpdatesEmail>
<RotaUpdatesMobileApp>true</RotaUpdatesMobileApp>
</SelfServiceSettingsDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="morganisationId0.2976936681859499">organisationId</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="organisationId" id="morganisationId0.2976936681859499"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8345919795896437" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8345919795896437">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mshiftMessage0.7755955044492153">shiftMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="shiftMessage" id="mshiftMessage0.7755955044492153"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9368561046254584" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9368561046254584">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ShiftMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ShiftId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Status</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">HistoryStartDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">HistoryEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">StartTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">EndTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"ShiftId": "string",
"Name": "string",
"Status": true,
"HistoryStartDate": "2024-11-07T02:04:39.039Z",
"HistoryEndDate": "2024-11-07T02:04:39.039Z",
"StartTime": "string",
"EndTime": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ShiftMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<ShiftId>string</ShiftId>
<Name>string</Name>
<Status>true</Status>
<HistoryStartDate>1970-01-01T00:00:00.001Z</HistoryStartDate>
<HistoryEndDate>1970-01-01T00:00:00.001Z</HistoryEndDate>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
</ShiftMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mofferDto0.075443470661404">offerDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="offerDto" id="mofferDto0.075443470661404"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.0121734586418909" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.0121734586418909">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SlotOfferDto {</span>
<div><span class="propName ">SlotOfferId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SlotId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OfferedByPersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OfferedDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OfferedToPersonKeys</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">SlotRequestType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">RequestedSlotId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"SlotOfferId": 0,
"SlotId": 0,
"OfferedByPersonKey": "00000000-0000-0000-0000-000000000000",
"OfferedDate": "2024-11-07T02:04:39.041Z",
"OfferedToPersonKeys": [
"00000000-0000-0000-0000-000000000000"
],
"SlotRequestType": 0,
"RequestedSlotId": 0,
"Message": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SlotOfferDto>
<SlotOfferId>1</SlotOfferId>
<SlotId>1</SlotId>
<OfferedByPersonKey>00000000-0000-0000-0000-000000000000</OfferedByPersonKey>
<OfferedDate>1970-01-01T00:00:00.001Z</OfferedDate>
<OfferedToPersonKeys>00000000-0000-0000-0000-000000000000</OfferedToPersonKeys>
<SlotRequestType>0</SlotRequestType>
<RequestedSlotId>1</RequestedSlotId>
<Message>string</Message>
</SlotOfferDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mslotId0.19251943201124">slotId</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="slotId" id="mslotId0.19251943201124"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17202414723314208" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17202414723314208">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mslotRequestDto0.7511305445605345">slotRequestDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="slotRequestDto" id="mslotRequestDto0.7511305445605345"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4699735518890753" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4699735518890753">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SlotSwapAcceptOfferSelfServiceDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SlotOfferId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RequestedSlotId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": 0,
"SlotOfferId": 0,
"PersonKey": "00000000-0000-0000-0000-000000000000",
"RequestedSlotId": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SlotSwapAcceptOfferSelfServiceDto>
<OrganisationId>1</OrganisationId>
<SlotOfferId>1</SlotOfferId>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<RequestedSlotId>1</RequestedSlotId>
</SlotSwapAcceptOfferSelfServiceDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mslotSwapRequestId0.7742198782199434">slotSwapRequestId</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="slotSwapRequestId" id="mslotSwapRequestId0.7742198782199434"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.40785431877570577" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.40785431877570577">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.5619127881453303">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.5619127881453303" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.31276964042286326">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.31276964042286326" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.9880806850806858">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.9880806850806858" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.15521558205249852">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.15521558205249852" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.8506483296916802">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.8506483296916802" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.7515552404905967">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.7515552404905967" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.1299128922787003">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.1299128922787003" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mslotId0.6129866066710374">slotId</label></td>
<td>
<input class="parameter required" minlength="1" name="slotId" placeholder="(required)" id="mslotId0.6129866066710374" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mslotId0.9353566352227083">slotId</label></td>
<td>
<input class="parameter required" minlength="1" name="slotId" placeholder="(required)" id="mslotId0.9353566352227083" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">long</span></td>
</tr>
<tr>
<td class="code required"><label for="mpersonKey0.6778015690329213">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.6778015690329213" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mpersonKeyToSwapWith0.4522781380032186">personKeyToSwapWith</label></td>
<td>
<input class="parameter required" minlength="1" name="personKeyToSwapWith" placeholder="(required)" id="mpersonKeyToSwapWith0.4522781380032186" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mslotTypeMessage0.404586986471813">slotTypeMessage</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="slotTypeMessage" id="mslotTypeMessage0.404586986471813"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9103525164830581" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9103525164830581">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SlotTypeMessageDto {</span>
<div><span class="propName ">OrganisationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ConnectorId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SlotTypes</span> (<span class="propType">Array[SlotTypeMessageDetailDto]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">SlotTypeMessageDetailDto {</span>
<div><span class="propName ">SlotTypeName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">IdNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"SlotTypes": [
{
"SlotTypeName": "string",
"IdNumber": "string"
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SlotTypeMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<SlotTypes>
<SlotTypeName>string</SlotTypeName>
<IdNumber>string</IdNumber>
</SlotTypes>
</SlotTypeMessageDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.27238338533151274">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.27238338533151274" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.5912430521716894">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.5912430521716894" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td class="markdown">
<p>No Content</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.9078545025148035">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.9078545025148035" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mfromDate0.35086333388199953">fromDate</label></td>
<td>
<input class="parameter required" minlength="1" name="fromDate" placeholder="(required)" id="mfromDate0.35086333388199953" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mswipeRange.connectorId0.8457503386676906">swipeRange.connectorId</label></td>
<td>
<input class="parameter" minlength="0" name="swipeRange.connectorId" placeholder="" id="mswipeRange.connectorId0.8457503386676906" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mswipeRange.rangeStart0.09111012348673064">swipeRange.rangeStart</label></td>
<td>
<input class="parameter" minlength="0" name="swipeRange.rangeStart" placeholder="" id="mswipeRange.rangeStart0.09111012348673064" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mswipeRange.rangeEnd0.2146220281196063">swipeRange.rangeEnd</label></td>
<td>
<input class="parameter" minlength="0" name="swipeRange.rangeEnd" placeholder="" id="mswipeRange.rangeEnd0.2146220281196063" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.7706129207340986">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.7706129207340986" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtimeAccountType0.8210594001360232">timeAccountType</label></td>
<td>
<input class="parameter required" minlength="1" name="timeAccountType" placeholder="(required)" id="mtimeAccountType0.8210594001360232" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.3275854277550867">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.3275854277550867" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mtimeAccountType0.43234006342399955">timeAccountType</label></td>
<td>
<input class="parameter required" minlength="1" name="timeAccountType" placeholder="(required)" id="mtimeAccountType0.43234006342399955" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartRange0.6437562046315728">startRange</label></td>
<td>
<input class="parameter required" minlength="1" name="startRange" placeholder="(required)" id="mstartRange0.6437562046315728" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendRange0.8851005653988198">endRange</label></td>
<td>
<input class="parameter required" minlength="1" name="endRange" placeholder="(required)" id="mendRange0.8851005653988198" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtimeOffRequest0.16860771725518653">timeOffRequest</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="timeOffRequest" id="mtimeOffRequest0.16860771725518653"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.837946059678347" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.837946059678347">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TimeOffRequestMainDto {</span>
<div><span class="propName ">TimeOffRequestId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OrganisationId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateOfRequest</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeAccountTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeAccountTypeName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateFrom</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateTo</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Status</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2', '3', '4']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2, 3, 4</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">CancellationStatus</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2', '3']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2, 3</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">DayType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2', '3', '4']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2, 3, 4</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">ApproverPersonKey1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ApproverPersonName1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeFrom</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeTo</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RequesterNotes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Notes</span> (<span class="propType">Array[TimeOffRequestNoteDto]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">TimeOffRequestNoteDto
{</span>
<div><span class="propName ">TimeOffRequestNoteId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">TimeOffRequestId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">NoteType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">NoteProcessType</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['0', '1', '2', '3', '4', '5', '6']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>0, 1, 2, 3, 4, 5, 6</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">DateCreated</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Note</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DisplayName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"TimeOffRequestId": 0,
"OrganisationId": 0,
"DateOfRequest": "2024-11-07T02:04:39.092Z",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonName": "string",
"TimeAccountTypeId": 0,
"TimeAccountTypeName": "string",
"DateFrom": "2024-11-07T02:04:39.092Z",
"DateTo": "2024-11-07T02:04:39.092Z",
"Status": 1,
"CancellationStatus": 0,
"DayType": 1,
"ApproverPersonKey1": "00000000-0000-0000-0000-000000000000",
"ApproverPersonName1": "string",
"TimeFrom": "string",
"TimeTo": "string",
"RequesterNotes": "string",
"Notes": [
{
"TimeOffRequestNoteId": 0,
"TimeOffRequestId": 0,
"NoteType": 0,
"NoteProcessType": 0,
"DateCreated": "2024-11-07T02:04:39.092Z",
"Note": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"DisplayName": "string"
}
]
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<TimeOffRequestMainDto>
<TimeOffRequestId>1</TimeOffRequestId>
<OrganisationId>1</OrganisationId>
<DateOfRequest>1970-01-01T00:00:00.001Z</DateOfRequest>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonName>string</PersonName>
<TimeAccountTypeId>1</TimeAccountTypeId>
<TimeAccountTypeName>string</TimeAccountTypeName>
<DateFrom>1970-01-01T00:00:00.001Z</DateFrom>
<DateTo>1970-01-01T00:00:00.001Z</DateTo>
<Status>1</Status>
<CancellationStatus>0</CancellationStatus>
<DayType>1</DayType>
<ApproverPersonKey1>00000000-0000-0000-0000-000000000000</ApproverPersonKey1>
<ApproverPersonName1>string</ApproverPersonName1>
<TimeFrom>string</TimeFrom>
<TimeTo>string</TimeTo>
<RequesterNotes>string</RequesterNotes>
<Notes>
<TimeOffRequestNoteId>1</TimeOffRequestNoteId>
<TimeOffRequestId>1</TimeOffRequestId>
<NoteType>0</NoteType>
<NoteProcessType>0</NoteProcessType>
<DateCreated>1970-01-01T00:00:00.001Z</DateCreated>
<Note>string</Note>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<DisplayName>string</DisplayName>
</Notes>
</TimeOffRequestMainDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtimeOffRequestId0.5180623829998086">timeOffRequestId</label></td>
<td>
<input class="parameter required" minlength="1" name="timeOffRequestId" placeholder="(required)" id="mtimeOffRequestId0.5180623829998086" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtimeOffRequestId0.26188101674583586">timeOffRequestId</label></td>
<td>
<input class="parameter required" minlength="1" name="timeOffRequestId" placeholder="(required)" id="mtimeOffRequestId0.26188101674583586" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mnote0.6723802153479579">note</label></td>
<td>
<input class="parameter required" minlength="1" name="note" placeholder="(required)" id="mnote0.6723802153479579" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.08189315908440209">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.08189315908440209" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.1739427058830494">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.1739427058830494" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.9926434220214879">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.9926434220214879" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.3645547902923414">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.3645547902923414" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.9670525210389629">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.9670525210389629" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonKey0.9415659261654279">personKey</label></td>
<td>
<input class="parameter required" minlength="1" name="personKey" placeholder="(required)" id="mpersonKey0.9415659261654279" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.5274899104355635">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.5274899104355635" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mendDate0.25278820500845955">endDate</label></td>
<td>
<input class="parameter required" minlength="1" name="endDate" placeholder="(required)" id="mendDate0.25278820500845955" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mpersonId0.8842815891202385">personId</label></td>
<td>
<input class="parameter required" minlength="1" name="personId" placeholder="(required)" id="mpersonId0.8842815891202385" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mstartDate0.4758413761083431">startDate</label></td>
<td>
<input class="parameter required" minlength="1" name="startDate" placeholder="(required)" id="mstartDate0.4758413761083431" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="munallocatedSlotRequestId0.22094118427196086">unallocatedSlotRequestId</label></td>
<td>
<input class="parameter required" minlength="1" name="unallocatedSlotRequestId" placeholder="(required)" id="munallocatedSlotRequestId0.22094118427196086" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="munallocatedSlotRequest0.4878231019123225">unallocatedSlotRequest</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="unallocatedSlotRequest" id="munallocatedSlotRequest0.4878231019123225"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6988411157874301" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6988411157874301">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UnallocatedSlotRequestMainDto {</span>
<div><span class="propName ">UnallocatedSlotRequestId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OrganisationId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">Status</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2', '3']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2, 3</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">DisplayStatus</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['1', '2']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>1, 2</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">DateOfRequest</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">DateProcessed</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonKey</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">PersonName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ApprovedPersonNames</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RejectedPersonNames</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SlotId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">RequesterNotes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ApproverUserId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ApproverPersonName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">ApproverNotes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SlotDetails</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">SlotDisplayPlannedTimes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">GroupId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">GroupName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"UnallocatedSlotRequestId": 0,
"OrganisationId": 0,
"Status": 1,
"DisplayStatus": 1,
"DateOfRequest": "2024-11-07T02:04:39.109Z",
"DateProcessed": "2024-11-07T02:04:39.109Z",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonName": "string",
"ApprovedPersonNames": "string",
"RejectedPersonNames": "string",
"SlotId": 0,
"RequesterNotes": "string",
"ApproverUserId": "string",
"ApproverPersonName": "string",
"ApproverNotes": "string",
"SlotDetails": "string",
"SlotDisplayPlannedTimes": "string",
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<UnallocatedSlotRequestMainDto>
<UnallocatedSlotRequestId>1</UnallocatedSlotRequestId>
<OrganisationId>1</OrganisationId>
<Status>1</Status>
<DisplayStatus>1</DisplayStatus>
<DateOfRequest>1970-01-01T00:00:00.001Z</DateOfRequest>
<DateProcessed>1970-01-01T00:00:00.001Z</DateProcessed>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonName>string</PersonName>
<ApprovedPersonNames>string</ApprovedPersonNames>
<RejectedPersonNames>string</RejectedPersonNames>
<SlotId>1</SlotId>
<RequesterNotes>string</RequesterNotes>
<ApproverUserId>string</ApproverUserId>
<ApproverPersonName>string</ApproverPersonName>
<ApproverNotes>string</ApproverNotes>
<SlotDetails>string</SlotDetails>
<SlotDisplayPlannedTimes>string</SlotDisplayPlannedTimes>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
</UnallocatedSlotRequestMainDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mId0.19967057591728832">Id</label></td>
<td>
<input class="parameter required" minlength="1" name="Id" placeholder="(required)" id="mId0.19967057591728832" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mforgotPasswordModel0.5838752218920171">forgotPasswordModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="forgotPasswordModel" id="mforgotPasswordModel0.5838752218920171"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4375912293414641" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4375912293414641">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ForgotPasswordDto {</span>
<div><span class="propName required">Email</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"Email": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ForgotPasswordDto>
<Email>string</Email>
</ForgotPasswordDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mchangePasswordModel0.1358980389526796">changePasswordModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="changePasswordModel" id="mchangePasswordModel0.1358980389526796"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5812574050990826" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5812574050990826">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ChangePasswordDto {</span>
<div><span class="propName required">UserId</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">CurrentPassword</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">NewPassword</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"UserId": "string",
"CurrentPassword": "string",
"NewPassword": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<ChangePasswordDto>
<UserId>string</UserId>
<CurrentPassword>string</CurrentPassword>
<NewPassword>string</NewPassword>
</ChangePasswordDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mselfServiceUserTrackingApiDto0.6635630681682683">selfServiceUserTrackingApiDto</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="selfServiceUserTrackingApiDto" id="mselfServiceUserTrackingApiDto0.6635630681682683"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8913519292384495" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8913519292384495">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SelfServiceUserTrackingApiDto {</span>
<div><span class="propName ">DateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Event</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Browser</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">OperatingSystem</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">Domain</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">UserAgent</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"DateTime": "2024-11-07T02:04:39.118Z",
"Event": "string",
"Browser": "string",
"OperatingSystem": "string",
"Domain": "string",
"UserAgent": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code><?xml version="1.0"?>
<SelfServiceUserTrackingApiDto>
<DateTime>1970-01-01T00:00:00.001Z</DateTime>
<Event>string</Event>
<Browser>string</Browser>
<OperatingSystem>string</OperatingSystem>
<Domain>string</Domain>
<UserAgent>string</UserAgent>
</SelfServiceUserTrackingApiDto>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
swagger
Explore
RotaOneWebAPI
Thinking Software RotaOne API
* ASSET
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/ASSETSCAN
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type assetScanDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
AssetScanDto {
Data (string, optional),
Latitude (number, optional),
Longitude (number, optional),
Status (integer, optional) = ['1', '2']
integerEnum:1, 2
,
Note (string, optional)
}
{
"Data": "string",
"Latitude": 0,
"Longitude": 0,
"Status": 1,
"Note": "string"
}
<?xml version="1.0"?>
<AssetScanDto>
<Data>string</Data>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<Status>1</Status>
<Note>string</Note>
</AssetScanDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* AVAILABILITY
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/AVAILABILTY/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AvailabilityWithLockDto {
Availability (Array[AvailabilityDto], optional),
PersonLockDate (string, optional)
}
AvailabilityDto {
OrganisationGuid (string, optional),
ConnectorGuid (string, optional),
PersonIdNumber (string, optional),
PersonKey (string, optional),
StartDate (string, optional),
EndDate (string, optional),
AvailabiltyHoursFullMonth (string, optional),
Id (integer, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
Status (integer, optional) = ['0', '1']
integerEnum:0, 1
,
CreatedDate (string, optional),
UpdatedDate (string, optional),
HistoryCreated (string, optional),
HistoryStart (string, optional),
HistoryEnd (string, optional),
UserId (string, optional),
Terminate (boolean, optional)
}
{
"Availability": [
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"PersonIdNumber": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"StartDate": "2024-11-07T02:04:38.751Z",
"EndDate": "2024-11-07T02:04:38.751Z",
"AvailabiltyHoursFullMonth": "string",
"Id": 0,
"OrganisationId": 0,
"CustomTypeId": 0,
"Status": 0,
"CreatedDate": "2024-11-07T02:04:38.751Z",
"UpdatedDate": "2024-11-07T02:04:38.751Z",
"HistoryCreated": "2024-11-07T02:04:38.751Z",
"HistoryStart": "2024-11-07T02:04:38.751Z",
"HistoryEnd": "2024-11-07T02:04:38.751Z",
"UserId": "string",
"Terminate": true
}
],
"PersonLockDate": "2024-11-07T02:04:38.751Z"
}
<?xml version="1.0"?>
<AvailabilityWithLockDto>
<Availability>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<PersonIdNumber>string</PersonIdNumber>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<AvailabiltyHoursFullMonth>string</AvailabiltyHoursFullMonth>
<Id>1</Id>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Status>0</Status>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<UpdatedDate>1970-01-01T00:00:00.001Z</UpdatedDate>
<HistoryCreated>1970-01-01T00:00:00.001Z</HistoryCreated>
<HistoryStart>1970-01-01T00:00:00.001Z</HistoryStart>
<HistoryEnd>1970-01-01T00:00:00.001Z</HistoryEnd>
<UserId>string</UserId>
<Terminate>true</Terminate>
</Availability>
<PersonLockDate>1970-01-01T00:00:00.001Z</PersonLockDate>
</AvailabilityWithLockDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/AVAILABILTY
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
string
]
[
"string"
]
<?xml version="1.0"?>
<Inline Model>string</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type availabilityInputDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
AvailabilityInputDto {
UnavailableDays (Array[AvailabilityDto], optional),
PersonKey (string, optional),
StartDate (string, optional),
EndDate (string, optional)
}
AvailabilityDto {
OrganisationGuid (string, optional),
ConnectorGuid (string, optional),
PersonIdNumber (string, optional),
PersonKey (string, optional),
StartDate (string, optional),
EndDate (string, optional),
AvailabiltyHoursFullMonth (string, optional),
Id (integer, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
Status (integer, optional) = ['0', '1']
integerEnum:0, 1
,
CreatedDate (string, optional),
UpdatedDate (string, optional),
HistoryCreated (string, optional),
HistoryStart (string, optional),
HistoryEnd (string, optional),
UserId (string, optional),
Terminate (boolean, optional)
}
{
"UnavailableDays": [
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"PersonIdNumber": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"StartDate": "2024-11-07T02:04:38.758Z",
"EndDate": "2024-11-07T02:04:38.758Z",
"AvailabiltyHoursFullMonth": "string",
"Id": 0,
"OrganisationId": 0,
"CustomTypeId": 0,
"Status": 0,
"CreatedDate": "2024-11-07T02:04:38.758Z",
"UpdatedDate": "2024-11-07T02:04:38.758Z",
"HistoryCreated": "2024-11-07T02:04:38.758Z",
"HistoryStart": "2024-11-07T02:04:38.758Z",
"HistoryEnd": "2024-11-07T02:04:38.758Z",
"UserId": "string",
"Terminate": true
}
],
"PersonKey": "00000000-0000-0000-0000-000000000000",
"StartDate": "2024-11-07T02:04:38.758Z",
"EndDate": "2024-11-07T02:04:38.758Z"
}
<?xml version="1.0"?>
<AvailabilityInputDto>
<UnavailableDays>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<PersonIdNumber>string</PersonIdNumber>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<AvailabiltyHoursFullMonth>string</AvailabiltyHoursFullMonth>
<Id>1</Id>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Status>0</Status>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<UpdatedDate>1970-01-01T00:00:00.001Z</UpdatedDate>
<HistoryCreated>1970-01-01T00:00:00.001Z</HistoryCreated>
<HistoryStart>1970-01-01T00:00:00.001Z</HistoryStart>
<HistoryEnd>1970-01-01T00:00:00.001Z</HistoryEnd>
<UserId>string</UserId>
<Terminate>true</Terminate>
</UnavailableDays>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</AvailabilityInputDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CONNECTORONLINESTATUS
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/CONNECTOR/ONLINESTATUS
*
RESPONSE CLASS (STATUS 200)
boolean
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
connectorOnlineStatusDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ConnectorOnlineStatusDto {
OrganisationGuid (string, optional),
ConnectorId (string, optional),
ConnectorOnlineStatus (integer, optional) = ['0', '1']
integerEnum:0, 1
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"ConnectorOnlineStatus": 0
}
<?xml version="1.0"?>
<ConnectorOnlineStatusDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<ConnectorOnlineStatus>0</ConnectorOnlineStatus>
</ConnectorOnlineStatusDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CONNECTORS
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/CONNECTORS/SETCONNECTIVITYSTATUS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectivityStatus
query integer connectorGuid query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CONNECTORS/STATUS
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectors
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ConnectorMessageDto {
OrganisationId (string, optional),
ConnectorIds (Array[string], optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}
<?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/V2/CONNECTORS/STATUS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectors
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ConnectorMessageDto {
OrganisationId (string, optional),
ConnectorIds (Array[string], optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}
<?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CONNECTORS/GETCONNECTORDETAILS
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectors
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ConnectorMessageDto {
OrganisationId (string, optional),
ConnectorIds (Array[string], optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}
<?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/V2/CONNECTORS/GETCONNECTORDETAILS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectors
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ConnectorMessageDto {
OrganisationId (string, optional),
ConnectorIds (Array[string], optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}
<?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CONNECTORS/FORCEPOLL
*
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectors
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ConnectorMessageDto {
OrganisationId (string, optional),
ConnectorIds (Array[string], optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}
<?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/V2/CONNECTORS/FORCEPOLL
*
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectors
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ConnectorMessageDto {
OrganisationId (string, optional),
ConnectorIds (Array[string], optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}
<?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CONNECTOR/COMPLETEPOLL
*
WARNING: DEPRECATED
PARAMETERS
Parameter Value Description Parameter Type Data Type connectors
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ConnectorMessageDto {
OrganisationId (string, optional),
ConnectorIds (Array[string], optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
]
}
<?xml version="1.0"?>
<ConnectorMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
</ConnectorMessageDto>
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No Content
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CONNECTORS/SETTINGS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type OrganisationGuid
query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CONNECTORS/PERIPHERALS/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type peripheralMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
PeripheralMessageDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
PeripheralId (string, optional),
Name (string, optional),
SerialNumber (string, optional),
IpAddress (string, optional),
ModelNumber (string, optional),
FirmwareVersion (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"PeripheralId": "string",
"Name": "string",
"SerialNumber": "string",
"IpAddress": "string",
"ModelNumber": "string",
"FirmwareVersion": "string"
}
<?xml version="1.0"?>
<PeripheralMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<PeripheralId>string</PeripheralId>
<Name>string</Name>
<SerialNumber>string</SerialNumber>
<IpAddress>string</IpAddress>
<ModelNumber>string</ModelNumber>
<FirmwareVersion>string</FirmwareVersion>
</PeripheralMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CONNECTORS/INPUTDEVICES/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type inputDeviceMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
InputDeviceMessageDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
InputDeviceId (string, optional),
InputDeviceName (string, optional),
InputDoorName (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"InputDeviceId": "string",
"InputDeviceName": "string",
"InputDoorName": "string"
}
<?xml version="1.0"?>
<InputDeviceMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<InputDeviceId>string</InputDeviceId>
<InputDeviceName>string</InputDeviceName>
<InputDoorName>string</InputDoorName>
</InputDeviceMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CRYPTOGRAPHY
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/CRYPTOGRAPHY/ENCRYPT
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CryptoGraphyDto {
Text (string, optional)
}
{
"Text": "string"
}
<?xml version="1.0"?>
<CryptoGraphyDto>
<Text>string</Text>
</CryptoGraphyDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type cryptoGraphyDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
CryptoGraphyDto {
Text (string, optional)
}
{
"Text": "string"
}
<?xml version="1.0"?>
<CryptoGraphyDto>
<Text>string</Text>
</CryptoGraphyDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CRYPTOGRAPHY/DECRYPT
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CryptoGraphyDto {
Text (string, optional)
}
{
"Text": "string"
}
<?xml version="1.0"?>
<CryptoGraphyDto>
<Text>string</Text>
</CryptoGraphyDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type cryptoGraphyDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
CryptoGraphyDto {
Text (string, optional)
}
{
"Text": "string"
}
<?xml version="1.0"?>
<CryptoGraphyDto>
<Text>string</Text>
</CryptoGraphyDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CUSTOMERS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/CUSTOMERS/GETALLREPORTING
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
Id (integer, optional),
CustomerName (string, optional),
OrganisationGuid (string, optional),
DatabaseName (string, optional),
OrganisationId (integer, optional),
OrganisationReferenceId (integer, optional),
InstanceId (integer, optional),
UnderMaintenance (boolean, optional)
}
[
{
"Id": 0,
"CustomerName": "string",
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"DatabaseName": "string",
"OrganisationId": 0,
"OrganisationReferenceId": 0,
"InstanceId": 0,
"UnderMaintenance": true
}
]
<?xml version="1.0"?>
<Inline Model>
<Id>1</Id>
<CustomerName>string</CustomerName>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<DatabaseName>string</DatabaseName>
<OrganisationId>1</OrganisationId>
<OrganisationReferenceId>1</OrganisationReferenceId>
<InstanceId>1</InstanceId>
<UnderMaintenance>true</UnderMaintenance>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CUSTOMTYPES
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/V2/CUSTOMTYPES
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type customTypes
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
CustomTypeMessageDto {
OrganisationGuid (string, optional),
Jobs (boolean, optional),
Payrates (boolean, optional),
Persons (boolean, optional)
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"Jobs": true,
"Payrates": true,
"Persons": true
}
<?xml version="1.0"?>
<CustomTypeMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<Jobs>true</Jobs>
<Payrates>true</Payrates>
<Persons>true</Persons>
</CustomTypeMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CUSTOMTYPES
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type customTypes
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
CustomTypeMessageDto {
OrganisationGuid (string, optional),
Jobs (boolean, optional),
Payrates (boolean, optional),
Persons (boolean, optional)
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"Jobs": true,
"Payrates": true,
"Persons": true
}
<?xml version="1.0"?>
<CustomTypeMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<Jobs>true</Jobs>
<Payrates>true</Payrates>
<Persons>true</Persons>
</CustomTypeMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* FILE
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/FILE/UPLOADFILE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ResponseDto {
Messages (Array[MessageDto], optional),
Success (boolean, optional)
}
MessageDto {
Message (string, optional),
MessageType (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
}
{
"Messages": [
{
"Message": "string",
"MessageType": 1
}
],
"Success": true
}
<?xml version="1.0"?>
<ResponseDto>
<Messages>
<Message>string</Message>
<MessageType>1</MessageType>
</Messages>
<Success>true</Success>
</ResponseDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type fileEntityType 1 2 3
query integer fileEntityId query string documentSecurityStatusLevel 1 2 3
4 5 6 7 8 9
query integer fileEntitySubType 1 query integer fileEntitySubTypeEntityId
query string latitude query double longitude query double note query
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/FILES
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
FileId (integer, optional),
FileName (string, optional),
ContentType (string, optional),
FileEntityId (string, optional),
FileEntityType (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
,
UploadedBy (string, optional),
UploadedDate (string, optional),
FileReferenceId (string, optional),
OraganisationId (integer, optional),
DocumentSecurityStatusLevel (integer, optional) = ['1', '2', '3', '4',
'5', '6', '7', '8', '9']
integerEnum:1, 2, 3, 4, 5, 6, 7, 8, 9
,
ViewInSelfService (boolean, optional),
Latitude (number, optional),
Longitude (number, optional),
Note (string, optional)
}
[
{
"FileId": 0,
"FileName": "string",
"ContentType": "string",
"FileEntityId": "00000000-0000-0000-0000-000000000000",
"FileEntityType": 1,
"UploadedBy": "string",
"UploadedDate": "2024-11-07T02:04:38.806Z",
"FileReferenceId": "00000000-0000-0000-0000-000000000000",
"OraganisationId": 0,
"DocumentSecurityStatusLevel": 1,
"ViewInSelfService": true,
"Latitude": 0,
"Longitude": 0,
"Note": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<FileId>1</FileId>
<FileName>string</FileName>
<ContentType>string</ContentType>
<FileEntityId>00000000-0000-0000-0000-000000000000</FileEntityId>
<FileEntityType>1</FileEntityType>
<UploadedBy>string</UploadedBy>
<UploadedDate>1970-01-01T00:00:00.001Z</UploadedDate>
<FileReferenceId>00000000-0000-0000-0000-000000000000</FileReferenceId>
<OraganisationId>1</OraganisationId>
<DocumentSecurityStatusLevel>1</DocumentSecurityStatusLevel>
<ViewInSelfService>true</ViewInSelfService>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<Note>string</Note>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type fileEntityType 1 2 3
query integer
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/FILE/DOWNLOADFILE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
FileDataDto {
Id (integer, optional),
FileReferenceId (string, optional),
Data (string, optional),
FileName (string, optional),
ContentType (string, optional)
}
{
"Id": 0,
"FileReferenceId": "00000000-0000-0000-0000-000000000000",
"Data": "string",
"FileName": "string",
"ContentType": "string"
}
<?xml version="1.0"?>
<FileDataDto>
<Id>1</Id>
<FileReferenceId>00000000-0000-0000-0000-000000000000</FileReferenceId>
<Data>string</Data>
<FileName>string</FileName>
<ContentType>string</ContentType>
</FileDataDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type fileReferenceId
query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* GAMES
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/GAME/ACHIEVEMENTS/{PERSONKEY}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
AchievementKey (string, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
SlotTypeContainerId (string, optional),
Name (string, optional),
AwardedMessage (string, optional),
Icon (string, optional),
PointsToUnlock (integer, optional),
CurrentPoints (integer, optional),
PercentageToUnlock (integer, optional),
Unlocked (boolean, optional),
VisibleBeforeUnlocked (boolean, optional)
}
[
{
"AchievementKey": "00000000-0000-0000-0000-000000000000",
"OrganisationId": 0,
"CustomTypeId": 0,
"SlotTypeContainerId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"AwardedMessage": "string",
"Icon": "string",
"PointsToUnlock": 0,
"CurrentPoints": 0,
"PercentageToUnlock": 0,
"Unlocked": true,
"VisibleBeforeUnlocked": true
}
]
<?xml version="1.0"?>
<Inline Model>
<AchievementKey>00000000-0000-0000-0000-000000000000</AchievementKey>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<SlotTypeContainerId>00000000-0000-0000-0000-000000000000</SlotTypeContainerId>
<Name>string</Name>
<AwardedMessage>string</AwardedMessage>
<Icon>string</Icon>
<PointsToUnlock>1</PointsToUnlock>
<CurrentPoints>1</CurrentPoints>
<PercentageToUnlock>1</PercentageToUnlock>
<Unlocked>true</Unlocked>
<VisibleBeforeUnlocked>true</VisibleBeforeUnlocked>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personkey path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/GAME/LEADERBOARDS/{PERSONKEY}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
LeaderboardKey (string, optional),
Name (string, optional),
Type (integer, optional) = ['0', '1']
integerEnum:0, 1
,
DatePatternId (integer, optional),
DateRangeId (integer, optional),
RangeStart (string, optional),
RangeEnd (string, optional),
AvailableDateRanges (Array[DateRangeDto], optional)
}
DateRangeDto {
DateRangeId (integer, optional),
DatePatternId (integer, optional),
RangeStart (string, optional),
RangeEnd (string, optional),
RangeAsString (string, optional),
TempDateRangeId (string, optional),
IntervalType (integer, optional),
StartOfWeekId (integer, optional),
DefaultSelected (boolean, optional)
}
[
{
"LeaderboardKey": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Type": 0,
"DatePatternId": 0,
"DateRangeId": 0,
"RangeStart": "2024-11-07T02:04:38.812Z",
"RangeEnd": "2024-11-07T02:04:38.812Z",
"AvailableDateRanges": [
{
"DateRangeId": 0,
"DatePatternId": 0,
"RangeStart": "2024-11-07T02:04:38.812Z",
"RangeEnd": "2024-11-07T02:04:38.813Z",
"RangeAsString": "string",
"TempDateRangeId": "00000000-0000-0000-0000-000000000000",
"IntervalType": 0,
"StartOfWeekId": 0,
"DefaultSelected": true
}
]
}
]
<?xml version="1.0"?>
<Inline Model>
<LeaderboardKey>00000000-0000-0000-0000-000000000000</LeaderboardKey>
<Name>string</Name>
<Type>0</Type>
<DatePatternId>1</DatePatternId>
<DateRangeId>1</DateRangeId>
<RangeStart>1970-01-01T00:00:00.001Z</RangeStart>
<RangeEnd>1970-01-01T00:00:00.001Z</RangeEnd>
<AvailableDateRanges>
<DateRangeId>1</DateRangeId>
<DatePatternId>1</DatePatternId>
<RangeStart>1970-01-01T00:00:00.001Z</RangeStart>
<RangeEnd>1970-01-01T00:00:00.001Z</RangeEnd>
<RangeAsString>string</RangeAsString>
<TempDateRangeId>00000000-0000-0000-0000-000000000000</TempDateRangeId>
<IntervalType>1</IntervalType>
<StartOfWeekId>1</StartOfWeekId>
<DefaultSelected>true</DefaultSelected>
</AvailableDateRanges>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/GAME/LEADERBOARDSCORES/{LEADERBOARDKEY}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
EntityId (string, optional),
Name (string, optional),
Points (integer, optional),
IsThisPersonTheUser (boolean, optional)
}
[
{
"EntityId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Points": 0,
"IsThisPersonTheUser": true
}
]
<?xml version="1.0"?>
<Inline Model>
<EntityId>00000000-0000-0000-0000-000000000000</EntityId>
<Name>string</Name>
<Points>1</Points>
<IsThisPersonTheUser>true</IsThisPersonTheUser>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type leaderboardKey path
string dateRangeId query integer personKey query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* GROUPS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/V2/GROUPS/CONNECTOR/{CONNECTORID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectorId path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/GROUPS/CONNECTOR/{CONNECTORID}
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type connectorId path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/GROUPS/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type group
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
GroupMessageDto {
ConnectorId (string, optional),
OrganisationId (string, optional),
GroupId (string, optional),
Name (string, optional)
}
{
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"GroupId": "string",
"Name": "string"
}
<?xml version="1.0"?>
<GroupMessageDto>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<GroupId>string</GroupId>
<Name>string</Name>
</GroupMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/GROUPS/UPDATEGROUPCONNECTORID
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type groupIdAttachments
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
UpdateConnectorGroupIdAttachmentDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
GroupId (string, optional),
GroupConnectorId (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"GroupId": "string",
"GroupConnectorId": "string"
}
<?xml version="1.0"?>
<UpdateConnectorGroupIdAttachmentDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<GroupId>string</GroupId>
<GroupConnectorId>string</GroupConnectorId>
</UpdateConnectorGroupIdAttachmentDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/GROUPS/PERSON/{PERSONKEY}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
GroupId (string, optional),
GroupCode (string, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
ParentId (string, optional),
AllowableParents (Array[GroupDto], optional),
Name (string, optional),
ContainsBaseTypeId (integer, optional) = ['0', '1', '2', '3', '4', '6',
'7', '9', '11', '12', '13', '14', '16', '19', '20', '23', '24', '25',
'26', '29', '30', '32', '33', '34', '35', '36', '37', '38', '39', '40',
'41', '42', '43', '44', '45', '46', '47']
integerEnum:0, 1, 2, 3, 4, 6, 7, 9, 11, 12, 13, 14, 16, 19, 20, 23, 24,
25, 26, 29, 30, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45,
46, 47
,
CanHaveRota (boolean, optional),
Path (string, optional),
CanHaveUnallocatedPeople (boolean, optional),
RotaLockDate (string, optional),
EmailOnNoShow (boolean, optional),
EmailOnNoShowSendEmailAfterSeconds (integer, optional),
TimeZoneId (integer, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
AddressLine3 (string, optional),
AddressLine4 (string, optional),
Town (string, optional),
County (string, optional),
PostCode (string, optional),
Country (string, optional),
Location (LocationDto, optional),
DefaultPeripheralKey (string, optional),
ThreatLevelTypeId (string, optional),
MoveOutsideThresholdSeconds (integer, optional),
PeripheralContainerId (string, optional),
AllowWorkBaseOnJob (boolean, optional),
AllowWorkBaseOnJobSTDistanceAllowed (number, optional),
PayUnplannedSlots (boolean, optional),
PeriodSlotTypeContainerId (string, optional),
PeriodStart1 (string, optional),
PeriodEnd1 (string, optional),
PeriodStart2 (string, optional),
PeriodEnd2 (string, optional),
PeriodStart3 (string, optional),
PeriodEnd3 (string, optional),
PeriodStart4 (string, optional),
PeriodEnd4 (string, optional),
SlotSwapType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
MoveOutsidePeripheralKey (string, optional),
JobMandatory (boolean, optional),
HideUnallocatedRow (boolean, optional),
ApplyDefaultData (boolean, optional),
ShowOriginalJobIfMismatchOnShiftPattern (boolean, optional),
ShowOriginalShiftIfMismatchOnShiftPattern (boolean, optional),
AutoCreateTaskChunks (boolean, optional),
AutoCreateTaskChunksSlotTypeContainerId (string, optional)
}
GroupDto {
GroupId (string, optional),
GroupCode (string, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
ParentId (string, optional),
AllowableParents (Array[GroupDto], optional),
Name (string, optional),
ContainsBaseTypeId (integer, optional) = ['0', '1', '2', '3', '4', '6',
'7', '9', '11', '12', '13', '14', '16', '19', '20', '23', '24', '25',
'26', '29', '30', '32', '33', '34', '35', '36', '37', '38', '39', '40',
'41', '42', '43', '44', '45', '46', '47']
integerEnum:0, 1, 2, 3, 4, 6, 7, 9, 11, 12, 13, 14, 16, 19, 20, 23, 24,
25, 26, 29, 30, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45,
46, 47
,
CanHaveRota (boolean, optional),
Path (string, optional),
CanHaveUnallocatedPeople (boolean, optional),
RotaLockDate (string, optional),
EmailOnNoShow (boolean, optional),
EmailOnNoShowSendEmailAfterSeconds (integer, optional),
TimeZoneId (integer, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
AddressLine3 (string, optional),
AddressLine4 (string, optional),
Town (string, optional),
County (string, optional),
PostCode (string, optional),
Country (string, optional),
Location (LocationDto, optional),
DefaultPeripheralKey (string, optional),
ThreatLevelTypeId (string, optional),
MoveOutsideThresholdSeconds (integer, optional),
PeripheralContainerId (string, optional),
AllowWorkBaseOnJob (boolean, optional),
AllowWorkBaseOnJobSTDistanceAllowed (number, optional),
PayUnplannedSlots (boolean, optional),
PeriodSlotTypeContainerId (string, optional),
PeriodStart1 (string, optional),
PeriodEnd1 (string, optional),
PeriodStart2 (string, optional),
PeriodEnd2 (string, optional),
PeriodStart3 (string, optional),
PeriodEnd3 (string, optional),
PeriodStart4 (string, optional),
PeriodEnd4 (string, optional),
SlotSwapType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
MoveOutsidePeripheralKey (string, optional),
JobMandatory (boolean, optional),
HideUnallocatedRow (boolean, optional),
ApplyDefaultData (boolean, optional),
ShowOriginalJobIfMismatchOnShiftPattern (boolean, optional),
ShowOriginalShiftIfMismatchOnShiftPattern (boolean, optional),
AutoCreateTaskChunks (boolean, optional),
AutoCreateTaskChunksSlotTypeContainerId (string, optional)
}
LocationDto {
UserId (string, optional),
UserName (string, optional),
Latitude (number, optional),
Longitude (number, optional)
}
[
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupCode": "string",
"OrganisationId": 0,
"CustomTypeId": 0,
"ParentId": "00000000-0000-0000-0000-000000000000",
"AllowableParents": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupCode": "string",
"OrganisationId": 0,
"CustomTypeId": 0,
"ParentId": "00000000-0000-0000-0000-000000000000",
"AllowableParents": [
{}
],
"Name": "string",
"ContainsBaseTypeId": 0,
"CanHaveRota": true,
"Path": "string",
"CanHaveUnallocatedPeople": true,
"RotaLockDate": "2024-11-07T02:04:38.822Z",
"EmailOnNoShow": true,
"EmailOnNoShowSendEmailAfterSeconds": 0,
"TimeZoneId": 0,
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"AddressLine4": "string",
"Town": "string",
"County": "string",
"PostCode": "string",
"Country": "string",
"Location": {
"UserId": "00000000-0000-0000-0000-000000000000",
"UserName": "string",
"Latitude": 0,
"Longitude": 0
},
"DefaultPeripheralKey": "00000000-0000-0000-0000-000000000000",
"ThreatLevelTypeId": "00000000-0000-0000-0000-000000000000",
"MoveOutsideThresholdSeconds": 0,
"PeripheralContainerId": "00000000-0000-0000-0000-000000000000",
"AllowWorkBaseOnJob": true,
"AllowWorkBaseOnJobSTDistanceAllowed": 0,
"PayUnplannedSlots": true,
"PeriodSlotTypeContainerId": "00000000-0000-0000-0000-000000000000",
"PeriodStart1": "string",
"PeriodEnd1": "string",
"PeriodStart2": "string",
"PeriodEnd2": "string",
"PeriodStart3": "string",
"PeriodEnd3": "string",
"PeriodStart4": "string",
"PeriodEnd4": "string",
"SlotSwapType": 0,
"MoveOutsidePeripheralKey": "00000000-0000-0000-0000-000000000000",
"JobMandatory": true,
"HideUnallocatedRow": true,
"ApplyDefaultData": true,
"ShowOriginalJobIfMismatchOnShiftPattern": true,
"ShowOriginalShiftIfMismatchOnShiftPattern": true,
"AutoCreateTaskChunks": true,
"AutoCreateTaskChunksSlotTypeContainerId": "00000000-0000-0000-0000-000000000000"
}
],
"Name": "string",
"ContainsBaseTypeId": 0,
"CanHaveRota": true,
"Path": "string",
"CanHaveUnallocatedPeople": true,
"RotaLockDate": "2024-11-07T02:04:38.822Z",
"EmailOnNoShow": true,
"EmailOnNoShowSendEmailAfterSeconds": 0,
"TimeZoneId": 0,
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"AddressLine4": "string",
"Town": "string",
"County": "string",
"PostCode": "string",
"Country": "string",
"Location": {
"UserId": "00000000-0000-0000-0000-000000000000",
"UserName": "string",
"Latitude": 0,
"Longitude": 0
},
"DefaultPeripheralKey": "00000000-0000-0000-0000-000000000000",
"ThreatLevelTypeId": "00000000-0000-0000-0000-000000000000",
"MoveOutsideThresholdSeconds": 0,
"PeripheralContainerId": "00000000-0000-0000-0000-000000000000",
"AllowWorkBaseOnJob": true,
"AllowWorkBaseOnJobSTDistanceAllowed": 0,
"PayUnplannedSlots": true,
"PeriodSlotTypeContainerId": "00000000-0000-0000-0000-000000000000",
"PeriodStart1": "string",
"PeriodEnd1": "string",
"PeriodStart2": "string",
"PeriodEnd2": "string",
"PeriodStart3": "string",
"PeriodEnd3": "string",
"PeriodStart4": "string",
"PeriodEnd4": "string",
"SlotSwapType": 0,
"MoveOutsidePeripheralKey": "00000000-0000-0000-0000-000000000000",
"JobMandatory": true,
"HideUnallocatedRow": true,
"ApplyDefaultData": true,
"ShowOriginalJobIfMismatchOnShiftPattern": true,
"ShowOriginalShiftIfMismatchOnShiftPattern": true,
"AutoCreateTaskChunks": true,
"AutoCreateTaskChunksSlotTypeContainerId": "00000000-0000-0000-0000-000000000000"
}
]
<?xml version="1.0"?>
<Inline Model>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupCode>string</GroupCode>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<ParentId>00000000-0000-0000-0000-000000000000</ParentId>
<AllowableParents>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupCode>string</GroupCode>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<ParentId>00000000-0000-0000-0000-000000000000</ParentId>
<AllowableParents>
<!-- Infinite loop $ref:GroupDto -->
</AllowableParents>
<Name>string</Name>
<ContainsBaseTypeId>0</ContainsBaseTypeId>
<CanHaveRota>true</CanHaveRota>
<Path>string</Path>
<CanHaveUnallocatedPeople>true</CanHaveUnallocatedPeople>
<RotaLockDate>1970-01-01T00:00:00.001Z</RotaLockDate>
<EmailOnNoShow>true</EmailOnNoShow>
<EmailOnNoShowSendEmailAfterSeconds>1</EmailOnNoShowSendEmailAfterSeconds>
<TimeZoneId>1</TimeZoneId>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<AddressLine3>string</AddressLine3>
<AddressLine4>string</AddressLine4>
<Town>string</Town>
<County>string</County>
<PostCode>string</PostCode>
<Country>string</Country>
<Location>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>string</UserName>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
</Location>
<DefaultPeripheralKey>00000000-0000-0000-0000-000000000000</DefaultPeripheralKey>
<ThreatLevelTypeId>00000000-0000-0000-0000-000000000000</ThreatLevelTypeId>
<MoveOutsideThresholdSeconds>1</MoveOutsideThresholdSeconds>
<PeripheralContainerId>00000000-0000-0000-0000-000000000000</PeripheralContainerId>
<AllowWorkBaseOnJob>true</AllowWorkBaseOnJob>
<AllowWorkBaseOnJobSTDistanceAllowed>1.1</AllowWorkBaseOnJobSTDistanceAllowed>
<PayUnplannedSlots>true</PayUnplannedSlots>
<PeriodSlotTypeContainerId>00000000-0000-0000-0000-000000000000</PeriodSlotTypeContainerId>
<PeriodStart1>string</PeriodStart1>
<PeriodEnd1>string</PeriodEnd1>
<PeriodStart2>string</PeriodStart2>
<PeriodEnd2>string</PeriodEnd2>
<PeriodStart3>string</PeriodStart3>
<PeriodEnd3>string</PeriodEnd3>
<PeriodStart4>string</PeriodStart4>
<PeriodEnd4>string</PeriodEnd4>
<SlotSwapType>0</SlotSwapType>
<MoveOutsidePeripheralKey>00000000-0000-0000-0000-000000000000</MoveOutsidePeripheralKey>
<JobMandatory>true</JobMandatory>
<HideUnallocatedRow>true</HideUnallocatedRow>
<ApplyDefaultData>true</ApplyDefaultData>
<ShowOriginalJobIfMismatchOnShiftPattern>true</ShowOriginalJobIfMismatchOnShiftPattern>
<ShowOriginalShiftIfMismatchOnShiftPattern>true</ShowOriginalShiftIfMismatchOnShiftPattern>
<AutoCreateTaskChunks>true</AutoCreateTaskChunks>
<AutoCreateTaskChunksSlotTypeContainerId>00000000-0000-0000-0000-000000000000</AutoCreateTaskChunksSlotTypeContainerId>
</AllowableParents>
<Name>string</Name>
<ContainsBaseTypeId>0</ContainsBaseTypeId>
<CanHaveRota>true</CanHaveRota>
<Path>string</Path>
<CanHaveUnallocatedPeople>true</CanHaveUnallocatedPeople>
<RotaLockDate>1970-01-01T00:00:00.001Z</RotaLockDate>
<EmailOnNoShow>true</EmailOnNoShow>
<EmailOnNoShowSendEmailAfterSeconds>1</EmailOnNoShowSendEmailAfterSeconds>
<TimeZoneId>1</TimeZoneId>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<AddressLine3>string</AddressLine3>
<AddressLine4>string</AddressLine4>
<Town>string</Town>
<County>string</County>
<PostCode>string</PostCode>
<Country>string</Country>
<Location>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>string</UserName>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
</Location>
<DefaultPeripheralKey>00000000-0000-0000-0000-000000000000</DefaultPeripheralKey>
<ThreatLevelTypeId>00000000-0000-0000-0000-000000000000</ThreatLevelTypeId>
<MoveOutsideThresholdSeconds>1</MoveOutsideThresholdSeconds>
<PeripheralContainerId>00000000-0000-0000-0000-000000000000</PeripheralContainerId>
<AllowWorkBaseOnJob>true</AllowWorkBaseOnJob>
<AllowWorkBaseOnJobSTDistanceAllowed>1.1</AllowWorkBaseOnJobSTDistanceAllowed>
<PayUnplannedSlots>true</PayUnplannedSlots>
<PeriodSlotTypeContainerId>00000000-0000-0000-0000-000000000000</PeriodSlotTypeContainerId>
<PeriodStart1>string</PeriodStart1>
<PeriodEnd1>string</PeriodEnd1>
<PeriodStart2>string</PeriodStart2>
<PeriodEnd2>string</PeriodEnd2>
<PeriodStart3>string</PeriodStart3>
<PeriodEnd3>string</PeriodEnd3>
<PeriodStart4>string</PeriodStart4>
<PeriodEnd4>string</PeriodEnd4>
<SlotSwapType>0</SlotSwapType>
<MoveOutsidePeripheralKey>00000000-0000-0000-0000-000000000000</MoveOutsidePeripheralKey>
<JobMandatory>true</JobMandatory>
<HideUnallocatedRow>true</HideUnallocatedRow>
<ApplyDefaultData>true</ApplyDefaultData>
<ShowOriginalJobIfMismatchOnShiftPattern>true</ShowOriginalJobIfMismatchOnShiftPattern>
<ShowOriginalShiftIfMismatchOnShiftPattern>true</ShowOriginalShiftIfMismatchOnShiftPattern>
<AutoCreateTaskChunks>true</AutoCreateTaskChunks>
<AutoCreateTaskChunksSlotTypeContainerId>00000000-0000-0000-0000-000000000000</AutoCreateTaskChunksSlotTypeContainerId>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey path
string startDate query date-time endRange query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* JOBS
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/JOBS/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type jobMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
JobMessageDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
Name (string, optional),
CustomTypeId (integer, optional),
Status (boolean, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CustomTypeId": 0,
"Status": true
}
<?xml version="1.0"?>
<JobMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<Name>string</Name>
<CustomTypeId>1</CustomTypeId>
<Status>true</Status>
</JobMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* KIOSK
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/SELFSERVICES/APP/KIOSK
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type userNameInputDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SelfServiceUserNameInputDto {
UserName (string, optional),
VersionNumber (string, optional)
}
{
"UserName": "string",
"VersionNumber": "string"
}
<?xml version="1.0"?>
<SelfServiceUserNameInputDto>
<UserName>string</UserName>
<VersionNumber>string</VersionNumber>
</SelfServiceUserNameInputDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* LOG
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/LOG
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type logDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
LogDto {
Message (string, optional)
}
{
"Message": "string"
}
<?xml version="1.0"?>
<LogDto>
<Message>string</Message>
</LogDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MERGE
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/MERGE/ADDSWIPE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
OkResult {
Request (object, optional, read only)
}
{
"Request": {}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type swipeEvent
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SwipeEventDto {
EventDateTime (string, optional),
OrganisationId (string, optional),
ConnectorId (string, optional),
PeripheralId (string, optional),
IdNumber (string, optional),
SwipeEventId (string, optional),
SlotId (integer, optional),
Direction (integer, optional)
}
{
"EventDateTime": "2024-11-07T02:04:38.837Z",
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"PeripheralId": "string",
"IdNumber": "string",
"SwipeEventId": "string",
"SlotId": 0,
"Direction": 0
}
<?xml version="1.0"?>
<SwipeEventDto>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<PeripheralId>string</PeripheralId>
<IdNumber>string</IdNumber>
<SwipeEventId>string</SwipeEventId>
<SlotId>1</SlotId>
<Direction>1</Direction>
</SwipeEventDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MERGE/PROCESSSWIPES
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type swipe
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
MergeMessageDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
EventDateTime (string, optional),
Direction (integer, optional),
GroupId (string, optional),
JobKey (string, optional),
Latitude (number, optional),
Longitude (number, optional),
PersonKey (string, optional),
PersonId (string, optional),
PeripheralId (string, optional),
PeripheralKey (string, optional),
EventId (string, optional),
CredentialId (string, optional),
UserId (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.842Z",
"Direction": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"JobKey": "00000000-0000-0000-0000-000000000000",
"Latitude": 0,
"Longitude": 0,
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonId": "string",
"PeripheralId": "string",
"PeripheralKey": "string",
"EventId": "string",
"CredentialId": "string",
"UserId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0"?>
<MergeMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<Direction>1</Direction>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonId>string</PersonId>
<PeripheralId>string</PeripheralId>
<PeripheralKey>string</PeripheralKey>
<EventId>string</EventId>
<CredentialId>string</CredentialId>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
</MergeMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MERGE/PROCESSINPUTEVENTS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type inputEvent
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
InputEventMessageDto {
OrganisationGuid (string, optional),
ConnectorId (string, optional),
ConnectorInputId (string, optional),
TriggerDateTime (string, optional)
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"ConnectorInputId": "string",
"TriggerDateTime": "2024-11-07T02:04:38.845Z"
}
<?xml version="1.0"?>
<InputEventMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<ConnectorInputId>string</ConnectorInputId>
<TriggerDateTime>1970-01-01T00:00:00.001Z</TriggerDateTime>
</InputEventMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MERGE/ADDEXTENDEDSWIPE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
OkResult {
Request (object, optional, read only)
}
{
"Request": {}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type swipeExtendedEvent
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SwipeExtendedEventDto {
EventDateTime (string, optional),
OrganisationId (string, optional),
PersonKey (string, optional),
GroupId (string, optional),
JobKey (string, optional),
Direction (integer, optional) = ['1', '2']
integerEnum:1, 2
,
Longitude (number, optional),
Latitude (number, optional)
}
{
"EventDateTime": "2024-11-07T02:04:38.847Z",
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"GroupId": "00000000-0000-0000-0000-000000000000",
"JobKey": "00000000-0000-0000-0000-000000000000",
"Direction": 1,
"Longitude": 0,
"Latitude": 0
}
<?xml version="1.0"?>
<SwipeExtendedEventDto>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<Direction>1</Direction>
<Longitude>1.1</Longitude>
<Latitude>1.1</Latitude>
</SwipeExtendedEventDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MERGE/ATTACHROUNDSWIPES
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/V2/MERGE/ATTACHROUNDSWIPES
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
attachAndRoundSwipeDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
AttachAndRoundSwipeDto {
ProcessSwipeMergeRunIntervalHoursRange (integer, optional)
}
{
"ProcessSwipeMergeRunIntervalHoursRange": 0
}
<?xml version="1.0"?>
<AttachAndRoundSwipeDto>
<ProcessSwipeMergeRunIntervalHoursRange>1</ProcessSwipeMergeRunIntervalHoursRange>
</AttachAndRoundSwipeDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MUSTERD
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/MUSTERD/USERINFO
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
ZoneStatuses (Array[ZoneStatusDto], optional),
Groups (Array[GroupsFilterDto], optional),
Sites (Array[SitesDto], optional),
Permissions (PermissionDto, optional)
}
ZoneStatusDto {
StatusId (integer, optional),
Name (string, optional),
Sort (integer, optional),
Icon (string, optional),
Colour (string, optional),
DefaultUncleared (boolean, optional),
DefaultCleared (boolean, optional)
}
GroupsFilterDto {
GroupId (string, optional),
GroupName (string, optional)
}
SitesDto {
ParentKey (string, optional),
SiteKey (string, optional),
SitePath (string, optional),
SiteName (string, optional),
Zones (Array[ZoneDto], optional),
Peripherals (Array[string], optional),
MusterPoints (Array[MusterPointDto], optional),
IncludeScannedZonesSeconds (integer, optional)
}
PermissionDto {
RollCall (boolean, optional),
SweepClear (boolean, optional),
MakeSafeManual (boolean, optional),
MakeSafeQRCode (boolean, optional),
MakeSafeNFC (boolean, optional),
MakeSafeExtReader (boolean, optional),
SetZoneStatusManual (boolean, optional),
SetZoneStatusQRCode (boolean, optional),
ForceBiometrics (boolean, optional),
SeeReport (boolean, optional),
ViewPeoplePage (boolean, optional),
SeeLogs (boolean, optional),
CanStartEvac (boolean, optional),
CanEndEvac (boolean, optional),
CanSeePeopleInfo (boolean, optional),
CanSeeMap (boolean, optional),
SendUserGeoLocation (boolean, optional),
SendSMS (boolean, optional),
ScanZoneOutsideEvacuation (boolean, optional),
CanAddTokens (boolean, optional)
}
ZoneDto {
ZoneKey (string, optional),
ZoneName (string, optional),
Latitude (number, optional),
Longitude (number, optional)
}
MusterPointDto {
MusterPointKey (string, optional),
MusterPointName (string, optional),
TokenReverse (integer, optional),
TokenCharactersToKeep (integer, optional),
RemoveLeadingZeros (boolean, optional)
}
[
{
"ZoneStatuses": [
{
"StatusId": 0,
"Name": "string",
"Sort": 0,
"Icon": "string",
"Colour": "string",
"DefaultUncleared": true,
"DefaultCleared": true
}
],
"Groups": [
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string"
}
],
"Sites": [
{
"ParentKey": "00000000-0000-0000-0000-000000000000",
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"SiteName": "string",
"Zones": [
{
"ZoneKey": "00000000-0000-0000-0000-000000000000",
"ZoneName": "string",
"Latitude": 0,
"Longitude": 0
}
],
"Peripherals": [
"00000000-0000-0000-0000-000000000000"
],
"MusterPoints": [
{
"MusterPointKey": "00000000-0000-0000-0000-000000000000",
"MusterPointName": "string",
"TokenReverse": 0,
"TokenCharactersToKeep": 0,
"RemoveLeadingZeros": true
}
],
"IncludeScannedZonesSeconds": 0
}
],
"Permissions": {
"RollCall": true,
"SweepClear": true,
"MakeSafeManual": true,
"MakeSafeQRCode": true,
"MakeSafeNFC": true,
"MakeSafeExtReader": true,
"SetZoneStatusManual": true,
"SetZoneStatusQRCode": true,
"ForceBiometrics": true,
"SeeReport": true,
"ViewPeoplePage": true,
"SeeLogs": true,
"CanStartEvac": true,
"CanEndEvac": true,
"CanSeePeopleInfo": true,
"CanSeeMap": true,
"SendUserGeoLocation": true,
"SendSMS": true,
"ScanZoneOutsideEvacuation": true,
"CanAddTokens": true
}
}
]
<?xml version="1.0"?>
<Inline Model>
<ZoneStatuses>
<StatusId>1</StatusId>
<Name>string</Name>
<Sort>1</Sort>
<Icon>string</Icon>
<Colour>string</Colour>
<DefaultUncleared>true</DefaultUncleared>
<DefaultCleared>true</DefaultCleared>
</ZoneStatuses>
<Groups>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
</Groups>
<Sites>
<ParentKey>00000000-0000-0000-0000-000000000000</ParentKey>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<SiteName>string</SiteName>
<Zones>
<ZoneKey>00000000-0000-0000-0000-000000000000</ZoneKey>
<ZoneName>string</ZoneName>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
</Zones>
<Peripherals>00000000-0000-0000-0000-000000000000</Peripherals>
<MusterPoints>
<MusterPointKey>00000000-0000-0000-0000-000000000000</MusterPointKey>
<MusterPointName>string</MusterPointName>
<TokenReverse>1</TokenReverse>
<TokenCharactersToKeep>1</TokenCharactersToKeep>
<RemoveLeadingZeros>true</RemoveLeadingZeros>
</MusterPoints>
<IncludeScannedZonesSeconds>1</IncludeScannedZonesSeconds>
</Sites>
<Permissions>
<RollCall>true</RollCall>
<SweepClear>true</SweepClear>
<MakeSafeManual>true</MakeSafeManual>
<MakeSafeQRCode>true</MakeSafeQRCode>
<MakeSafeNFC>true</MakeSafeNFC>
<MakeSafeExtReader>true</MakeSafeExtReader>
<SetZoneStatusManual>true</SetZoneStatusManual>
<SetZoneStatusQRCode>true</SetZoneStatusQRCode>
<ForceBiometrics>true</ForceBiometrics>
<SeeReport>true</SeeReport>
<ViewPeoplePage>true</ViewPeoplePage>
<SeeLogs>true</SeeLogs>
<CanStartEvac>true</CanStartEvac>
<CanEndEvac>true</CanEndEvac>
<CanSeePeopleInfo>true</CanSeePeopleInfo>
<CanSeeMap>true</CanSeeMap>
<SendUserGeoLocation>true</SendUserGeoLocation>
<SendSMS>true</SendSMS>
<ScanZoneOutsideEvacuation>true</ScanZoneOutsideEvacuation>
<CanAddTokens>true</CanAddTokens>
</Permissions>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/MUSTERD/ROLLCALL/PEOPLE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
PeopleRollCallDto {
People (Array[MusterdPeopleDto], optional),
ServerTime (string, optional)
}
MusterdPeopleDto {
PersonKey (string, optional),
FirstName (string, optional),
MiddleName (string, optional),
LastName (string, optional),
Disability (boolean, optional),
DisabilityDescription (string, optional),
Groups (Array[string], optional),
DefaultGroup (string, optional),
Swipe (SwipesDto, optional),
Tokens (Array[string], optional),
ContactInformation (ContactInformationDto, optional)
}
SwipesDto {
EventDateTime (string, optional),
PeripheralKey (string, optional),
PeripheralName (string, optional),
OnSiteDirection (integer, optional),
IsSafe (boolean, optional)
}
ContactInformationDto {
Telephone1 (string, optional),
Telephone2 (string, optional),
Telephone3 (string, optional),
EmergencyContacts (Array[EmergencyContactInformationDto], optional)
}
EmergencyContactInformationDto {
ContactName (string, optional),
Relationship (string, optional),
Telephone1 (string, optional),
Telephone2 (string, optional),
Telephone3 (string, optional)
}
{
"People": [
{
"PersonKey": "00000000-0000-0000-0000-000000000000",
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"Disability": true,
"DisabilityDescription": "string",
"Groups": [
"string"
],
"DefaultGroup": "string",
"Swipe": {
"EventDateTime": "2024-11-07T02:04:38.856Z",
"PeripheralKey": "00000000-0000-0000-0000-000000000000",
"PeripheralName": "string",
"OnSiteDirection": 0,
"IsSafe": true
},
"Tokens": [
"string"
],
"ContactInformation": {
"Telephone1": "string",
"Telephone2": "string",
"Telephone3": "string",
"EmergencyContacts": [
{
"ContactName": "string",
"Relationship": "string",
"Telephone1": "string",
"Telephone2": "string",
"Telephone3": "string"
}
]
}
}
],
"ServerTime": "2024-11-07T02:04:38.856Z"
}
<?xml version="1.0"?>
<PeopleRollCallDto>
<People>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<LastName>string</LastName>
<Disability>true</Disability>
<DisabilityDescription>string</DisabilityDescription>
<Groups>string</Groups>
<DefaultGroup>string</DefaultGroup>
<Swipe>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<PeripheralKey>00000000-0000-0000-0000-000000000000</PeripheralKey>
<PeripheralName>string</PeripheralName>
<OnSiteDirection>1</OnSiteDirection>
<IsSafe>true</IsSafe>
</Swipe>
<Tokens>string</Tokens>
<ContactInformation>
<Telephone1>string</Telephone1>
<Telephone2>string</Telephone2>
<Telephone3>string</Telephone3>
<EmergencyContacts>
<ContactName>string</ContactName>
<Relationship>string</Relationship>
<Telephone1>string</Telephone1>
<Telephone2>string</Telephone2>
<Telephone3>string</Telephone3>
</EmergencyContacts>
</ContactInformation>
</People>
<ServerTime>1970-01-01T00:00:00.001Z</ServerTime>
</PeopleRollCallDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type serverDateTime query
date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/MUSTERD/EVACUATIONINFORMATION
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
EvacuationInformationDto {
EvacuationKey (string, optional),
StartDate (string, optional),
EndDate (string, optional),
StartUserId (string, optional),
StartPersonKey (string, optional),
StartPersonName (string, optional),
EndUserId (string, optional),
EndPersonKey (string, optional),
EndPersonName (string, optional),
Sites (Array[EvacuationSiteDto], optional),
LastEvacuation (LastEvacuationDto, optional)
}
EvacuationSiteDto {
SiteKey (string, optional),
SitePath (string, optional),
SiteName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
StartUserId (string, optional),
StartPersonKey (string, optional),
StartPersonName (string, optional),
EndUserId (string, optional),
EndPersonKey (string, optional),
EndPersonName (string, optional),
Zones (Array[EvacuationZoneDto], optional)
}
LastEvacuationDto {
Sites (Array[LastEvacuationSitesDto], optional),
Zones (Array[LastEvacuationZonesDto], optional),
People (Array[LastEvacuationPeopleDto], optional)
}
EvacuationZoneDto {
ZoneKey (string, optional),
ZoneName (string, optional),
StatusDate (string, optional),
StatusId (integer, optional),
StatusName (string, optional),
UserId (string, optional),
UserName (string, optional),
Latitude (number, optional),
Longitude (number, optional)
}
LastEvacuationSitesDto {
SiteKey (string, optional),
SitePath (string, optional),
SiteName (string, optional),
StartDate (string, optional),
EndDate (string, optional)
}
LastEvacuationZonesDto {
SiteKey (string, optional),
SitePath (string, optional),
ZoneKey (string, optional),
ZoneName (string, optional),
StatusDate (string, optional),
StatusId (integer, optional),
UserId (string, optional),
UserName (string, optional)
}
LastEvacuationPeopleDto {
SiteKey (string, optional),
SitePath (string, optional),
PersonKey (string, optional),
PersonName (string, optional),
Disability (boolean, optional),
DisabilityDescription (string, optional),
DefaultGroup (string, optional),
Swipe (LastEvacuationPeopleSwipesDto, optional),
ContactInformation (ContactInformationDto, optional)
}
LastEvacuationPeopleSwipesDto {
EventDateTime (string, optional),
PeripheralName (string, optional),
IsSafe (boolean, optional)
}
ContactInformationDto {
Telephone1 (string, optional),
Telephone2 (string, optional),
Telephone3 (string, optional),
EmergencyContacts (Array[EmergencyContactInformationDto], optional)
}
EmergencyContactInformationDto {
ContactName (string, optional),
Relationship (string, optional),
Telephone1 (string, optional),
Telephone2 (string, optional),
Telephone3 (string, optional)
}
{
"EvacuationKey": "00000000-0000-0000-0000-000000000000",
"StartDate": "2024-11-07T02:04:38.863Z",
"EndDate": "2024-11-07T02:04:38.863Z",
"StartUserId": "00000000-0000-0000-0000-000000000000",
"StartPersonKey": "00000000-0000-0000-0000-000000000000",
"StartPersonName": "string",
"EndUserId": "00000000-0000-0000-0000-000000000000",
"EndPersonKey": "00000000-0000-0000-0000-000000000000",
"EndPersonName": "string",
"Sites": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"SiteName": "string",
"StartDate": "2024-11-07T02:04:38.863Z",
"EndDate": "2024-11-07T02:04:38.863Z",
"StartUserId": "00000000-0000-0000-0000-000000000000",
"StartPersonKey": "00000000-0000-0000-0000-000000000000",
"StartPersonName": "string",
"EndUserId": "00000000-0000-0000-0000-000000000000",
"EndPersonKey": "00000000-0000-0000-0000-000000000000",
"EndPersonName": "string",
"Zones": [
{
"ZoneKey": "00000000-0000-0000-0000-000000000000",
"ZoneName": "string",
"StatusDate": "2024-11-07T02:04:38.863Z",
"StatusId": 0,
"StatusName": "string",
"UserId": "00000000-0000-0000-0000-000000000000",
"UserName": "string",
"Latitude": 0,
"Longitude": 0
}
]
}
],
"LastEvacuation": {
"Sites": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"SiteName": "string",
"StartDate": "2024-11-07T02:04:38.863Z",
"EndDate": "2024-11-07T02:04:38.863Z"
}
],
"Zones": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"ZoneKey": "00000000-0000-0000-0000-000000000000",
"ZoneName": "string",
"StatusDate": "2024-11-07T02:04:38.863Z",
"StatusId": 0,
"UserId": "00000000-0000-0000-0000-000000000000",
"UserName": "string"
}
],
"People": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonName": "string",
"Disability": true,
"DisabilityDescription": "string",
"DefaultGroup": "string",
"Swipe": {
"EventDateTime": "2024-11-07T02:04:38.863Z",
"PeripheralName": "string",
"IsSafe": true
},
"ContactInformation": {
"Telephone1": "string",
"Telephone2": "string",
"Telephone3": "string",
"EmergencyContacts": [
{
"ContactName": "string",
"Relationship": "string",
"Telephone1": "string",
"Telephone2": "string",
"Telephone3": "string"
}
]
}
}
]
}
}
<?xml version="1.0"?>
<EvacuationInformationDto>
<EvacuationKey>00000000-0000-0000-0000-000000000000</EvacuationKey>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<StartUserId>00000000-0000-0000-0000-000000000000</StartUserId>
<StartPersonKey>00000000-0000-0000-0000-000000000000</StartPersonKey>
<StartPersonName>string</StartPersonName>
<EndUserId>00000000-0000-0000-0000-000000000000</EndUserId>
<EndPersonKey>00000000-0000-0000-0000-000000000000</EndPersonKey>
<EndPersonName>string</EndPersonName>
<Sites>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<SiteName>string</SiteName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<StartUserId>00000000-0000-0000-0000-000000000000</StartUserId>
<StartPersonKey>00000000-0000-0000-0000-000000000000</StartPersonKey>
<StartPersonName>string</StartPersonName>
<EndUserId>00000000-0000-0000-0000-000000000000</EndUserId>
<EndPersonKey>00000000-0000-0000-0000-000000000000</EndPersonKey>
<EndPersonName>string</EndPersonName>
<Zones>
<ZoneKey>00000000-0000-0000-0000-000000000000</ZoneKey>
<ZoneName>string</ZoneName>
<StatusDate>1970-01-01T00:00:00.001Z</StatusDate>
<StatusId>1</StatusId>
<StatusName>string</StatusName>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>string</UserName>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
</Zones>
</Sites>
<LastEvacuation>
<Sites>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<SiteName>string</SiteName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</Sites>
<Zones>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<ZoneKey>00000000-0000-0000-0000-000000000000</ZoneKey>
<ZoneName>string</ZoneName>
<StatusDate>1970-01-01T00:00:00.001Z</StatusDate>
<StatusId>1</StatusId>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>string</UserName>
</Zones>
<People>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonName>string</PersonName>
<Disability>true</Disability>
<DisabilityDescription>string</DisabilityDescription>
<DefaultGroup>string</DefaultGroup>
<Swipe>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<PeripheralName>string</PeripheralName>
<IsSafe>true</IsSafe>
</Swipe>
<ContactInformation>
<Telephone1>string</Telephone1>
<Telephone2>string</Telephone2>
<Telephone3>string</Telephone3>
<EmergencyContacts>
<ContactName>string</ContactName>
<Relationship>string</Relationship>
<Telephone1>string</Telephone1>
<Telephone2>string</Telephone2>
<Telephone3>string</Telephone3>
</EmergencyContacts>
</ContactInformation>
</People>
</LastEvacuation>
</EvacuationInformationDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type evacuationKey query
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MUSTERD/MANAGEEVACUATION
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
EvacuationInformationDto {
EvacuationKey (string, optional),
StartDate (string, optional),
EndDate (string, optional),
StartUserId (string, optional),
StartPersonKey (string, optional),
StartPersonName (string, optional),
EndUserId (string, optional),
EndPersonKey (string, optional),
EndPersonName (string, optional),
Sites (Array[EvacuationSiteDto], optional),
LastEvacuation (LastEvacuationDto, optional)
}
EvacuationSiteDto {
SiteKey (string, optional),
SitePath (string, optional),
SiteName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
StartUserId (string, optional),
StartPersonKey (string, optional),
StartPersonName (string, optional),
EndUserId (string, optional),
EndPersonKey (string, optional),
EndPersonName (string, optional),
Zones (Array[EvacuationZoneDto], optional)
}
LastEvacuationDto {
Sites (Array[LastEvacuationSitesDto], optional),
Zones (Array[LastEvacuationZonesDto], optional),
People (Array[LastEvacuationPeopleDto], optional)
}
EvacuationZoneDto {
ZoneKey (string, optional),
ZoneName (string, optional),
StatusDate (string, optional),
StatusId (integer, optional),
StatusName (string, optional),
UserId (string, optional),
UserName (string, optional),
Latitude (number, optional),
Longitude (number, optional)
}
LastEvacuationSitesDto {
SiteKey (string, optional),
SitePath (string, optional),
SiteName (string, optional),
StartDate (string, optional),
EndDate (string, optional)
}
LastEvacuationZonesDto {
SiteKey (string, optional),
SitePath (string, optional),
ZoneKey (string, optional),
ZoneName (string, optional),
StatusDate (string, optional),
StatusId (integer, optional),
UserId (string, optional),
UserName (string, optional)
}
LastEvacuationPeopleDto {
SiteKey (string, optional),
SitePath (string, optional),
PersonKey (string, optional),
PersonName (string, optional),
Disability (boolean, optional),
DisabilityDescription (string, optional),
DefaultGroup (string, optional),
Swipe (LastEvacuationPeopleSwipesDto, optional),
ContactInformation (ContactInformationDto, optional)
}
LastEvacuationPeopleSwipesDto {
EventDateTime (string, optional),
PeripheralName (string, optional),
IsSafe (boolean, optional)
}
ContactInformationDto {
Telephone1 (string, optional),
Telephone2 (string, optional),
Telephone3 (string, optional),
EmergencyContacts (Array[EmergencyContactInformationDto], optional)
}
EmergencyContactInformationDto {
ContactName (string, optional),
Relationship (string, optional),
Telephone1 (string, optional),
Telephone2 (string, optional),
Telephone3 (string, optional)
}
{
"EvacuationKey": "00000000-0000-0000-0000-000000000000",
"StartDate": "2024-11-07T02:04:38.867Z",
"EndDate": "2024-11-07T02:04:38.867Z",
"StartUserId": "00000000-0000-0000-0000-000000000000",
"StartPersonKey": "00000000-0000-0000-0000-000000000000",
"StartPersonName": "string",
"EndUserId": "00000000-0000-0000-0000-000000000000",
"EndPersonKey": "00000000-0000-0000-0000-000000000000",
"EndPersonName": "string",
"Sites": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"SiteName": "string",
"StartDate": "2024-11-07T02:04:38.867Z",
"EndDate": "2024-11-07T02:04:38.867Z",
"StartUserId": "00000000-0000-0000-0000-000000000000",
"StartPersonKey": "00000000-0000-0000-0000-000000000000",
"StartPersonName": "string",
"EndUserId": "00000000-0000-0000-0000-000000000000",
"EndPersonKey": "00000000-0000-0000-0000-000000000000",
"EndPersonName": "string",
"Zones": [
{
"ZoneKey": "00000000-0000-0000-0000-000000000000",
"ZoneName": "string",
"StatusDate": "2024-11-07T02:04:38.867Z",
"StatusId": 0,
"StatusName": "string",
"UserId": "00000000-0000-0000-0000-000000000000",
"UserName": "string",
"Latitude": 0,
"Longitude": 0
}
]
}
],
"LastEvacuation": {
"Sites": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"SiteName": "string",
"StartDate": "2024-11-07T02:04:38.867Z",
"EndDate": "2024-11-07T02:04:38.867Z"
}
],
"Zones": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"ZoneKey": "00000000-0000-0000-0000-000000000000",
"ZoneName": "string",
"StatusDate": "2024-11-07T02:04:38.867Z",
"StatusId": 0,
"UserId": "00000000-0000-0000-0000-000000000000",
"UserName": "string"
}
],
"People": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"SitePath": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonName": "string",
"Disability": true,
"DisabilityDescription": "string",
"DefaultGroup": "string",
"Swipe": {
"EventDateTime": "2024-11-07T02:04:38.868Z",
"PeripheralName": "string",
"IsSafe": true
},
"ContactInformation": {
"Telephone1": "string",
"Telephone2": "string",
"Telephone3": "string",
"EmergencyContacts": [
{
"ContactName": "string",
"Relationship": "string",
"Telephone1": "string",
"Telephone2": "string",
"Telephone3": "string"
}
]
}
}
]
}
}
<?xml version="1.0"?>
<EvacuationInformationDto>
<EvacuationKey>00000000-0000-0000-0000-000000000000</EvacuationKey>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<StartUserId>00000000-0000-0000-0000-000000000000</StartUserId>
<StartPersonKey>00000000-0000-0000-0000-000000000000</StartPersonKey>
<StartPersonName>string</StartPersonName>
<EndUserId>00000000-0000-0000-0000-000000000000</EndUserId>
<EndPersonKey>00000000-0000-0000-0000-000000000000</EndPersonKey>
<EndPersonName>string</EndPersonName>
<Sites>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<SiteName>string</SiteName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<StartUserId>00000000-0000-0000-0000-000000000000</StartUserId>
<StartPersonKey>00000000-0000-0000-0000-000000000000</StartPersonKey>
<StartPersonName>string</StartPersonName>
<EndUserId>00000000-0000-0000-0000-000000000000</EndUserId>
<EndPersonKey>00000000-0000-0000-0000-000000000000</EndPersonKey>
<EndPersonName>string</EndPersonName>
<Zones>
<ZoneKey>00000000-0000-0000-0000-000000000000</ZoneKey>
<ZoneName>string</ZoneName>
<StatusDate>1970-01-01T00:00:00.001Z</StatusDate>
<StatusId>1</StatusId>
<StatusName>string</StatusName>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>string</UserName>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
</Zones>
</Sites>
<LastEvacuation>
<Sites>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<SiteName>string</SiteName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</Sites>
<Zones>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<ZoneKey>00000000-0000-0000-0000-000000000000</ZoneKey>
<ZoneName>string</ZoneName>
<StatusDate>1970-01-01T00:00:00.001Z</StatusDate>
<StatusId>1</StatusId>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>string</UserName>
</Zones>
<People>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<SitePath>string</SitePath>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonName>string</PersonName>
<Disability>true</Disability>
<DisabilityDescription>string</DisabilityDescription>
<DefaultGroup>string</DefaultGroup>
<Swipe>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<PeripheralName>string</PeripheralName>
<IsSafe>true</IsSafe>
</Swipe>
<ContactInformation>
<Telephone1>string</Telephone1>
<Telephone2>string</Telephone2>
<Telephone3>string</Telephone3>
<EmergencyContacts>
<ContactName>string</ContactName>
<Relationship>string</Relationship>
<Telephone1>string</Telephone1>
<Telephone2>string</Telephone2>
<Telephone3>string</Telephone3>
</EmergencyContacts>
</ContactInformation>
</People>
</LastEvacuation>
</EvacuationInformationDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ManageEvacuationDto {
SitesJson (Array[EvacuationSitesPostDto], optional),
ZonesJson (Array[EvacuationZonesPostDto], optional),
SendNotification (boolean, optional)
}
EvacuationSitesPostDto {
SiteKey (string, optional),
EventDateTime (string, optional),
Mode (integer, optional)
}
EvacuationZonesPostDto {
SiteKey (string, optional),
ZoneKey (string, optional),
EventDateTime (string, optional),
Status (integer, optional)
}
{
"SitesJson": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.872Z",
"Mode": 0
}
],
"ZonesJson": [
{
"SiteKey": "00000000-0000-0000-0000-000000000000",
"ZoneKey": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.872Z",
"Status": 0
}
],
"SendNotification": true
}
<?xml version="1.0"?>
<ManageEvacuationDto>
<SitesJson>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<Mode>1</Mode>
</SitesJson>
<ZonesJson>
<SiteKey>00000000-0000-0000-0000-000000000000</SiteKey>
<ZoneKey>00000000-0000-0000-0000-000000000000</ZoneKey>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<Status>1</Status>
</ZonesJson>
<SendNotification>true</SendNotification>
</ManageEvacuationDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/MUSTERD/USER/GETLOCATIONS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
LocationReturnDto {
ServerDateTime (string, optional),
Locations (Array[LocationDto], optional)
}
LocationDto {
UserId (string, optional),
UserName (string, optional),
Latitude (number, optional),
Longitude (number, optional)
}
{
"ServerDateTime": "2024-11-07T02:04:38.874Z",
"Locations": [
{
"UserId": "00000000-0000-0000-0000-000000000000",
"UserName": "string",
"Latitude": 0,
"Longitude": 0
}
]
}
<?xml version="1.0"?>
<LocationReturnDto>
<ServerDateTime>1970-01-01T00:00:00.001Z</ServerDateTime>
<Locations>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>string</UserName>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
</Locations>
</LocationReturnDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type serverDateTime query
date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/MUSTERD/USER/GETREPORTS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
MusterdReportListDto {
Reports (Array[MusterdReportDto], optional),
ServerDateTime (string, optional)
}
MusterdReportDto {
RowId (integer, optional),
ReportId (integer, optional),
Name (string, optional),
StartedDateTime (string, optional),
EndedDateTime (string, optional),
Report (string, optional)
}
{
"Reports": [
{
"RowId": 0,
"ReportId": 0,
"Name": "string",
"StartedDateTime": "2024-11-07T02:04:38.875Z",
"EndedDateTime": "2024-11-07T02:04:38.875Z",
"Report": "string"
}
],
"ServerDateTime": "string"
}
<?xml version="1.0"?>
<MusterdReportListDto>
<Reports>
<RowId>1</RowId>
<ReportId>1</ReportId>
<Name>string</Name>
<StartedDateTime>1970-01-01T00:00:00.001Z</StartedDateTime>
<EndedDateTime>1970-01-01T00:00:00.001Z</EndedDateTime>
<Report>string</Report>
</Reports>
<ServerDateTime>string</ServerDateTime>
</MusterdReportListDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type serverDateTime query
date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MUSTERD/USER/UPDATELOCATION
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
LocationReturnDto {
ServerDateTime (string, optional),
Locations (Array[LocationDto], optional)
}
LocationDto {
UserId (string, optional),
UserName (string, optional),
Latitude (number, optional),
Longitude (number, optional)
}
{
"ServerDateTime": "2024-11-07T02:04:38.877Z",
"Locations": [
{
"UserId": "00000000-0000-0000-0000-000000000000",
"UserName": "string",
"Latitude": 0,
"Longitude": 0
}
]
}
<?xml version="1.0"?>
<LocationReturnDto>
<ServerDateTime>1970-01-01T00:00:00.001Z</ServerDateTime>
<Locations>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<UserName>string</UserName>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
</Locations>
</LocationReturnDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
UserLocationDto {
Latitude (number, optional),
Longitude (number, optional),
DateTimeOffset (string, optional),
ServerDateTime (string, optional)
}
{
"Latitude": 0,
"Longitude": 0,
"DateTimeOffset": "2024-11-07T02:04:38.877Z",
"ServerDateTime": "2024-11-07T02:04:38.877Z"
}
<?xml version="1.0"?>
<UserLocationDto>
<Latitude>1.1</Latitude>
<Longitude>1.1</Longitude>
<DateTimeOffset>1970-01-01T00:00:00.001Z</DateTimeOffset>
<ServerDateTime>1970-01-01T00:00:00.001Z</ServerDateTime>
</UserLocationDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MUSTERD/USER/MAKEPERSONSAFE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
MusterdPostMakePersonSafeDto {
People (Array[MakePersonSafeDto], optional),
ServerDateTime (string, optional)
}
MakePersonSafeDto {
PersonKey (string, optional),
PersonToken (string, optional),
MusterPointKey (string, optional),
EventDateTime (string, optional),
MakeSafeOrUndoSafe (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
}
{
"People": [
{
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonToken": "string",
"MusterPointKey": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.879Z",
"MakeSafeOrUndoSafe": 0
}
],
"ServerDateTime": "2024-11-07T02:04:38.879Z"
}
<?xml version="1.0"?>
<MusterdPostMakePersonSafeDto>
<People>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonToken>string</PersonToken>
<MusterPointKey>00000000-0000-0000-0000-000000000000</MusterPointKey>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<MakeSafeOrUndoSafe>0</MakeSafeOrUndoSafe>
</People>
<ServerDateTime>1970-01-01T00:00:00.001Z</ServerDateTime>
</MusterdPostMakePersonSafeDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MUSTERD/NOTIFICATION/SENDNOTIFICATION
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
sendPushNotificationDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SendPushNotificationDto {
MobileAppType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
UserIds (Array[string], optional),
PersonKeys (Array[string], optional),
NotificationTitle (string, optional),
NotificationText (string, optional),
RotaOneSelfServiceAppRedirect (integer, optional) = ['0', '1', '2', '3',
'4', '5', '6', '7', '8', '9']
integerEnum:0, 1, 2, 3, 4, 5, 6, 7, 8, 9
,
OrganisationId (integer, optional),
SenderUserId (string, optional),
SystemGenerated (boolean, optional)
}
{
"MobileAppType": 0,
"UserIds": [
"string"
],
"PersonKeys": [
"00000000-0000-0000-0000-000000000000"
],
"NotificationTitle": "string",
"NotificationText": "string",
"RotaOneSelfServiceAppRedirect": 0,
"OrganisationId": 0,
"SenderUserId": "string",
"SystemGenerated": true
}
<?xml version="1.0"?>
<SendPushNotificationDto>
<MobileAppType>0</MobileAppType>
<UserIds>string</UserIds>
<PersonKeys>00000000-0000-0000-0000-000000000000</PersonKeys>
<NotificationTitle>string</NotificationTitle>
<NotificationText>string</NotificationText>
<RotaOneSelfServiceAppRedirect>0</RotaOneSelfServiceAppRedirect>
<OrganisationId>1</OrganisationId>
<SenderUserId>string</SenderUserId>
<SystemGenerated>true</SystemGenerated>
</SendPushNotificationDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MUSTERD/PERSON/APPLYTOKEN
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
applyPersonTokenRequestDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ApplyPersonTokenRequestDto {
PersonKey (string, optional),
Token (string, optional)
}
{
"PersonKey": "00000000-0000-0000-0000-000000000000",
"Token": "string"
}
<?xml version="1.0"?>
<ApplyPersonTokenRequestDto>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<Token>string</Token>
</ApplyPersonTokenRequestDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MUSTERDNOTIFICATION
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/NOTIFICATION/PERSON/SUBSCRIBE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
PersonRegisterInputDto {
SecureKey (string, optional),
TimeStamp (string, optional),
DeviceToken (string, optional),
DeviceTypeId (integer, optional) = ['1', '2']
integerEnum:1, 2
,
BundleId (string, optional),
DeviceId (string, optional)
}
{
"SecureKey": "string",
"TimeStamp": "2024-11-07T02:04:38.885Z",
"DeviceToken": "string",
"DeviceTypeId": 1,
"BundleId": "string",
"DeviceId": "string"
}
<?xml version="1.0"?>
<PersonRegisterInputDto>
<SecureKey>string</SecureKey>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<DeviceToken>string</DeviceToken>
<DeviceTypeId>1</DeviceTypeId>
<BundleId>string</BundleId>
<DeviceId>string</DeviceId>
</PersonRegisterInputDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/NOTIFICATION/PERSON/UNSUBSCRIBE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
PersonRegisterInputDto {
SecureKey (string, optional),
TimeStamp (string, optional),
DeviceToken (string, optional),
DeviceTypeId (integer, optional) = ['1', '2']
integerEnum:1, 2
,
BundleId (string, optional),
DeviceId (string, optional)
}
{
"SecureKey": "string",
"TimeStamp": "2024-11-07T02:04:38.887Z",
"DeviceToken": "string",
"DeviceTypeId": 1,
"BundleId": "string",
"DeviceId": "string"
}
<?xml version="1.0"?>
<PersonRegisterInputDto>
<SecureKey>string</SecureKey>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<DeviceToken>string</DeviceToken>
<DeviceTypeId>1</DeviceTypeId>
<BundleId>string</BundleId>
<DeviceId>string</DeviceId>
</PersonRegisterInputDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MUSTERDSMS
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/MUSTERD/SMS/UNSAFE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
SendSmsResponseDto {
Success (boolean, optional)
}
{
"Success": true
}
<?xml version="1.0"?>
<SendSmsResponseDto>
<Success>true</Success>
</SendSmsResponseDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type sendSmsRequestDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SendSmsRequestDto {
EvacuationKey (string, optional)
}
{
"EvacuationKey": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0"?>
<SendSmsRequestDto>
<EvacuationKey>00000000-0000-0000-0000-000000000000</EvacuationKey>
</SendSmsRequestDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MUSTERDSMSRECEIVE
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/MUSTERD/SMS/MAKEPERSONSAFE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type musterdSmsDetailDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
MusterdSmsDetailDto {
From (string, optional),
Body (string, optional),
To (string, optional),
Key (string, optional)
}
{
"From": "string",
"Body": "string",
"To": "string",
"Key": "string"
}
<?xml version="1.0"?>
<MusterdSmsDetailDto>
<From>string</From>
<Body>string</Body>
<To>string</To>
<Key>string</Key>
</MusterdSmsDetailDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MUSTERDUSER
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/MUSTERD/USERCONFIGURATION
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type userNameInputDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
MusterdUserNameInputDto {
UserName (string, optional)
}
{
"UserName": "string"
}
<?xml version="1.0"?>
<MusterdUserNameInputDto>
<UserName>string</UserName>
</MusterdUserNameInputDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/MUSTERD/USER/MAKEPERSONSAFE/IMSAFE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
MusterdPostImSafeDto {
Person (ImSafeDto, optional),
ServerDateTime (string, optional),
TimeStamp (string, optional)
}
ImSafeDto {
SecureKey (string, optional),
PersonToken (string, optional),
MusterPointKey (string, optional),
EventDateTime (string, optional),
MakeSafeOrUndoSafe (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
}
{
"Person": {
"SecureKey": "string",
"PersonToken": "string",
"MusterPointKey": "00000000-0000-0000-0000-000000000000",
"EventDateTime": "2024-11-07T02:04:38.900Z",
"MakeSafeOrUndoSafe": 0
},
"ServerDateTime": "2024-11-07T02:04:38.900Z",
"TimeStamp": "2024-11-07T02:04:38.900Z"
}
<?xml version="1.0"?>
<MusterdPostImSafeDto>
<Person>
<SecureKey>string</SecureKey>
<PersonToken>string</PersonToken>
<MusterPointKey>00000000-0000-0000-0000-000000000000</MusterPointKey>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<MakeSafeOrUndoSafe>0</MakeSafeOrUndoSafe>
</Person>
<ServerDateTime>1970-01-01T00:00:00.001Z</ServerDateTime>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
</MusterdPostImSafeDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* NOTIFICATION
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/NOTIFICATION/SUBSCRIBE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ResponseDto {
Messages (Array[MessageDto], optional),
Success (boolean, optional)
}
MessageDto {
Message (string, optional),
MessageType (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
}
{
"Messages": [
{
"Message": "string",
"MessageType": 1
}
],
"Success": true
}
<?xml version="1.0"?>
<ResponseDto>
<Messages>
<Message>string</Message>
<MessageType>1</MessageType>
</Messages>
<Success>true</Success>
</ResponseDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
RegisterDto {
DeviceToken (string, optional),
DeviceTypeId (integer, optional) = ['1', '2']
integerEnum:1, 2
,
BundleId (string, optional),
DeviceId (string, optional)
}
{
"DeviceToken": "string",
"DeviceTypeId": 1,
"BundleId": "string",
"DeviceId": "string"
}
<?xml version="1.0"?>
<RegisterDto>
<DeviceToken>string</DeviceToken>
<DeviceTypeId>1</DeviceTypeId>
<BundleId>string</BundleId>
<DeviceId>string</DeviceId>
</RegisterDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/NOTIFICATION/UNSUBSCRIBE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ResponseDto {
Messages (Array[MessageDto], optional),
Success (boolean, optional)
}
MessageDto {
Message (string, optional),
MessageType (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
}
{
"Messages": [
{
"Message": "string",
"MessageType": 1
}
],
"Success": true
}
<?xml version="1.0"?>
<ResponseDto>
<Messages>
<Message>string</Message>
<MessageType>1</MessageType>
</Messages>
<Success>true</Success>
</ResponseDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
RegisterDto {
DeviceToken (string, optional),
DeviceTypeId (integer, optional) = ['1', '2']
integerEnum:1, 2
,
BundleId (string, optional),
DeviceId (string, optional)
}
{
"DeviceToken": "string",
"DeviceTypeId": 1,
"BundleId": "string",
"DeviceId": "string"
}
<?xml version="1.0"?>
<RegisterDto>
<DeviceToken>string</DeviceToken>
<DeviceTypeId>1</DeviceTypeId>
<BundleId>string</BundleId>
<DeviceId>string</DeviceId>
</RegisterDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/NOTIFICATION/SEND
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
SendPushNotificationResponse {
NotificationResponse (inline_model_0, optional)
}
inline_model_0 {}
{
"NotificationResponse": {}
}
<?xml version="1.0"?>
<SendPushNotificationResponse>
<NotificationResponse>
<!-- additional elements allowed -->
</NotificationResponse>
</SendPushNotificationResponse>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SendPushNotificationsToAppDto {
DeviceTokens (Array[string], optional),
NotificationTitle (string, optional),
NotificationText (string, optional),
MobileAppType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
NotificationData (inline_model, optional)
}
inline_model {}
{
"DeviceTokens": [
"string"
],
"NotificationTitle": "string",
"NotificationText": "string",
"MobileAppType": 0,
"NotificationData": {}
}
<?xml version="1.0"?>
<SendPushNotificationsToAppDto>
<DeviceTokens>string</DeviceTokens>
<NotificationTitle>string</NotificationTitle>
<NotificationText>string</NotificationText>
<MobileAppType>0</MobileAppType>
<NotificationData>
<!-- additional elements allowed -->
</NotificationData>
</SendPushNotificationsToAppDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ORGANISATION
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/SELFSERVICES/ORGANISATIONSETTINGS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
OrganisationSettingsDto {
SettingsId (integer, optional),
OrganisationId (integer, optional),
OrganisationGuid (string, optional),
StartOfWeekId (integer, optional) = ['1', '2', '3', '4', '5', '6', '7']
integerEnum:1, 2, 3, 4, 5, 6, 7
,
MergeSwipesImmediately (boolean, optional),
KeepExceptionDays (integer, optional),
HistoryChangeDatePatternId (integer, optional),
DefaultUnavailable (boolean, optional),
ShowOnlyDaysForEntitlement (boolean, optional),
SelfServiceWorkingSlotTypeContainerId (string, optional),
SelfServiceWorkingSlotTypeColourHex (string, optional),
SelfServiceTimeOffSlotTypeContainerId (string, optional),
SelfServiceTimeOffSlotTypeColourHex (string, optional)
}
{
"SettingsId": 0,
"OrganisationId": 0,
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"StartOfWeekId": 1,
"MergeSwipesImmediately": true,
"KeepExceptionDays": 0,
"HistoryChangeDatePatternId": 0,
"DefaultUnavailable": true,
"ShowOnlyDaysForEntitlement": true,
"SelfServiceWorkingSlotTypeContainerId": "00000000-0000-0000-0000-000000000000",
"SelfServiceWorkingSlotTypeColourHex": "string",
"SelfServiceTimeOffSlotTypeContainerId": "00000000-0000-0000-0000-000000000000",
"SelfServiceTimeOffSlotTypeColourHex": "string"
}
<?xml version="1.0"?>
<OrganisationSettingsDto>
<SettingsId>1</SettingsId>
<OrganisationId>1</OrganisationId>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<StartOfWeekId>1</StartOfWeekId>
<MergeSwipesImmediately>true</MergeSwipesImmediately>
<KeepExceptionDays>1</KeepExceptionDays>
<HistoryChangeDatePatternId>1</HistoryChangeDatePatternId>
<DefaultUnavailable>true</DefaultUnavailable>
<ShowOnlyDaysForEntitlement>true</ShowOnlyDaysForEntitlement>
<SelfServiceWorkingSlotTypeContainerId>00000000-0000-0000-0000-000000000000</SelfServiceWorkingSlotTypeContainerId>
<SelfServiceWorkingSlotTypeColourHex>string</SelfServiceWorkingSlotTypeColourHex>
<SelfServiceTimeOffSlotTypeContainerId>00000000-0000-0000-0000-000000000000</SelfServiceTimeOffSlotTypeContainerId>
<SelfServiceTimeOffSlotTypeColourHex>string</SelfServiceTimeOffSlotTypeColourHex>
</OrganisationSettingsDto>
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PAYRATES
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/PAYRATES/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type payRateMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
PayRateMessageDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
PayRateId (string, optional),
Name (string, optional),
RateType (integer, optional) = ['1', '2', '3', '4', '5', '6', '7']
integerEnum:1, 2, 3, 4, 5, 6, 7
,
RateTypeValue (integer, optional),
Status (boolean, optional),
CustomTypeId (integer, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"PayRateId": "string",
"Name": "string",
"RateType": 1,
"RateTypeValue": 0,
"Status": true,
"CustomTypeId": 0
}
<?xml version="1.0"?>
<PayRateMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<PayRateId>string</PayRateId>
<Name>string</Name>
<RateType>1</RateType>
<RateTypeValue>1</RateTypeValue>
<Status>true</Status>
<CustomTypeId>1</CustomTypeId>
</PayRateMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/PAYRATES/GETUPDATEDBYCONNECTORGUID
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type OrganisationGuid
query string ConnectorGuid query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/PAYRATES/CHANGEHASUPDATEDSTATUS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type PayrateIds
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body Array[integer]
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/PAYRATES/UPDATEPAYRATECONNECTORID
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type payrateIdAttachments
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
UpdateConnectorPayrateIdAttachmentDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
PayrateId (string, optional),
PayrateConnectorId (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"PayrateId": "string",
"PayrateConnectorId": "string"
}
<?xml version="1.0"?>
<UpdateConnectorPayrateIdAttachmentDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<PayrateId>string</PayrateId>
<PayrateConnectorId>string</PayrateConnectorId>
</UpdateConnectorPayrateIdAttachmentDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PAYROLL
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/PAYROLL/GETCOMMANDS/{CONNECTORID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type ConnectorId path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SCRIPTS/GETCOMMANDS/{CONNECTORID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type ConnectorId path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/PAYROLL/GETPERSONSINCOMMAND/{COMMANDID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type CommandId path long
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/PAYROLL/GETPAYROLLDATABATCH
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type payrollMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
PayrollMessageDto {
PersonKeys (Array[string], optional),
CommandId (integer, optional)
}
{
"PersonKeys": [
"00000000-0000-0000-0000-000000000000"
],
"CommandId": 0
}
<?xml version="1.0"?>
<PayrollMessageDto>
<PersonKeys>00000000-0000-0000-0000-000000000000</PersonKeys>
<CommandId>1</CommandId>
</PayrollMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/PAYROLL/GETPAYROLLBATCH
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type payrollMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
PayrollBatchMessageDto {
PersonKeys (Array[string], optional),
CommandId (integer, optional)
}
{
"PersonKeys": [
"00000000-0000-0000-0000-000000000000"
],
"CommandId": 0
}
<?xml version="1.0"?>
<PayrollBatchMessageDto>
<PersonKeys>00000000-0000-0000-0000-000000000000</PersonKeys>
<CommandId>1</CommandId>
</PayrollBatchMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/PAYROLL/COMPLETEPAYROLLDOWNLOAD/{COMMANDID}
*
RESPONSE CLASS (STATUS 200)
boolean
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type commandId path long
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SCRIPTS/COMPLETESCRIPTCOMMAND/{COMMANDID}
*
RESPONSE CLASS (STATUS 200)
boolean
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type commandId path long
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PAYRULES
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/MERGE/PROCESSPAYRULES
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type organisationGuid
query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/V2/MERGE/PROCESSPAYRULES
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type processPayrulesDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ProcessPayRulesDto {
OrganisationGuid (string, optional),
ProcessPayrulesRunIntervalHoursRange (integer, optional),
ProcessSwipeMergeRunIntervalHoursRange (integer, optional)
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ProcessPayrulesRunIntervalHoursRange": 0,
"ProcessSwipeMergeRunIntervalHoursRange": 0
}
<?xml version="1.0"?>
<ProcessPayRulesDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ProcessPayrulesRunIntervalHoursRange>1</ProcessPayrulesRunIntervalHoursRange>
<ProcessSwipeMergeRunIntervalHoursRange>1</ProcessSwipeMergeRunIntervalHoursRange>
</ProcessPayRulesDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PEOPLE
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/PEOPLE/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
PersonMessageDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
IdNumber (string, optional),
Title (integer, optional),
FirstName (string, optional),
MiddleName (string, optional),
LastName (string, optional),
CustomTypeId (integer, optional),
Gender (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
,
DateOfBirth (string, optional),
StartDate (string, optional),
EndDate (string, optional),
ProbationEndDate (string, optional),
NINumber (string, optional),
PersonalEmail (string, optional),
WorkEmail (string, optional),
PayRates (Array[PersonPayRateMessageDto], optional),
Groups (Array[PersonGroupDto], optional),
Jobs (Array[PersonJobDto], optional),
Qualifications (Array[PersonQualificationDto], optional),
Tokens (Array[PersonTokenDto], optional),
Contact (Array[PersonContactMessageDto], optional)
}
PersonPayRateMessageDto {
PayrateId (string, optional),
PayRateName (string, optional),
PayRateValue (number, optional),
PayRatePermValue (number, optional),
StartDate (string, optional),
EndDate (string, optional)
}
PersonGroupDto {
GroupId (string, optional),
Name (string, optional),
StartDate (string, optional),
EndDate (string, optional)
}
PersonJobDto {
JobName (string, optional)
}
PersonQualificationDto {
QualificationId (string, optional),
QualificationName (string, optional)
}
PersonTokenDto {
Token (string, optional)
}
PersonContactMessageDto {
Telephone1 (string, optional),
Telephone2 (string, optional),
Telephone3 (string, optional),
AddressLine1 (string, optional),
AddressLine2 (string, optional),
AddressLine3 (string, optional),
AddressLine4 (string, optional),
Town (string, optional),
County (string, optional),
Postcode (string, optional),
Country (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"IdNumber": "string",
"Title": 0,
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"CustomTypeId": 0,
"Gender": 1,
"DateOfBirth": "2024-11-07T02:04:38.923Z",
"StartDate": "2024-11-07T02:04:38.923Z",
"EndDate": "2024-11-07T02:04:38.923Z",
"ProbationEndDate": "2024-11-07T02:04:38.923Z",
"NINumber": "string",
"PersonalEmail": "string",
"WorkEmail": "string",
"PayRates": [
{
"PayrateId": "string",
"PayRateName": "string",
"PayRateValue": 0,
"PayRatePermValue": 0,
"StartDate": "2024-11-07T02:04:38.923Z",
"EndDate": "2024-11-07T02:04:38.923Z"
}
],
"Groups": [
{
"GroupId": "string",
"Name": "string",
"StartDate": "2024-11-07T02:04:38.923Z",
"EndDate": "2024-11-07T02:04:38.923Z"
}
],
"Jobs": [
{
"JobName": "string"
}
],
"Qualifications": [
{
"QualificationId": "string",
"QualificationName": "string"
}
],
"Tokens": [
{
"Token": "string"
}
],
"Contact": [
{
"Telephone1": "string",
"Telephone2": "string",
"Telephone3": "string",
"AddressLine1": "string",
"AddressLine2": "string",
"AddressLine3": "string",
"AddressLine4": "string",
"Town": "string",
"County": "string",
"Postcode": "string",
"Country": "string"
}
]
}
<?xml version="1.0"?>
<PersonMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<IdNumber>string</IdNumber>
<Title>1</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<LastName>string</LastName>
<CustomTypeId>1</CustomTypeId>
<Gender>1</Gender>
<DateOfBirth>1970-01-01T00:00:00.001Z</DateOfBirth>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<ProbationEndDate>1970-01-01T00:00:00.001Z</ProbationEndDate>
<NINumber>string</NINumber>
<PersonalEmail>string</PersonalEmail>
<WorkEmail>string</WorkEmail>
<PayRates>
<PayrateId>string</PayrateId>
<PayRateName>string</PayRateName>
<PayRateValue>1.1</PayRateValue>
<PayRatePermValue>1.1</PayRatePermValue>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</PayRates>
<Groups>
<GroupId>string</GroupId>
<Name>string</Name>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</Groups>
<Jobs>
<JobName>string</JobName>
</Jobs>
<Qualifications>
<QualificationId>string</QualificationId>
<QualificationName>string</QualificationName>
</Qualifications>
<Tokens>
<Token>string</Token>
</Tokens>
<Contact>
<Telephone1>string</Telephone1>
<Telephone2>string</Telephone2>
<Telephone3>string</Telephone3>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<AddressLine3>string</AddressLine3>
<AddressLine4>string</AddressLine4>
<Town>string</Town>
<County>string</County>
<Postcode>string</Postcode>
<Country>string</Country>
</Contact>
</PersonMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/PEOPLE/GETUPDATEDBYCONNECTORGUID
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type organisationGuid
query string connectorGuid query string getExpiredGroupAttachments true
false query boolean
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/PEOPLE/CHANGEHASUPDATEDSTATUS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personIds
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body Array[integer] setUpdatedTime true false query boolean
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/PEOPLE/UPDATEPERSONCONNECTORID
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personIdAttachments
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
UpdateConnectorPersonIdAttachmentDto {
PersonId (string, optional),
PersonConnectorId (string, optional),
ConnectorId (string, optional),
OrganisationId (string, optional)
}
{
"PersonId": "string",
"PersonConnectorId": "string",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"OrganisationId": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0"?>
<UpdateConnectorPersonIdAttachmentDto>
<PersonId>string</PersonId>
<PersonConnectorId>string</PersonConnectorId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
</UpdateConnectorPersonIdAttachmentDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /API/PEOPLE/REMOVEPERSONGROUPATTACHMENT
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
personGroupAttachment
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
RemovePersonGroupAttachmentDto {
PersonId (integer, optional),
GroupKey (string, optional)
}
{
"PersonId": 0,
"GroupKey": "00000000-0000-0000-0000-000000000000"
}
<?xml version="1.0"?>
<RemovePersonGroupAttachmentDto>
<PersonId>1</PersonId>
<GroupKey>00000000-0000-0000-0000-000000000000</GroupKey>
</RemovePersonGroupAttachmentDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* QUALIFICATIONS
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/QUALIFICATIONS/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type qualificationMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
QualificationMessageDto {
OrganisationGuid (string, optional),
ConnectorId (string, optional),
QualificationId (string, optional),
QualificationName (string, optional),
QualificationStatus (boolean, optional)
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"QualificationId": "string",
"QualificationName": "string",
"QualificationStatus": true
}
<?xml version="1.0"?>
<QualificationMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<QualificationId>string</QualificationId>
<QualificationName>string</QualificationName>
<QualificationStatus>true</QualificationStatus>
</QualificationMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* REGISTRATION
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/SELFSERVICES/APP/USER/REGISTATION
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type userNameInputDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SelfServiceUserNameInputDto {
UserName (string, optional),
VersionNumber (string, optional)
}
{
"UserName": "string",
"VersionNumber": "string"
}
<?xml version="1.0"?>
<SelfServiceUserNameInputDto>
<UserName>string</UserName>
<VersionNumber>string</VersionNumber>
</SelfServiceUserNameInputDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* REPORTS
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/REPORTS/RUNSCHEDULE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type organisationId
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/REPORTS/RUNSCHEDULE/FUNCTIONAPP
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type organisationGuid
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ROTA
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/SELFSERVICES/SLOTS/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
OrganisationId (integer, optional),
SlotId (integer, optional),
GroupId (string, optional),
GroupName (string, optional),
JobMandatory (boolean, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
SlotTypeNoSwipesAllowed (boolean, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
JobKey (string, optional),
PersonKey (string, optional),
PersonDisplayName (string, optional),
PersonalSecurityStatusLevel (integer, optional) = ['1', '2', '3', '4',
'5', '6', '7', '8', '9', '10']
integerEnum:1, 2, 3, 4, 5, 6, 7, 8, 9, 10
,
JobName (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
ShiftRestDay (boolean, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
GamePoints (integer, optional),
SlotDate (integer, optional),
SlotDateAsDate (string, optional, read only),
DisplayDateStart (string, optional, read only),
DisplayDateEnd (string, optional, read only),
TotalPlannedSeconds (integer, optional),
TotalActualSeconds (integer, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
ShiftPatternHours (boolean, optional),
Published (boolean, optional),
PreviousPublished (boolean, optional),
NoBreaks (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
ActualStartLock (boolean, optional),
ActualEndLock (boolean, optional),
LieuStatus (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
ShiftPatternDeploymentId (integer, optional),
ShiftPatternName (string, optional),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayActualStartAndEndTimes (string, optional, read only),
BonusKeys (string, optional),
ProcessingTime (string, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
IsWorkingSlot (boolean, optional),
ColourHex (string, optional),
SwapRequested (boolean, optional),
SlotChunks (Array[SlotChunkDto], optional),
TaskChunks (Array[SlotTaskChunkDto], optional),
SlotTags (Array[SlotTagDto], optional),
SlotAdjustments (Array[SlotAdjustmentDto], optional),
SlotSwipes (Array[SlotSwipeDto], optional),
SlotNotes (Array[SlotNoteDto], optional),
SlotAudits (Array[SlotAuditDto], optional),
SelectedGameSlotBonuses (Array[GameSlotBonusDto], optional),
GameSlotBonuses (Array[GameBonusDto], optional),
SlotAdvertisement (GameSlotAdvertisementDto, optional),
SlotTypes (Array[OtherDataKeyValueDto], optional),
Persons (Array[OtherDataKeyValueDto], optional),
Groups (Array[OtherDataKeyValueDto], optional),
Shifts (Array[OtherDataKeyValueDto], optional),
Jobs (Array[OtherDataKeyValueDto], optional),
OnlyPayRates (Array[OtherDataKeyValueDto], optional),
Adjustments (Array[OtherDataKeyValueDto], optional),
Peripherals (Array[OtherDataKeyValueDto], optional),
RotaLockDate (string, optional),
PlannedSlots (boolean, optional),
DefaultSlotType (string, optional),
HideUnallocatedRow (boolean, optional),
ShowFlexiChunksTab (boolean, optional),
PayUnplannedSlots (boolean, optional),
AutoCreateTaskChunks (boolean, optional),
ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY (string, optional),
ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY (string, optional)
}
SlotChunkDto {
SlotChunkId (integer, optional),
SlotId (integer, optional),
SlotChunkTypeId (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
ChunkTypeName (string, optional, read only),
Start (string, optional),
End (string, optional),
ContractedHours (boolean, optional),
TotalSeconds (integer, optional),
SlotChunkLockTypeId (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
BreakRuleConditionId (string, optional),
PayRuleKey (string, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PayRateValue (number, optional),
PayValue (number, optional),
IncludeForPlannedAndActualHours (boolean, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotTaskChunkDto {
TaskChunkId (integer, optional),
SlotId (integer, optional),
CustomerId (string, optional),
CustomerName (string, optional),
ProductId (string, optional),
ProductName (string, optional),
TaskId (string, optional),
TaskName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
TotalSeconds (integer, optional),
EstimatedCost (number, optional),
TrueCost (number, optional),
TotalHours (number, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotTagDto {
SlotTagId (integer, optional),
SlotId (integer, optional),
TagKey (string, optional),
TagName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
TotalSeconds (integer, optional),
Cost (number, optional),
ToBeDeleted (boolean, optional),
ToBeUpdated (boolean, optional)
}
SlotAdjustmentDto {
SlotAdjustmentId (integer, optional),
SlotId (integer, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PayRateType (integer, optional) = ['1', '2', '3', '4', '5', '6', '7']
integerEnum:1, 2, 3, 4, 5, 6, 7
,
PayRateValue (number, optional),
Quantity (number, optional),
PayValue (number, optional),
CreatedBy (string, optional),
CreatedByName (string, optional),
CreatedDate (string, optional),
HolidayPayAdjustment (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotSwipeDto {
SwipeId (integer, optional),
SlotId (integer, optional),
OrganisationId (integer, optional),
PersonKey (string, optional),
Direction (integer, optional) = ['1', '2']
integerEnum:1, 2
,
DirectionName (string, optional, read only),
EventDateTime (string, optional),
RevisedDateTime (string, optional),
SwipeTypeId (integer, optional) = ['1', '2']
integerEnum:1, 2
,
SwipeTypeName (string, optional, read only),
PeripheralKey (string, optional),
PeripheralName (string, optional),
PeripheralLocation (string, optional),
Rounded (boolean, optional),
SwipeStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
SwipeReasonId (integer, optional) = ['0', '1', '2', '3', '4', '5', '6',
'7', '8', '9', '10', '11', '12', '13']
integerEnum:0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
,
StartBreakEndTypeId (integer, optional) = ['0', '1', '2', '3', '-1']
integerEnum:0, 1, 2, 3, -1
,
SwipeProcessingTypeId (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
Status_Auto (boolean, optional),
Status_Noted (boolean, optional),
Swipe_Latitude (number, optional),
Swipe_Longitude (number, optional),
OutsideSTDistanceAllowed (boolean, optional)
}
SlotNoteDto {
SlotNoteId (integer, optional),
SlotId (integer, optional),
Note (string, optional),
CreatedBy (string, optional),
CreatedByName (string, optional),
CreatedDate (string, optional),
HolidayPayAdjustment (boolean, optional),
HiddenFlag (boolean, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotAuditDto {
ActionId (integer, optional),
CreatedDate (string, optional),
Id (integer, optional),
SlotId (integer, optional),
OrganisationId (integer, optional),
Result (string, optional),
UserId (string, optional),
UserDisplayName (string, optional)
}
GameSlotBonusDto {
SlotBonusId (integer, optional),
SlotId (integer, optional),
BonusKey (string, optional),
ToBeDeleted (boolean, optional)
}
GameBonusDto {
BonusKey (string, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
Name (string, optional),
PayRateKey (string, optional),
PayRateMultiplier (number, optional)
}
GameSlotAdvertisementDto {
AdvertiseId (integer, optional),
SlotId (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional)
}
OtherDataKeyValueDto {
KeyValue (string, optional),
Name (string, optional),
Sort (integer, optional),
Default (boolean, optional)
}
[
{
"OrganisationId": 0,
"SlotId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"JobMandatory": true,
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"SlotTypeNoSwipesAllowed": true,
"SlotStatusId": 0,
"JobKey": "00000000-0000-0000-0000-000000000000",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonDisplayName": "string",
"PersonalSecurityStatusLevel": 1,
"JobName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"ShiftRestDay": true,
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PlannedStart": "2024-11-07T02:04:38.949Z",
"PlannedEnd": "2024-11-07T02:04:38.949Z",
"ActualStart": "2024-11-07T02:04:38.949Z",
"ActualEnd": "2024-11-07T02:04:38.949Z",
"GamePoints": 0,
"SlotDate": 0,
"SlotDateAsDate": "2024-11-07T02:04:38.949Z",
"DisplayDateStart": "2024-11-07T02:04:38.949Z",
"DisplayDateEnd": "2024-11-07T02:04:38.949Z",
"TotalPlannedSeconds": 0,
"TotalActualSeconds": 0,
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"ShiftPatternHours": true,
"Published": true,
"PreviousPublished": true,
"NoBreaks": 0,
"ActualStartLock": true,
"ActualEndLock": true,
"LieuStatus": 0,
"ShiftPatternDeploymentId": 0,
"ShiftPatternName": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayActualStartAndEndTimes": "string",
"BonusKeys": "string",
"ProcessingTime": "2024-11-07T02:04:38.949Z",
"AdvertiseFrom": "2024-11-07T02:04:38.949Z",
"AdvertiseTo": "2024-11-07T02:04:38.949Z",
"IsWorkingSlot": true,
"ColourHex": "string",
"SwapRequested": true,
"SlotChunks": [
{
"SlotChunkId": 0,
"SlotId": 0,
"SlotChunkTypeId": 1,
"ChunkTypeName": "string",
"Start": "2024-11-07T02:04:38.949Z",
"End": "2024-11-07T02:04:38.949Z",
"ContractedHours": true,
"TotalSeconds": 0,
"SlotChunkLockTypeId": 0,
"BreakRuleConditionId": "00000000-0000-0000-0000-000000000000",
"PayRuleKey": "00000000-0000-0000-0000-000000000000",
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PayRateValue": 0,
"PayValue": 0,
"IncludeForPlannedAndActualHours": true,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"TaskChunks": [
{
"TaskChunkId": 0,
"SlotId": 0,
"CustomerId": "00000000-0000-0000-0000-000000000000",
"CustomerName": "string",
"ProductId": "00000000-0000-0000-0000-000000000000",
"ProductName": "string",
"TaskId": "00000000-0000-0000-0000-000000000000",
"TaskName": "string",
"StartDate": "2024-11-07T02:04:38.949Z",
"EndDate": "2024-11-07T02:04:38.949Z",
"TotalSeconds": 0,
"EstimatedCost": 0,
"TrueCost": 0,
"TotalHours": 0,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"SlotTags": [
{
"SlotTagId": 0,
"SlotId": 0,
"TagKey": "00000000-0000-0000-0000-000000000000",
"TagName": "string",
"StartDate": "2024-11-07T02:04:38.949Z",
"EndDate": "2024-11-07T02:04:38.949Z",
"TotalSeconds": 0,
"Cost": 0,
"ToBeDeleted": true,
"ToBeUpdated": true
}
],
"SlotAdjustments": [
{
"SlotAdjustmentId": 0,
"SlotId": 0,
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PayRateType": 1,
"PayRateValue": 0,
"Quantity": 0,
"PayValue": 0,
"CreatedBy": "string",
"CreatedByName": "string",
"CreatedDate": "2024-11-07T02:04:38.949Z",
"HolidayPayAdjustment": true,
"ToBeDeleted": true
}
],
"SlotSwipes": [
{
"SwipeId": 0,
"SlotId": 0,
"OrganisationId": 0,
"PersonKey": "00000000-0000-0000-0000-000000000000",
"Direction": 1,
"DirectionName": "string",
"EventDateTime": "2024-11-07T02:04:38.949Z",
"RevisedDateTime": "2024-11-07T02:04:38.949Z",
"SwipeTypeId": 1,
"SwipeTypeName": "string",
"PeripheralKey": "00000000-0000-0000-0000-000000000000",
"PeripheralName": "string",
"PeripheralLocation": "string",
"Rounded": true,
"SwipeStatusId": 0,
"SwipeReasonId": 0,
"StartBreakEndTypeId": 0,
"SwipeProcessingTypeId": 0,
"Status_Auto": true,
"Status_Noted": true,
"Swipe_Latitude": 0,
"Swipe_Longitude": 0,
"OutsideSTDistanceAllowed": true
}
],
"SlotNotes": [
{
"SlotNoteId": 0,
"SlotId": 0,
"Note": "string",
"CreatedBy": "string",
"CreatedByName": "string",
"CreatedDate": "2024-11-07T02:04:38.949Z",
"HolidayPayAdjustment": true,
"HiddenFlag": true,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"SlotAudits": [
{
"ActionId": 0,
"CreatedDate": "2024-11-07T02:04:38.949Z",
"Id": 0,
"SlotId": 0,
"OrganisationId": 0,
"Result": "string",
"UserId": "string",
"UserDisplayName": "string"
}
],
"SelectedGameSlotBonuses": [
{
"SlotBonusId": 0,
"SlotId": 0,
"BonusKey": "00000000-0000-0000-0000-000000000000",
"ToBeDeleted": true
}
],
"GameSlotBonuses": [
{
"BonusKey": "00000000-0000-0000-0000-000000000000",
"OrganisationId": 0,
"CustomTypeId": 0,
"Name": "string",
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateMultiplier": 0
}
],
"SlotAdvertisement": {
"AdvertiseId": 0,
"SlotId": 0,
"AdvertiseFrom": "2024-11-07T02:04:38.949Z",
"AdvertiseTo": "2024-11-07T02:04:38.949Z"
},
"SlotTypes": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Persons": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Groups": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Shifts": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Jobs": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"OnlyPayRates": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Adjustments": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Peripherals": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"RotaLockDate": "2024-11-07T02:04:38.949Z",
"PlannedSlots": true,
"DefaultSlotType": "00000000-0000-0000-0000-000000000000",
"HideUnallocatedRow": true,
"ShowFlexiChunksTab": true,
"PayUnplannedSlots": true,
"AutoCreateTaskChunks": true,
"ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY": "string",
"ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<OrganisationId>1</OrganisationId>
<SlotId>1</SlotId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<JobMandatory>true</JobMandatory>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<SlotTypeNoSwipesAllowed>true</SlotTypeNoSwipesAllowed>
<SlotStatusId>0</SlotStatusId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonDisplayName>string</PersonDisplayName>
<PersonalSecurityStatusLevel>1</PersonalSecurityStatusLevel>
<JobName>string</JobName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<ShiftRestDay>true</ShiftRestDay>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<GamePoints>1</GamePoints>
<SlotDate>1</SlotDate>
<SlotDateAsDate>1970-01-01T00:00:00.001Z</SlotDateAsDate>
<DisplayDateStart>1970-01-01T00:00:00.001Z</DisplayDateStart>
<DisplayDateEnd>1970-01-01T00:00:00.001Z</DisplayDateEnd>
<TotalPlannedSeconds>1</TotalPlannedSeconds>
<TotalActualSeconds>1</TotalActualSeconds>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<ShiftPatternHours>true</ShiftPatternHours>
<Published>true</Published>
<PreviousPublished>true</PreviousPublished>
<NoBreaks>0</NoBreaks>
<ActualStartLock>true</ActualStartLock>
<ActualEndLock>true</ActualEndLock>
<LieuStatus>0</LieuStatus>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
<ShiftPatternName>string</ShiftPatternName>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<BonusKeys>string</BonusKeys>
<ProcessingTime>1970-01-01T00:00:00.001Z</ProcessingTime>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<IsWorkingSlot>true</IsWorkingSlot>
<ColourHex>string</ColourHex>
<SwapRequested>true</SwapRequested>
<SlotChunks>
<SlotChunkId>1</SlotChunkId>
<SlotId>1</SlotId>
<SlotChunkTypeId>1</SlotChunkTypeId>
<ChunkTypeName>string</ChunkTypeName>
<Start>1970-01-01T00:00:00.001Z</Start>
<End>1970-01-01T00:00:00.001Z</End>
<ContractedHours>true</ContractedHours>
<TotalSeconds>1</TotalSeconds>
<SlotChunkLockTypeId>0</SlotChunkLockTypeId>
<BreakRuleConditionId>00000000-0000-0000-0000-000000000000</BreakRuleConditionId>
<PayRuleKey>00000000-0000-0000-0000-000000000000</PayRuleKey>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PayRateValue>1.1</PayRateValue>
<PayValue>1.1</PayValue>
<IncludeForPlannedAndActualHours>true</IncludeForPlannedAndActualHours>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</SlotChunks>
<TaskChunks>
<TaskChunkId>1</TaskChunkId>
<SlotId>1</SlotId>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>string</CustomerName>
<ProductId>00000000-0000-0000-0000-000000000000</ProductId>
<ProductName>string</ProductName>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
<TaskName>string</TaskName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<TotalSeconds>1</TotalSeconds>
<EstimatedCost>1.1</EstimatedCost>
<TrueCost>1.1</TrueCost>
<TotalHours>1.1</TotalHours>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</TaskChunks>
<SlotTags>
<SlotTagId>1</SlotTagId>
<SlotId>1</SlotId>
<TagKey>00000000-0000-0000-0000-000000000000</TagKey>
<TagName>string</TagName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<TotalSeconds>1</TotalSeconds>
<Cost>1.1</Cost>
<ToBeDeleted>true</ToBeDeleted>
<ToBeUpdated>true</ToBeUpdated>
</SlotTags>
<SlotAdjustments>
<SlotAdjustmentId>1</SlotAdjustmentId>
<SlotId>1</SlotId>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PayRateType>1</PayRateType>
<PayRateValue>1.1</PayRateValue>
<Quantity>1.1</Quantity>
<PayValue>1.1</PayValue>
<CreatedBy>string</CreatedBy>
<CreatedByName>string</CreatedByName>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<HolidayPayAdjustment>true</HolidayPayAdjustment>
<ToBeDeleted>true</ToBeDeleted>
</SlotAdjustments>
<SlotSwipes>
<SwipeId>1</SwipeId>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<Direction>1</Direction>
<DirectionName>string</DirectionName>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<RevisedDateTime>1970-01-01T00:00:00.001Z</RevisedDateTime>
<SwipeTypeId>1</SwipeTypeId>
<SwipeTypeName>string</SwipeTypeName>
<PeripheralKey>00000000-0000-0000-0000-000000000000</PeripheralKey>
<PeripheralName>string</PeripheralName>
<PeripheralLocation>string</PeripheralLocation>
<Rounded>true</Rounded>
<SwipeStatusId>0</SwipeStatusId>
<SwipeReasonId>0</SwipeReasonId>
<StartBreakEndTypeId>0</StartBreakEndTypeId>
<SwipeProcessingTypeId>0</SwipeProcessingTypeId>
<Status_Auto>true</Status_Auto>
<Status_Noted>true</Status_Noted>
<Swipe_Latitude>1.1</Swipe_Latitude>
<Swipe_Longitude>1.1</Swipe_Longitude>
<OutsideSTDistanceAllowed>true</OutsideSTDistanceAllowed>
</SlotSwipes>
<SlotNotes>
<SlotNoteId>1</SlotNoteId>
<SlotId>1</SlotId>
<Note>string</Note>
<CreatedBy>string</CreatedBy>
<CreatedByName>string</CreatedByName>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<HolidayPayAdjustment>true</HolidayPayAdjustment>
<HiddenFlag>true</HiddenFlag>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</SlotNotes>
<SlotAudits>
<ActionId>1</ActionId>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<Id>1</Id>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<Result>string</Result>
<UserId>string</UserId>
<UserDisplayName>string</UserDisplayName>
</SlotAudits>
<SelectedGameSlotBonuses>
<SlotBonusId>1</SlotBonusId>
<SlotId>1</SlotId>
<BonusKey>00000000-0000-0000-0000-000000000000</BonusKey>
<ToBeDeleted>true</ToBeDeleted>
</SelectedGameSlotBonuses>
<GameSlotBonuses>
<BonusKey>00000000-0000-0000-0000-000000000000</BonusKey>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Name>string</Name>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateMultiplier>1.1</PayRateMultiplier>
</GameSlotBonuses>
<SlotAdvertisement>
<AdvertiseId>1</AdvertiseId>
<SlotId>1</SlotId>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
</SlotAdvertisement>
<SlotTypes>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</SlotTypes>
<Persons>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Persons>
<Groups>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Groups>
<Shifts>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Shifts>
<Jobs>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Jobs>
<OnlyPayRates>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</OnlyPayRates>
<Adjustments>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Adjustments>
<Peripherals>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Peripherals>
<RotaLockDate>1970-01-01T00:00:00.001Z</RotaLockDate>
<PlannedSlots>true</PlannedSlots>
<DefaultSlotType>00000000-0000-0000-0000-000000000000</DefaultSlotType>
<HideUnallocatedRow>true</HideUnallocatedRow>
<ShowFlexiChunksTab>true</ShowFlexiChunksTab>
<PayUnplannedSlots>true</PayUnplannedSlots>
<AutoCreateTaskChunks>true</AutoCreateTaskChunks>
<ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY>string</ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY>
<ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY>string</ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/SLOTS/{ID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
SlotDto {
OrganisationId (integer, optional),
SlotId (integer, optional),
GroupId (string, optional),
GroupName (string, optional),
JobMandatory (boolean, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
SlotTypeNoSwipesAllowed (boolean, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
JobKey (string, optional),
PersonKey (string, optional),
PersonDisplayName (string, optional),
PersonalSecurityStatusLevel (integer, optional) = ['1', '2', '3', '4',
'5', '6', '7', '8', '9', '10']
integerEnum:1, 2, 3, 4, 5, 6, 7, 8, 9, 10
,
JobName (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
ShiftRestDay (boolean, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
GamePoints (integer, optional),
SlotDate (integer, optional),
SlotDateAsDate (string, optional, read only),
DisplayDateStart (string, optional, read only),
DisplayDateEnd (string, optional, read only),
TotalPlannedSeconds (integer, optional),
TotalActualSeconds (integer, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
ShiftPatternHours (boolean, optional),
Published (boolean, optional),
PreviousPublished (boolean, optional),
NoBreaks (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
ActualStartLock (boolean, optional),
ActualEndLock (boolean, optional),
LieuStatus (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
ShiftPatternDeploymentId (integer, optional),
ShiftPatternName (string, optional),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayActualStartAndEndTimes (string, optional, read only),
BonusKeys (string, optional),
ProcessingTime (string, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
IsWorkingSlot (boolean, optional),
ColourHex (string, optional),
SwapRequested (boolean, optional),
SlotChunks (Array[SlotChunkDto], optional),
TaskChunks (Array[SlotTaskChunkDto], optional),
SlotTags (Array[SlotTagDto], optional),
SlotAdjustments (Array[SlotAdjustmentDto], optional),
SlotSwipes (Array[SlotSwipeDto], optional),
SlotNotes (Array[SlotNoteDto], optional),
SlotAudits (Array[SlotAuditDto], optional),
SelectedGameSlotBonuses (Array[GameSlotBonusDto], optional),
GameSlotBonuses (Array[GameBonusDto], optional),
SlotAdvertisement (GameSlotAdvertisementDto, optional),
SlotTypes (Array[OtherDataKeyValueDto], optional),
Persons (Array[OtherDataKeyValueDto], optional),
Groups (Array[OtherDataKeyValueDto], optional),
Shifts (Array[OtherDataKeyValueDto], optional),
Jobs (Array[OtherDataKeyValueDto], optional),
OnlyPayRates (Array[OtherDataKeyValueDto], optional),
Adjustments (Array[OtherDataKeyValueDto], optional),
Peripherals (Array[OtherDataKeyValueDto], optional),
RotaLockDate (string, optional),
PlannedSlots (boolean, optional),
DefaultSlotType (string, optional),
HideUnallocatedRow (boolean, optional),
ShowFlexiChunksTab (boolean, optional),
PayUnplannedSlots (boolean, optional),
AutoCreateTaskChunks (boolean, optional),
ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY (string, optional),
ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY (string, optional)
}
SlotChunkDto {
SlotChunkId (integer, optional),
SlotId (integer, optional),
SlotChunkTypeId (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
ChunkTypeName (string, optional, read only),
Start (string, optional),
End (string, optional),
ContractedHours (boolean, optional),
TotalSeconds (integer, optional),
SlotChunkLockTypeId (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
BreakRuleConditionId (string, optional),
PayRuleKey (string, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PayRateValue (number, optional),
PayValue (number, optional),
IncludeForPlannedAndActualHours (boolean, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotTaskChunkDto {
TaskChunkId (integer, optional),
SlotId (integer, optional),
CustomerId (string, optional),
CustomerName (string, optional),
ProductId (string, optional),
ProductName (string, optional),
TaskId (string, optional),
TaskName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
TotalSeconds (integer, optional),
EstimatedCost (number, optional),
TrueCost (number, optional),
TotalHours (number, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotTagDto {
SlotTagId (integer, optional),
SlotId (integer, optional),
TagKey (string, optional),
TagName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
TotalSeconds (integer, optional),
Cost (number, optional),
ToBeDeleted (boolean, optional),
ToBeUpdated (boolean, optional)
}
SlotAdjustmentDto {
SlotAdjustmentId (integer, optional),
SlotId (integer, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PayRateType (integer, optional) = ['1', '2', '3', '4', '5', '6', '7']
integerEnum:1, 2, 3, 4, 5, 6, 7
,
PayRateValue (number, optional),
Quantity (number, optional),
PayValue (number, optional),
CreatedBy (string, optional),
CreatedByName (string, optional),
CreatedDate (string, optional),
HolidayPayAdjustment (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotSwipeDto {
SwipeId (integer, optional),
SlotId (integer, optional),
OrganisationId (integer, optional),
PersonKey (string, optional),
Direction (integer, optional) = ['1', '2']
integerEnum:1, 2
,
DirectionName (string, optional, read only),
EventDateTime (string, optional),
RevisedDateTime (string, optional),
SwipeTypeId (integer, optional) = ['1', '2']
integerEnum:1, 2
,
SwipeTypeName (string, optional, read only),
PeripheralKey (string, optional),
PeripheralName (string, optional),
PeripheralLocation (string, optional),
Rounded (boolean, optional),
SwipeStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
SwipeReasonId (integer, optional) = ['0', '1', '2', '3', '4', '5', '6',
'7', '8', '9', '10', '11', '12', '13']
integerEnum:0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
,
StartBreakEndTypeId (integer, optional) = ['0', '1', '2', '3', '-1']
integerEnum:0, 1, 2, 3, -1
,
SwipeProcessingTypeId (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
Status_Auto (boolean, optional),
Status_Noted (boolean, optional),
Swipe_Latitude (number, optional),
Swipe_Longitude (number, optional),
OutsideSTDistanceAllowed (boolean, optional)
}
SlotNoteDto {
SlotNoteId (integer, optional),
SlotId (integer, optional),
Note (string, optional),
CreatedBy (string, optional),
CreatedByName (string, optional),
CreatedDate (string, optional),
HolidayPayAdjustment (boolean, optional),
HiddenFlag (boolean, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotAuditDto {
ActionId (integer, optional),
CreatedDate (string, optional),
Id (integer, optional),
SlotId (integer, optional),
OrganisationId (integer, optional),
Result (string, optional),
UserId (string, optional),
UserDisplayName (string, optional)
}
GameSlotBonusDto {
SlotBonusId (integer, optional),
SlotId (integer, optional),
BonusKey (string, optional),
ToBeDeleted (boolean, optional)
}
GameBonusDto {
BonusKey (string, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
Name (string, optional),
PayRateKey (string, optional),
PayRateMultiplier (number, optional)
}
GameSlotAdvertisementDto {
AdvertiseId (integer, optional),
SlotId (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional)
}
OtherDataKeyValueDto {
KeyValue (string, optional),
Name (string, optional),
Sort (integer, optional),
Default (boolean, optional)
}
{
"OrganisationId": 0,
"SlotId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"JobMandatory": true,
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"SlotTypeNoSwipesAllowed": true,
"SlotStatusId": 0,
"JobKey": "00000000-0000-0000-0000-000000000000",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonDisplayName": "string",
"PersonalSecurityStatusLevel": 1,
"JobName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"ShiftRestDay": true,
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PlannedStart": "2024-11-07T02:04:38.966Z",
"PlannedEnd": "2024-11-07T02:04:38.966Z",
"ActualStart": "2024-11-07T02:04:38.966Z",
"ActualEnd": "2024-11-07T02:04:38.966Z",
"GamePoints": 0,
"SlotDate": 0,
"SlotDateAsDate": "2024-11-07T02:04:38.966Z",
"DisplayDateStart": "2024-11-07T02:04:38.966Z",
"DisplayDateEnd": "2024-11-07T02:04:38.966Z",
"TotalPlannedSeconds": 0,
"TotalActualSeconds": 0,
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"ShiftPatternHours": true,
"Published": true,
"PreviousPublished": true,
"NoBreaks": 0,
"ActualStartLock": true,
"ActualEndLock": true,
"LieuStatus": 0,
"ShiftPatternDeploymentId": 0,
"ShiftPatternName": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayActualStartAndEndTimes": "string",
"BonusKeys": "string",
"ProcessingTime": "2024-11-07T02:04:38.966Z",
"AdvertiseFrom": "2024-11-07T02:04:38.966Z",
"AdvertiseTo": "2024-11-07T02:04:38.966Z",
"IsWorkingSlot": true,
"ColourHex": "string",
"SwapRequested": true,
"SlotChunks": [
{
"SlotChunkId": 0,
"SlotId": 0,
"SlotChunkTypeId": 1,
"ChunkTypeName": "string",
"Start": "2024-11-07T02:04:38.966Z",
"End": "2024-11-07T02:04:38.966Z",
"ContractedHours": true,
"TotalSeconds": 0,
"SlotChunkLockTypeId": 0,
"BreakRuleConditionId": "00000000-0000-0000-0000-000000000000",
"PayRuleKey": "00000000-0000-0000-0000-000000000000",
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PayRateValue": 0,
"PayValue": 0,
"IncludeForPlannedAndActualHours": true,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"TaskChunks": [
{
"TaskChunkId": 0,
"SlotId": 0,
"CustomerId": "00000000-0000-0000-0000-000000000000",
"CustomerName": "string",
"ProductId": "00000000-0000-0000-0000-000000000000",
"ProductName": "string",
"TaskId": "00000000-0000-0000-0000-000000000000",
"TaskName": "string",
"StartDate": "2024-11-07T02:04:38.966Z",
"EndDate": "2024-11-07T02:04:38.966Z",
"TotalSeconds": 0,
"EstimatedCost": 0,
"TrueCost": 0,
"TotalHours": 0,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"SlotTags": [
{
"SlotTagId": 0,
"SlotId": 0,
"TagKey": "00000000-0000-0000-0000-000000000000",
"TagName": "string",
"StartDate": "2024-11-07T02:04:38.966Z",
"EndDate": "2024-11-07T02:04:38.966Z",
"TotalSeconds": 0,
"Cost": 0,
"ToBeDeleted": true,
"ToBeUpdated": true
}
],
"SlotAdjustments": [
{
"SlotAdjustmentId": 0,
"SlotId": 0,
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PayRateType": 1,
"PayRateValue": 0,
"Quantity": 0,
"PayValue": 0,
"CreatedBy": "string",
"CreatedByName": "string",
"CreatedDate": "2024-11-07T02:04:38.966Z",
"HolidayPayAdjustment": true,
"ToBeDeleted": true
}
],
"SlotSwipes": [
{
"SwipeId": 0,
"SlotId": 0,
"OrganisationId": 0,
"PersonKey": "00000000-0000-0000-0000-000000000000",
"Direction": 1,
"DirectionName": "string",
"EventDateTime": "2024-11-07T02:04:38.966Z",
"RevisedDateTime": "2024-11-07T02:04:38.966Z",
"SwipeTypeId": 1,
"SwipeTypeName": "string",
"PeripheralKey": "00000000-0000-0000-0000-000000000000",
"PeripheralName": "string",
"PeripheralLocation": "string",
"Rounded": true,
"SwipeStatusId": 0,
"SwipeReasonId": 0,
"StartBreakEndTypeId": 0,
"SwipeProcessingTypeId": 0,
"Status_Auto": true,
"Status_Noted": true,
"Swipe_Latitude": 0,
"Swipe_Longitude": 0,
"OutsideSTDistanceAllowed": true
}
],
"SlotNotes": [
{
"SlotNoteId": 0,
"SlotId": 0,
"Note": "string",
"CreatedBy": "string",
"CreatedByName": "string",
"CreatedDate": "2024-11-07T02:04:38.966Z",
"HolidayPayAdjustment": true,
"HiddenFlag": true,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"SlotAudits": [
{
"ActionId": 0,
"CreatedDate": "2024-11-07T02:04:38.966Z",
"Id": 0,
"SlotId": 0,
"OrganisationId": 0,
"Result": "string",
"UserId": "string",
"UserDisplayName": "string"
}
],
"SelectedGameSlotBonuses": [
{
"SlotBonusId": 0,
"SlotId": 0,
"BonusKey": "00000000-0000-0000-0000-000000000000",
"ToBeDeleted": true
}
],
"GameSlotBonuses": [
{
"BonusKey": "00000000-0000-0000-0000-000000000000",
"OrganisationId": 0,
"CustomTypeId": 0,
"Name": "string",
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateMultiplier": 0
}
],
"SlotAdvertisement": {
"AdvertiseId": 0,
"SlotId": 0,
"AdvertiseFrom": "2024-11-07T02:04:38.966Z",
"AdvertiseTo": "2024-11-07T02:04:38.966Z"
},
"SlotTypes": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Persons": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Groups": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Shifts": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Jobs": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"OnlyPayRates": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Adjustments": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Peripherals": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"RotaLockDate": "2024-11-07T02:04:38.972Z",
"PlannedSlots": true,
"DefaultSlotType": "00000000-0000-0000-0000-000000000000",
"HideUnallocatedRow": true,
"ShowFlexiChunksTab": true,
"PayUnplannedSlots": true,
"AutoCreateTaskChunks": true,
"ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY": "string",
"ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY": "string"
}
<?xml version="1.0"?>
<SlotDto>
<OrganisationId>1</OrganisationId>
<SlotId>1</SlotId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<JobMandatory>true</JobMandatory>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<SlotTypeNoSwipesAllowed>true</SlotTypeNoSwipesAllowed>
<SlotStatusId>0</SlotStatusId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonDisplayName>string</PersonDisplayName>
<PersonalSecurityStatusLevel>1</PersonalSecurityStatusLevel>
<JobName>string</JobName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<ShiftRestDay>true</ShiftRestDay>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<GamePoints>1</GamePoints>
<SlotDate>1</SlotDate>
<SlotDateAsDate>1970-01-01T00:00:00.001Z</SlotDateAsDate>
<DisplayDateStart>1970-01-01T00:00:00.001Z</DisplayDateStart>
<DisplayDateEnd>1970-01-01T00:00:00.001Z</DisplayDateEnd>
<TotalPlannedSeconds>1</TotalPlannedSeconds>
<TotalActualSeconds>1</TotalActualSeconds>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<ShiftPatternHours>true</ShiftPatternHours>
<Published>true</Published>
<PreviousPublished>true</PreviousPublished>
<NoBreaks>0</NoBreaks>
<ActualStartLock>true</ActualStartLock>
<ActualEndLock>true</ActualEndLock>
<LieuStatus>0</LieuStatus>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
<ShiftPatternName>string</ShiftPatternName>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<BonusKeys>string</BonusKeys>
<ProcessingTime>1970-01-01T00:00:00.001Z</ProcessingTime>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<IsWorkingSlot>true</IsWorkingSlot>
<ColourHex>string</ColourHex>
<SwapRequested>true</SwapRequested>
<SlotChunks>
<SlotChunkId>1</SlotChunkId>
<SlotId>1</SlotId>
<SlotChunkTypeId>1</SlotChunkTypeId>
<ChunkTypeName>string</ChunkTypeName>
<Start>1970-01-01T00:00:00.001Z</Start>
<End>1970-01-01T00:00:00.001Z</End>
<ContractedHours>true</ContractedHours>
<TotalSeconds>1</TotalSeconds>
<SlotChunkLockTypeId>0</SlotChunkLockTypeId>
<BreakRuleConditionId>00000000-0000-0000-0000-000000000000</BreakRuleConditionId>
<PayRuleKey>00000000-0000-0000-0000-000000000000</PayRuleKey>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PayRateValue>1.1</PayRateValue>
<PayValue>1.1</PayValue>
<IncludeForPlannedAndActualHours>true</IncludeForPlannedAndActualHours>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</SlotChunks>
<TaskChunks>
<TaskChunkId>1</TaskChunkId>
<SlotId>1</SlotId>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>string</CustomerName>
<ProductId>00000000-0000-0000-0000-000000000000</ProductId>
<ProductName>string</ProductName>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
<TaskName>string</TaskName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<TotalSeconds>1</TotalSeconds>
<EstimatedCost>1.1</EstimatedCost>
<TrueCost>1.1</TrueCost>
<TotalHours>1.1</TotalHours>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</TaskChunks>
<SlotTags>
<SlotTagId>1</SlotTagId>
<SlotId>1</SlotId>
<TagKey>00000000-0000-0000-0000-000000000000</TagKey>
<TagName>string</TagName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<TotalSeconds>1</TotalSeconds>
<Cost>1.1</Cost>
<ToBeDeleted>true</ToBeDeleted>
<ToBeUpdated>true</ToBeUpdated>
</SlotTags>
<SlotAdjustments>
<SlotAdjustmentId>1</SlotAdjustmentId>
<SlotId>1</SlotId>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PayRateType>1</PayRateType>
<PayRateValue>1.1</PayRateValue>
<Quantity>1.1</Quantity>
<PayValue>1.1</PayValue>
<CreatedBy>string</CreatedBy>
<CreatedByName>string</CreatedByName>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<HolidayPayAdjustment>true</HolidayPayAdjustment>
<ToBeDeleted>true</ToBeDeleted>
</SlotAdjustments>
<SlotSwipes>
<SwipeId>1</SwipeId>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<Direction>1</Direction>
<DirectionName>string</DirectionName>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<RevisedDateTime>1970-01-01T00:00:00.001Z</RevisedDateTime>
<SwipeTypeId>1</SwipeTypeId>
<SwipeTypeName>string</SwipeTypeName>
<PeripheralKey>00000000-0000-0000-0000-000000000000</PeripheralKey>
<PeripheralName>string</PeripheralName>
<PeripheralLocation>string</PeripheralLocation>
<Rounded>true</Rounded>
<SwipeStatusId>0</SwipeStatusId>
<SwipeReasonId>0</SwipeReasonId>
<StartBreakEndTypeId>0</StartBreakEndTypeId>
<SwipeProcessingTypeId>0</SwipeProcessingTypeId>
<Status_Auto>true</Status_Auto>
<Status_Noted>true</Status_Noted>
<Swipe_Latitude>1.1</Swipe_Latitude>
<Swipe_Longitude>1.1</Swipe_Longitude>
<OutsideSTDistanceAllowed>true</OutsideSTDistanceAllowed>
</SlotSwipes>
<SlotNotes>
<SlotNoteId>1</SlotNoteId>
<SlotId>1</SlotId>
<Note>string</Note>
<CreatedBy>string</CreatedBy>
<CreatedByName>string</CreatedByName>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<HolidayPayAdjustment>true</HolidayPayAdjustment>
<HiddenFlag>true</HiddenFlag>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</SlotNotes>
<SlotAudits>
<ActionId>1</ActionId>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<Id>1</Id>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<Result>string</Result>
<UserId>string</UserId>
<UserDisplayName>string</UserDisplayName>
</SlotAudits>
<SelectedGameSlotBonuses>
<SlotBonusId>1</SlotBonusId>
<SlotId>1</SlotId>
<BonusKey>00000000-0000-0000-0000-000000000000</BonusKey>
<ToBeDeleted>true</ToBeDeleted>
</SelectedGameSlotBonuses>
<GameSlotBonuses>
<BonusKey>00000000-0000-0000-0000-000000000000</BonusKey>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Name>string</Name>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateMultiplier>1.1</PayRateMultiplier>
</GameSlotBonuses>
<SlotAdvertisement>
<AdvertiseId>1</AdvertiseId>
<SlotId>1</SlotId>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
</SlotAdvertisement>
<SlotTypes>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</SlotTypes>
<Persons>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Persons>
<Groups>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Groups>
<Shifts>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Shifts>
<Jobs>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Jobs>
<OnlyPayRates>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</OnlyPayRates>
<Adjustments>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Adjustments>
<Peripherals>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Peripherals>
<RotaLockDate>1970-01-01T00:00:00.001Z</RotaLockDate>
<PlannedSlots>true</PlannedSlots>
<DefaultSlotType>00000000-0000-0000-0000-000000000000</DefaultSlotType>
<HideUnallocatedRow>true</HideUnallocatedRow>
<ShowFlexiChunksTab>true</ShowFlexiChunksTab>
<PayUnplannedSlots>true</PayUnplannedSlots>
<AutoCreateTaskChunks>true</AutoCreateTaskChunks>
<ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY>string</ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY>
<ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY>string</ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY>
</SlotDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type id path long
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTA/SLOTSONDAY/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
OrganisationId (integer, optional),
SlotId (integer, optional),
GroupId (string, optional),
GroupName (string, optional),
JobMandatory (boolean, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
SlotTypeNoSwipesAllowed (boolean, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
JobKey (string, optional),
PersonKey (string, optional),
PersonDisplayName (string, optional),
PersonalSecurityStatusLevel (integer, optional) = ['1', '2', '3', '4',
'5', '6', '7', '8', '9', '10']
integerEnum:1, 2, 3, 4, 5, 6, 7, 8, 9, 10
,
JobName (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
ShiftRestDay (boolean, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
GamePoints (integer, optional),
SlotDate (integer, optional),
SlotDateAsDate (string, optional, read only),
DisplayDateStart (string, optional, read only),
DisplayDateEnd (string, optional, read only),
TotalPlannedSeconds (integer, optional),
TotalActualSeconds (integer, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
ShiftPatternHours (boolean, optional),
Published (boolean, optional),
PreviousPublished (boolean, optional),
NoBreaks (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
ActualStartLock (boolean, optional),
ActualEndLock (boolean, optional),
LieuStatus (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
ShiftPatternDeploymentId (integer, optional),
ShiftPatternName (string, optional),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayActualStartAndEndTimes (string, optional, read only),
BonusKeys (string, optional),
ProcessingTime (string, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
IsWorkingSlot (boolean, optional),
ColourHex (string, optional),
SwapRequested (boolean, optional),
SlotChunks (Array[SlotChunkDto], optional),
TaskChunks (Array[SlotTaskChunkDto], optional),
SlotTags (Array[SlotTagDto], optional),
SlotAdjustments (Array[SlotAdjustmentDto], optional),
SlotSwipes (Array[SlotSwipeDto], optional),
SlotNotes (Array[SlotNoteDto], optional),
SlotAudits (Array[SlotAuditDto], optional),
SelectedGameSlotBonuses (Array[GameSlotBonusDto], optional),
GameSlotBonuses (Array[GameBonusDto], optional),
SlotAdvertisement (GameSlotAdvertisementDto, optional),
SlotTypes (Array[OtherDataKeyValueDto], optional),
Persons (Array[OtherDataKeyValueDto], optional),
Groups (Array[OtherDataKeyValueDto], optional),
Shifts (Array[OtherDataKeyValueDto], optional),
Jobs (Array[OtherDataKeyValueDto], optional),
OnlyPayRates (Array[OtherDataKeyValueDto], optional),
Adjustments (Array[OtherDataKeyValueDto], optional),
Peripherals (Array[OtherDataKeyValueDto], optional),
RotaLockDate (string, optional),
PlannedSlots (boolean, optional),
DefaultSlotType (string, optional),
HideUnallocatedRow (boolean, optional),
ShowFlexiChunksTab (boolean, optional),
PayUnplannedSlots (boolean, optional),
AutoCreateTaskChunks (boolean, optional),
ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY (string, optional),
ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY (string, optional)
}
SlotChunkDto {
SlotChunkId (integer, optional),
SlotId (integer, optional),
SlotChunkTypeId (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
ChunkTypeName (string, optional, read only),
Start (string, optional),
End (string, optional),
ContractedHours (boolean, optional),
TotalSeconds (integer, optional),
SlotChunkLockTypeId (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
BreakRuleConditionId (string, optional),
PayRuleKey (string, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PayRateValue (number, optional),
PayValue (number, optional),
IncludeForPlannedAndActualHours (boolean, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotTaskChunkDto {
TaskChunkId (integer, optional),
SlotId (integer, optional),
CustomerId (string, optional),
CustomerName (string, optional),
ProductId (string, optional),
ProductName (string, optional),
TaskId (string, optional),
TaskName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
TotalSeconds (integer, optional),
EstimatedCost (number, optional),
TrueCost (number, optional),
TotalHours (number, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotTagDto {
SlotTagId (integer, optional),
SlotId (integer, optional),
TagKey (string, optional),
TagName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
TotalSeconds (integer, optional),
Cost (number, optional),
ToBeDeleted (boolean, optional),
ToBeUpdated (boolean, optional)
}
SlotAdjustmentDto {
SlotAdjustmentId (integer, optional),
SlotId (integer, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PayRateType (integer, optional) = ['1', '2', '3', '4', '5', '6', '7']
integerEnum:1, 2, 3, 4, 5, 6, 7
,
PayRateValue (number, optional),
Quantity (number, optional),
PayValue (number, optional),
CreatedBy (string, optional),
CreatedByName (string, optional),
CreatedDate (string, optional),
HolidayPayAdjustment (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotSwipeDto {
SwipeId (integer, optional),
SlotId (integer, optional),
OrganisationId (integer, optional),
PersonKey (string, optional),
Direction (integer, optional) = ['1', '2']
integerEnum:1, 2
,
DirectionName (string, optional, read only),
EventDateTime (string, optional),
RevisedDateTime (string, optional),
SwipeTypeId (integer, optional) = ['1', '2']
integerEnum:1, 2
,
SwipeTypeName (string, optional, read only),
PeripheralKey (string, optional),
PeripheralName (string, optional),
PeripheralLocation (string, optional),
Rounded (boolean, optional),
SwipeStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
SwipeReasonId (integer, optional) = ['0', '1', '2', '3', '4', '5', '6',
'7', '8', '9', '10', '11', '12', '13']
integerEnum:0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
,
StartBreakEndTypeId (integer, optional) = ['0', '1', '2', '3', '-1']
integerEnum:0, 1, 2, 3, -1
,
SwipeProcessingTypeId (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
Status_Auto (boolean, optional),
Status_Noted (boolean, optional),
Swipe_Latitude (number, optional),
Swipe_Longitude (number, optional),
OutsideSTDistanceAllowed (boolean, optional)
}
SlotNoteDto {
SlotNoteId (integer, optional),
SlotId (integer, optional),
Note (string, optional),
CreatedBy (string, optional),
CreatedByName (string, optional),
CreatedDate (string, optional),
HolidayPayAdjustment (boolean, optional),
HiddenFlag (boolean, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotAuditDto {
ActionId (integer, optional),
CreatedDate (string, optional),
Id (integer, optional),
SlotId (integer, optional),
OrganisationId (integer, optional),
Result (string, optional),
UserId (string, optional),
UserDisplayName (string, optional)
}
GameSlotBonusDto {
SlotBonusId (integer, optional),
SlotId (integer, optional),
BonusKey (string, optional),
ToBeDeleted (boolean, optional)
}
GameBonusDto {
BonusKey (string, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
Name (string, optional),
PayRateKey (string, optional),
PayRateMultiplier (number, optional)
}
GameSlotAdvertisementDto {
AdvertiseId (integer, optional),
SlotId (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional)
}
OtherDataKeyValueDto {
KeyValue (string, optional),
Name (string, optional),
Sort (integer, optional),
Default (boolean, optional)
}
[
{
"OrganisationId": 0,
"SlotId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"JobMandatory": true,
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"SlotTypeNoSwipesAllowed": true,
"SlotStatusId": 0,
"JobKey": "00000000-0000-0000-0000-000000000000",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonDisplayName": "string",
"PersonalSecurityStatusLevel": 1,
"JobName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"ShiftRestDay": true,
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PlannedStart": "2024-11-07T02:04:38.981Z",
"PlannedEnd": "2024-11-07T02:04:38.981Z",
"ActualStart": "2024-11-07T02:04:38.981Z",
"ActualEnd": "2024-11-07T02:04:38.981Z",
"GamePoints": 0,
"SlotDate": 0,
"SlotDateAsDate": "2024-11-07T02:04:38.981Z",
"DisplayDateStart": "2024-11-07T02:04:38.981Z",
"DisplayDateEnd": "2024-11-07T02:04:38.981Z",
"TotalPlannedSeconds": 0,
"TotalActualSeconds": 0,
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"ShiftPatternHours": true,
"Published": true,
"PreviousPublished": true,
"NoBreaks": 0,
"ActualStartLock": true,
"ActualEndLock": true,
"LieuStatus": 0,
"ShiftPatternDeploymentId": 0,
"ShiftPatternName": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayActualStartAndEndTimes": "string",
"BonusKeys": "string",
"ProcessingTime": "2024-11-07T02:04:38.981Z",
"AdvertiseFrom": "2024-11-07T02:04:38.981Z",
"AdvertiseTo": "2024-11-07T02:04:38.981Z",
"IsWorkingSlot": true,
"ColourHex": "string",
"SwapRequested": true,
"SlotChunks": [
{
"SlotChunkId": 0,
"SlotId": 0,
"SlotChunkTypeId": 1,
"ChunkTypeName": "string",
"Start": "2024-11-07T02:04:38.981Z",
"End": "2024-11-07T02:04:38.981Z",
"ContractedHours": true,
"TotalSeconds": 0,
"SlotChunkLockTypeId": 0,
"BreakRuleConditionId": "00000000-0000-0000-0000-000000000000",
"PayRuleKey": "00000000-0000-0000-0000-000000000000",
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PayRateValue": 0,
"PayValue": 0,
"IncludeForPlannedAndActualHours": true,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"TaskChunks": [
{
"TaskChunkId": 0,
"SlotId": 0,
"CustomerId": "00000000-0000-0000-0000-000000000000",
"CustomerName": "string",
"ProductId": "00000000-0000-0000-0000-000000000000",
"ProductName": "string",
"TaskId": "00000000-0000-0000-0000-000000000000",
"TaskName": "string",
"StartDate": "2024-11-07T02:04:38.981Z",
"EndDate": "2024-11-07T02:04:38.981Z",
"TotalSeconds": 0,
"EstimatedCost": 0,
"TrueCost": 0,
"TotalHours": 0,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"SlotTags": [
{
"SlotTagId": 0,
"SlotId": 0,
"TagKey": "00000000-0000-0000-0000-000000000000",
"TagName": "string",
"StartDate": "2024-11-07T02:04:38.981Z",
"EndDate": "2024-11-07T02:04:38.981Z",
"TotalSeconds": 0,
"Cost": 0,
"ToBeDeleted": true,
"ToBeUpdated": true
}
],
"SlotAdjustments": [
{
"SlotAdjustmentId": 0,
"SlotId": 0,
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PayRateType": 1,
"PayRateValue": 0,
"Quantity": 0,
"PayValue": 0,
"CreatedBy": "string",
"CreatedByName": "string",
"CreatedDate": "2024-11-07T02:04:38.981Z",
"HolidayPayAdjustment": true,
"ToBeDeleted": true
}
],
"SlotSwipes": [
{
"SwipeId": 0,
"SlotId": 0,
"OrganisationId": 0,
"PersonKey": "00000000-0000-0000-0000-000000000000",
"Direction": 1,
"DirectionName": "string",
"EventDateTime": "2024-11-07T02:04:38.981Z",
"RevisedDateTime": "2024-11-07T02:04:38.981Z",
"SwipeTypeId": 1,
"SwipeTypeName": "string",
"PeripheralKey": "00000000-0000-0000-0000-000000000000",
"PeripheralName": "string",
"PeripheralLocation": "string",
"Rounded": true,
"SwipeStatusId": 0,
"SwipeReasonId": 0,
"StartBreakEndTypeId": 0,
"SwipeProcessingTypeId": 0,
"Status_Auto": true,
"Status_Noted": true,
"Swipe_Latitude": 0,
"Swipe_Longitude": 0,
"OutsideSTDistanceAllowed": true
}
],
"SlotNotes": [
{
"SlotNoteId": 0,
"SlotId": 0,
"Note": "string",
"CreatedBy": "string",
"CreatedByName": "string",
"CreatedDate": "2024-11-07T02:04:38.981Z",
"HolidayPayAdjustment": true,
"HiddenFlag": true,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"SlotAudits": [
{
"ActionId": 0,
"CreatedDate": "2024-11-07T02:04:38.981Z",
"Id": 0,
"SlotId": 0,
"OrganisationId": 0,
"Result": "string",
"UserId": "string",
"UserDisplayName": "string"
}
],
"SelectedGameSlotBonuses": [
{
"SlotBonusId": 0,
"SlotId": 0,
"BonusKey": "00000000-0000-0000-0000-000000000000",
"ToBeDeleted": true
}
],
"GameSlotBonuses": [
{
"BonusKey": "00000000-0000-0000-0000-000000000000",
"OrganisationId": 0,
"CustomTypeId": 0,
"Name": "string",
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateMultiplier": 0
}
],
"SlotAdvertisement": {
"AdvertiseId": 0,
"SlotId": 0,
"AdvertiseFrom": "2024-11-07T02:04:38.981Z",
"AdvertiseTo": "2024-11-07T02:04:38.981Z"
},
"SlotTypes": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Persons": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Groups": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Shifts": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Jobs": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"OnlyPayRates": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Adjustments": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Peripherals": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"RotaLockDate": "2024-11-07T02:04:38.981Z",
"PlannedSlots": true,
"DefaultSlotType": "00000000-0000-0000-0000-000000000000",
"HideUnallocatedRow": true,
"ShowFlexiChunksTab": true,
"PayUnplannedSlots": true,
"AutoCreateTaskChunks": true,
"ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY": "string",
"ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<OrganisationId>1</OrganisationId>
<SlotId>1</SlotId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<JobMandatory>true</JobMandatory>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<SlotTypeNoSwipesAllowed>true</SlotTypeNoSwipesAllowed>
<SlotStatusId>0</SlotStatusId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonDisplayName>string</PersonDisplayName>
<PersonalSecurityStatusLevel>1</PersonalSecurityStatusLevel>
<JobName>string</JobName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<ShiftRestDay>true</ShiftRestDay>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<GamePoints>1</GamePoints>
<SlotDate>1</SlotDate>
<SlotDateAsDate>1970-01-01T00:00:00.001Z</SlotDateAsDate>
<DisplayDateStart>1970-01-01T00:00:00.001Z</DisplayDateStart>
<DisplayDateEnd>1970-01-01T00:00:00.001Z</DisplayDateEnd>
<TotalPlannedSeconds>1</TotalPlannedSeconds>
<TotalActualSeconds>1</TotalActualSeconds>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<ShiftPatternHours>true</ShiftPatternHours>
<Published>true</Published>
<PreviousPublished>true</PreviousPublished>
<NoBreaks>0</NoBreaks>
<ActualStartLock>true</ActualStartLock>
<ActualEndLock>true</ActualEndLock>
<LieuStatus>0</LieuStatus>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
<ShiftPatternName>string</ShiftPatternName>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<BonusKeys>string</BonusKeys>
<ProcessingTime>1970-01-01T00:00:00.001Z</ProcessingTime>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<IsWorkingSlot>true</IsWorkingSlot>
<ColourHex>string</ColourHex>
<SwapRequested>true</SwapRequested>
<SlotChunks>
<SlotChunkId>1</SlotChunkId>
<SlotId>1</SlotId>
<SlotChunkTypeId>1</SlotChunkTypeId>
<ChunkTypeName>string</ChunkTypeName>
<Start>1970-01-01T00:00:00.001Z</Start>
<End>1970-01-01T00:00:00.001Z</End>
<ContractedHours>true</ContractedHours>
<TotalSeconds>1</TotalSeconds>
<SlotChunkLockTypeId>0</SlotChunkLockTypeId>
<BreakRuleConditionId>00000000-0000-0000-0000-000000000000</BreakRuleConditionId>
<PayRuleKey>00000000-0000-0000-0000-000000000000</PayRuleKey>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PayRateValue>1.1</PayRateValue>
<PayValue>1.1</PayValue>
<IncludeForPlannedAndActualHours>true</IncludeForPlannedAndActualHours>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</SlotChunks>
<TaskChunks>
<TaskChunkId>1</TaskChunkId>
<SlotId>1</SlotId>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>string</CustomerName>
<ProductId>00000000-0000-0000-0000-000000000000</ProductId>
<ProductName>string</ProductName>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
<TaskName>string</TaskName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<TotalSeconds>1</TotalSeconds>
<EstimatedCost>1.1</EstimatedCost>
<TrueCost>1.1</TrueCost>
<TotalHours>1.1</TotalHours>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</TaskChunks>
<SlotTags>
<SlotTagId>1</SlotTagId>
<SlotId>1</SlotId>
<TagKey>00000000-0000-0000-0000-000000000000</TagKey>
<TagName>string</TagName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<TotalSeconds>1</TotalSeconds>
<Cost>1.1</Cost>
<ToBeDeleted>true</ToBeDeleted>
<ToBeUpdated>true</ToBeUpdated>
</SlotTags>
<SlotAdjustments>
<SlotAdjustmentId>1</SlotAdjustmentId>
<SlotId>1</SlotId>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PayRateType>1</PayRateType>
<PayRateValue>1.1</PayRateValue>
<Quantity>1.1</Quantity>
<PayValue>1.1</PayValue>
<CreatedBy>string</CreatedBy>
<CreatedByName>string</CreatedByName>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<HolidayPayAdjustment>true</HolidayPayAdjustment>
<ToBeDeleted>true</ToBeDeleted>
</SlotAdjustments>
<SlotSwipes>
<SwipeId>1</SwipeId>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<Direction>1</Direction>
<DirectionName>string</DirectionName>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<RevisedDateTime>1970-01-01T00:00:00.001Z</RevisedDateTime>
<SwipeTypeId>1</SwipeTypeId>
<SwipeTypeName>string</SwipeTypeName>
<PeripheralKey>00000000-0000-0000-0000-000000000000</PeripheralKey>
<PeripheralName>string</PeripheralName>
<PeripheralLocation>string</PeripheralLocation>
<Rounded>true</Rounded>
<SwipeStatusId>0</SwipeStatusId>
<SwipeReasonId>0</SwipeReasonId>
<StartBreakEndTypeId>0</StartBreakEndTypeId>
<SwipeProcessingTypeId>0</SwipeProcessingTypeId>
<Status_Auto>true</Status_Auto>
<Status_Noted>true</Status_Noted>
<Swipe_Latitude>1.1</Swipe_Latitude>
<Swipe_Longitude>1.1</Swipe_Longitude>
<OutsideSTDistanceAllowed>true</OutsideSTDistanceAllowed>
</SlotSwipes>
<SlotNotes>
<SlotNoteId>1</SlotNoteId>
<SlotId>1</SlotId>
<Note>string</Note>
<CreatedBy>string</CreatedBy>
<CreatedByName>string</CreatedByName>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<HolidayPayAdjustment>true</HolidayPayAdjustment>
<HiddenFlag>true</HiddenFlag>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</SlotNotes>
<SlotAudits>
<ActionId>1</ActionId>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<Id>1</Id>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<Result>string</Result>
<UserId>string</UserId>
<UserDisplayName>string</UserDisplayName>
</SlotAudits>
<SelectedGameSlotBonuses>
<SlotBonusId>1</SlotBonusId>
<SlotId>1</SlotId>
<BonusKey>00000000-0000-0000-0000-000000000000</BonusKey>
<ToBeDeleted>true</ToBeDeleted>
</SelectedGameSlotBonuses>
<GameSlotBonuses>
<BonusKey>00000000-0000-0000-0000-000000000000</BonusKey>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Name>string</Name>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateMultiplier>1.1</PayRateMultiplier>
</GameSlotBonuses>
<SlotAdvertisement>
<AdvertiseId>1</AdvertiseId>
<SlotId>1</SlotId>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
</SlotAdvertisement>
<SlotTypes>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</SlotTypes>
<Persons>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Persons>
<Groups>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Groups>
<Shifts>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Shifts>
<Jobs>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Jobs>
<OnlyPayRates>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</OnlyPayRates>
<Adjustments>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Adjustments>
<Peripherals>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Peripherals>
<RotaLockDate>1970-01-01T00:00:00.001Z</RotaLockDate>
<PlannedSlots>true</PlannedSlots>
<DefaultSlotType>00000000-0000-0000-0000-000000000000</DefaultSlotType>
<HideUnallocatedRow>true</HideUnallocatedRow>
<ShowFlexiChunksTab>true</ShowFlexiChunksTab>
<PayUnplannedSlots>true</PayUnplannedSlots>
<AutoCreateTaskChunks>true</AutoCreateTaskChunks>
<ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY>string</ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY>
<ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY>string</ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
date query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICE/CONTRACTEDHOURS/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ContractedTimeDto {
ContractedSeconds (number, optional),
DisplayContractedHours (string, optional, read only)
}
{
"ContractedSeconds": 0,
"DisplayContractedHours": "string"
}
<?xml version="1.0"?>
<ContractedTimeDto>
<ContractedSeconds>1.1</ContractedSeconds>
<DisplayContractedHours>string</DisplayContractedHours>
</ContractedTimeDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/SPECIALDAYS/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
SpecialDayId (string, optional),
Name (string, optional),
DateRangeStart (string, optional),
DateRangeEnd (string, optional)
}
[
{
"SpecialDayId": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"DateRangeStart": "2024-11-07T02:04:38.992Z",
"DateRangeEnd": "2024-11-07T02:04:38.992Z"
}
]
<?xml version="1.0"?>
<Inline Model>
<SpecialDayId>00000000-0000-0000-0000-000000000000</SpecialDayId>
<Name>string</Name>
<DateRangeStart>1970-01-01T00:00:00.001Z</DateRangeStart>
<DateRangeEnd>1970-01-01T00:00:00.001Z</DateRangeEnd>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTA/WEEKROTA/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
IncludedDayNumber (boolean, optional),
DayNumber (integer, optional),
Date (string, optional),
SpecialDays (Array[string], optional),
Slots (Array[RotaSlotDto], optional)
}
RotaSlotDto {
SlotId (integer, optional),
GroupId (string, optional),
GroupName (string, optional),
PersonKey (string, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
ColourHex (string, optional),
JobKey (string, optional),
JobName (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
ShiftShortName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
SlotDate (string, optional),
SwipeActualStart (string, optional),
SwipeActualEnd (string, optional),
SwipeRoundedStart (string, optional),
SwipeRoundedEnd (string, optional),
StatusColour (string, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
HasSwipes (boolean, optional),
HasNotes (boolean, optional),
Notes (string, optional),
DisplayActualStartAndEndTimes (string, optional, read only),
DisplayRoundedStartAndEndTimes (string, optional, read only),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayTimes (string, optional, read only),
Published (boolean, optional),
WorkingFlag (boolean, optional),
GamePoints (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
GameBonuses (string, optional),
TotalPlannedSeconds (integer, optional),
TotalActualSeconds (integer, optional),
BreakPlannedSeconds (integer, optional),
BreakActualSeconds (integer, optional),
DisplayBreakPlannedHours (string, optional, read only),
DisplayBreakActualHours (string, optional, read only),
DisplayPlannedHours (string, optional, read only),
DisplayActualHours (string, optional, read only),
CurrencySymbol (string, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
DisplayPlannedCost (string, optional, read only),
DisplayActualCost (string, optional, read only),
DistinctCount (integer, optional),
SwapRequested (boolean, optional),
ShiftPatternHours (boolean, optional),
ShiftPatternDeploymentId (integer, optional)
}
[
{
"IncludedDayNumber": true,
"DayNumber": 0,
"Date": "2024-11-07T02:04:38.994Z",
"SpecialDays": [
"string"
],
"Slots": [
{
"SlotId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"ColourHex": "string",
"JobKey": "00000000-0000-0000-0000-000000000000",
"JobName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"ShiftShortName": "string",
"PlannedStart": "2024-11-07T02:04:38.995Z",
"PlannedEnd": "2024-11-07T02:04:38.995Z",
"ActualStart": "2024-11-07T02:04:38.995Z",
"ActualEnd": "2024-11-07T02:04:38.995Z",
"SlotDate": "2024-11-07T02:04:38.995Z",
"SwipeActualStart": "2024-11-07T02:04:38.995Z",
"SwipeActualEnd": "2024-11-07T02:04:38.995Z",
"SwipeRoundedStart": "2024-11-07T02:04:38.995Z",
"SwipeRoundedEnd": "2024-11-07T02:04:38.995Z",
"StatusColour": "string",
"SlotStatusId": 0,
"HasSwipes": true,
"HasNotes": true,
"Notes": "string",
"DisplayActualStartAndEndTimes": "string",
"DisplayRoundedStartAndEndTimes": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayTimes": "string",
"Published": true,
"WorkingFlag": true,
"GamePoints": 0,
"AdvertiseFrom": "2024-11-07T02:04:38.995Z",
"AdvertiseTo": "2024-11-07T02:04:38.995Z",
"GameBonuses": "string",
"TotalPlannedSeconds": 0,
"TotalActualSeconds": 0,
"BreakPlannedSeconds": 0,
"BreakActualSeconds": 0,
"DisplayBreakPlannedHours": "string",
"DisplayBreakActualHours": "string",
"DisplayPlannedHours": "string",
"DisplayActualHours": "string",
"CurrencySymbol": "string",
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"DisplayPlannedCost": "string",
"DisplayActualCost": "string",
"DistinctCount": 0,
"SwapRequested": true,
"ShiftPatternHours": true,
"ShiftPatternDeploymentId": 0
}
]
}
]
<?xml version="1.0"?>
<Inline Model>
<IncludedDayNumber>true</IncludedDayNumber>
<DayNumber>1</DayNumber>
<Date>1970-01-01T00:00:00.001Z</Date>
<SpecialDays>string</SpecialDays>
<Slots>
<SlotId>1</SlotId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<ColourHex>string</ColourHex>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<JobName>string</JobName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<ShiftShortName>string</ShiftShortName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<SlotDate>1970-01-01T00:00:00.001Z</SlotDate>
<SwipeActualStart>1970-01-01T00:00:00.001Z</SwipeActualStart>
<SwipeActualEnd>1970-01-01T00:00:00.001Z</SwipeActualEnd>
<SwipeRoundedStart>1970-01-01T00:00:00.001Z</SwipeRoundedStart>
<SwipeRoundedEnd>1970-01-01T00:00:00.001Z</SwipeRoundedEnd>
<StatusColour>string</StatusColour>
<SlotStatusId>0</SlotStatusId>
<HasSwipes>true</HasSwipes>
<HasNotes>true</HasNotes>
<Notes>string</Notes>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<DisplayRoundedStartAndEndTimes>string</DisplayRoundedStartAndEndTimes>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayTimes>string</DisplayTimes>
<Published>true</Published>
<WorkingFlag>true</WorkingFlag>
<GamePoints>1</GamePoints>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<GameBonuses>string</GameBonuses>
<TotalPlannedSeconds>1</TotalPlannedSeconds>
<TotalActualSeconds>1</TotalActualSeconds>
<BreakPlannedSeconds>1</BreakPlannedSeconds>
<BreakActualSeconds>1</BreakActualSeconds>
<DisplayBreakPlannedHours>string</DisplayBreakPlannedHours>
<DisplayBreakActualHours>string</DisplayBreakActualHours>
<DisplayPlannedHours>string</DisplayPlannedHours>
<DisplayActualHours>string</DisplayActualHours>
<CurrencySymbol>string</CurrencySymbol>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<DisplayPlannedCost>string</DisplayPlannedCost>
<DisplayActualCost>string</DisplayActualCost>
<DistinctCount>1</DistinctCount>
<SwapRequested>true</SwapRequested>
<ShiftPatternHours>true</ShiftPatternHours>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
</Slots>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTA/WEEKTEAMROTA/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
AmountOfDayRows (integer, optional),
RotaGroup (RotaGroupDto, optional),
GroupHeaders (Array[GroupHeaderDto], optional),
People (Array[RotaPeopleDto], optional)
}
RotaGroupDto {
GroupEnabled (boolean, optional),
GroupId (string, optional),
Path (string, optional),
Name (string, optional),
RotaLockDate (string, optional),
PeriodSlotTypeContainerId (string, optional),
PeriodStart1 (string, optional),
PeriodEnd1 (string, optional),
PeriodStart2 (string, optional),
PeriodEnd2 (string, optional),
PeriodStart3 (string, optional),
PeriodEnd3 (string, optional),
PeriodStart4 (string, optional),
PeriodEnd4 (string, optional),
HideUnallocatedRow (boolean, optional),
OverallPlannedHours (number, optional),
DisplayOverallPlannedHours (string, optional, read only),
OverallActualHours (number, optional),
DisplayOverallActualHours (string, optional, read only),
OverallPlannedBudgetHours (number, optional),
DisplayOverallPlannedBudgetHours (string, optional, read only),
CurrencySymbol (string, optional),
OverallPlannedCost (number, optional),
DisplayOverallPlannedCost (string, optional, read only),
OverallActualCost (number, optional),
DisplayOverallActualCost (string, optional, read only),
OverallPlannedBudgetCost (number, optional),
DisplayOverallPlannedBudgetCost (string, optional, read only),
OverallTotalShiftPeriodHeadCount
(Array[CalculatedShiftPeriodHeadCountDto], optional),
DisplayOverallTotalShiftPeriodHeadCount (Array[string], optional, read
only),
OverallTotalBudgetShiftPeriodHeadCount
(Array[CalculatedShiftPeriodHeadCountDto], optional),
DisplayOverallTotalBudgetShiftPeriodHeadCount (Array[string], optional,
read only)
}
GroupHeaderDto {
TotalPlannedHours (number, optional),
DisplayTotalPlannedHours (string, optional, read only),
TotalActualHours (number, optional),
DisplayTotalActualHours (string, optional, read only),
CurrencySymbol (string, optional),
TotalPlannedCost (number, optional),
DisplayTotalPlannedCost (string, optional, read only),
TotalActualCost (number, optional),
DisplayTotalActualCost (string, optional, read only),
TotalPlannedBudgetHours (number, optional),
DisplayTotalPlannedBudgetHours (string, optional, read only),
OverPlannedBudgetHours (boolean, optional),
OverActualBudgetHours (boolean, optional),
TotalPlannedBudgetCost (number, optional),
DisplayTotalPlannedBudgetCost (string, optional, read only),
OverPlannedBudgetCost (boolean, optional),
OverActualBudgetCost (boolean, optional),
TotalPlannedHeadCount (integer, optional),
TotalActualHeadCount (integer, optional),
TotalShiftPeriodHeadCount (Array[CalculatedShiftPeriodHeadCountDto],
optional),
DisplayTotalShiftPeriodHeadCount (Array[string], optional, read only),
DayOfWeek (integer, optional) = ['1', '2', '3', '4', '5', '6', '7']
integerEnum:1, 2, 3, 4, 5, 6, 7
}
RotaPeopleDto {
PersonKey (string, optional),
DisplayName (string, optional),
FirstName (string, optional),
LastName (string, optional),
HasPermission (boolean, optional),
CanAddRota (boolean, optional),
CanEditRota (boolean, optional),
TotalPlannedHours (number, optional),
TotalActualHours (number, optional),
TotalContractedHours (number, optional),
OverContractedHours (boolean, optional),
DisplayTotalPlannedHours (string, optional, read only),
DisplayTotalActualHours (string, optional, read only),
DisplayTotalContractedHours (string, optional, read only),
CurrencySymbol (string, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
DisplayTotalPlannedCost (string, optional, read only),
DisplayTotalActualCost (string, optional, read only),
PersonsDays (Array[RotaDayDto], optional),
DetailedDay (RotaPersonDetailedDayDto, optional),
HighestNumberOfSlotsInOneDay (integer, optional),
DefaultJobName (string, optional)
}
CalculatedShiftPeriodHeadCountDto {
ShiftPeriodName (string, optional),
BudgetHeadCount (integer, optional),
PlannedHeadCount (integer, optional),
ActualHeadCount (integer, optional),
OverPlannedHeadCount (boolean, optional),
OverActualHeadCount (boolean, optional)
}
RotaDayDto {
SlotsInDay (Array[RotaSlotDto], optional),
NumberOfSlotsInDay (integer, optional, read only),
GhostSlotsInDay (Array[RotaGhostSlotDto], optional),
DayOfWeek (integer, optional) = ['1', '2', '3', '4', '5', '6', '7']
integerEnum:1, 2, 3, 4, 5, 6, 7
,
IsToday (boolean, optional),
IsSpecialDay (boolean, optional),
SlotDayCSS (string, optional, read only),
CellTitle (string, optional),
CellNumber (integer, optional),
IsNoShow (boolean, optional),
NoShowCSS (string, optional, read only),
IsPersonUnemployed (boolean, optional),
PersonUnemployedCSS (string, optional, read only),
IsCellDisabled (boolean, optional),
CellDisabledCSS (string, optional, read only),
IsRotaLocked (boolean, optional)
}
RotaPersonDetailedDayDto {
Slots (Array[RotaSlotWithChunks], optional)
}
RotaSlotDto {
SlotId (integer, optional),
GroupId (string, optional),
GroupName (string, optional),
PersonKey (string, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
ColourHex (string, optional),
JobKey (string, optional),
JobName (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
ShiftShortName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
SlotDate (string, optional),
SwipeActualStart (string, optional),
SwipeActualEnd (string, optional),
SwipeRoundedStart (string, optional),
SwipeRoundedEnd (string, optional),
StatusColour (string, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
HasSwipes (boolean, optional),
HasNotes (boolean, optional),
Notes (string, optional),
DisplayActualStartAndEndTimes (string, optional, read only),
DisplayRoundedStartAndEndTimes (string, optional, read only),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayTimes (string, optional, read only),
Published (boolean, optional),
WorkingFlag (boolean, optional),
GamePoints (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
GameBonuses (string, optional),
TotalPlannedSeconds (integer, optional),
TotalActualSeconds (integer, optional),
BreakPlannedSeconds (integer, optional),
BreakActualSeconds (integer, optional),
DisplayBreakPlannedHours (string, optional, read only),
DisplayBreakActualHours (string, optional, read only),
DisplayPlannedHours (string, optional, read only),
DisplayActualHours (string, optional, read only),
CurrencySymbol (string, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
DisplayPlannedCost (string, optional, read only),
DisplayActualCost (string, optional, read only),
DistinctCount (integer, optional),
SwapRequested (boolean, optional),
ShiftPatternHours (boolean, optional),
ShiftPatternDeploymentId (integer, optional)
}
RotaGhostSlotDto {
PlannedStart (string, optional),
PlannedEnd (string, optional),
DisplayStartTime (string, optional, read only),
ActualStart (string, optional),
ActualEnd (string, optional),
DisplayEndTime (string, optional, read only),
GroupName (string, optional),
SlotTypeName (string, optional),
ColourHex (string, optional)
}
RotaSlotWithChunks {
SlotId (integer, optional),
PlannedSlotChunks (Array[RotaSlotGanttChartChunk], optional),
ActualSlotChunks (Array[RotaSlotGanttChartChunk], optional)
}
RotaSlotGanttChartChunk {
SlotChunkId (integer, optional),
SlotId (integer, optional),
SlotCategoryColour (string, optional),
IsBlankGantt (boolean, optional),
SlotChunkTypeId (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
StartTime (string, optional),
EndTime (string, optional),
Cost (number, optional),
PercentageOfDay (number, optional),
PercentageOfDayString (string, optional, read only),
DisplayTimes (string, optional, read only)
}
[
{
"AmountOfDayRows": 0,
"RotaGroup": {
"GroupEnabled": true,
"GroupId": "00000000-0000-0000-0000-000000000000",
"Path": "string",
"Name": "string",
"RotaLockDate": "2024-11-07T02:04:38.999Z",
"PeriodSlotTypeContainerId": "00000000-0000-0000-0000-000000000000",
"PeriodStart1": "string",
"PeriodEnd1": "string",
"PeriodStart2": "string",
"PeriodEnd2": "string",
"PeriodStart3": "string",
"PeriodEnd3": "string",
"PeriodStart4": "string",
"PeriodEnd4": "string",
"HideUnallocatedRow": true,
"OverallPlannedHours": 0,
"DisplayOverallPlannedHours": "string",
"OverallActualHours": 0,
"DisplayOverallActualHours": "string",
"OverallPlannedBudgetHours": 0,
"DisplayOverallPlannedBudgetHours": "string",
"CurrencySymbol": "string",
"OverallPlannedCost": 0,
"DisplayOverallPlannedCost": "string",
"OverallActualCost": 0,
"DisplayOverallActualCost": "string",
"OverallPlannedBudgetCost": 0,
"DisplayOverallPlannedBudgetCost": "string",
"OverallTotalShiftPeriodHeadCount": [
{
"ShiftPeriodName": "string",
"BudgetHeadCount": 0,
"PlannedHeadCount": 0,
"ActualHeadCount": 0,
"OverPlannedHeadCount": true,
"OverActualHeadCount": true
}
],
"DisplayOverallTotalShiftPeriodHeadCount": [
"string"
],
"OverallTotalBudgetShiftPeriodHeadCount": [
{
"ShiftPeriodName": "string",
"BudgetHeadCount": 0,
"PlannedHeadCount": 0,
"ActualHeadCount": 0,
"OverPlannedHeadCount": true,
"OverActualHeadCount": true
}
],
"DisplayOverallTotalBudgetShiftPeriodHeadCount": [
"string"
]
},
"GroupHeaders": [
{
"TotalPlannedHours": 0,
"DisplayTotalPlannedHours": "string",
"TotalActualHours": 0,
"DisplayTotalActualHours": "string",
"CurrencySymbol": "string",
"TotalPlannedCost": 0,
"DisplayTotalPlannedCost": "string",
"TotalActualCost": 0,
"DisplayTotalActualCost": "string",
"TotalPlannedBudgetHours": 0,
"DisplayTotalPlannedBudgetHours": "string",
"OverPlannedBudgetHours": true,
"OverActualBudgetHours": true,
"TotalPlannedBudgetCost": 0,
"DisplayTotalPlannedBudgetCost": "string",
"OverPlannedBudgetCost": true,
"OverActualBudgetCost": true,
"TotalPlannedHeadCount": 0,
"TotalActualHeadCount": 0,
"TotalShiftPeriodHeadCount": [
{
"ShiftPeriodName": "string",
"BudgetHeadCount": 0,
"PlannedHeadCount": 0,
"ActualHeadCount": 0,
"OverPlannedHeadCount": true,
"OverActualHeadCount": true
}
],
"DisplayTotalShiftPeriodHeadCount": [
"string"
],
"DayOfWeek": 1
}
],
"People": [
{
"PersonKey": "00000000-0000-0000-0000-000000000000",
"DisplayName": "string",
"FirstName": "string",
"LastName": "string",
"HasPermission": true,
"CanAddRota": true,
"CanEditRota": true,
"TotalPlannedHours": 0,
"TotalActualHours": 0,
"TotalContractedHours": 0,
"OverContractedHours": true,
"DisplayTotalPlannedHours": "string",
"DisplayTotalActualHours": "string",
"DisplayTotalContractedHours": "string",
"CurrencySymbol": "string",
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"DisplayTotalPlannedCost": "string",
"DisplayTotalActualCost": "string",
"PersonsDays": [
{
"SlotsInDay": [
{
"SlotId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"ColourHex": "string",
"JobKey": "00000000-0000-0000-0000-000000000000",
"JobName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"ShiftShortName": "string",
"PlannedStart": "2024-11-07T02:04:38.999Z",
"PlannedEnd": "2024-11-07T02:04:38.999Z",
"ActualStart": "2024-11-07T02:04:38.999Z",
"ActualEnd": "2024-11-07T02:04:38.999Z",
"SlotDate": "2024-11-07T02:04:38.999Z",
"SwipeActualStart": "2024-11-07T02:04:38.999Z",
"SwipeActualEnd": "2024-11-07T02:04:38.999Z",
"SwipeRoundedStart": "2024-11-07T02:04:38.999Z",
"SwipeRoundedEnd": "2024-11-07T02:04:38.999Z",
"StatusColour": "string",
"SlotStatusId": 0,
"HasSwipes": true,
"HasNotes": true,
"Notes": "string",
"DisplayActualStartAndEndTimes": "string",
"DisplayRoundedStartAndEndTimes": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayTimes": "string",
"Published": true,
"WorkingFlag": true,
"GamePoints": 0,
"AdvertiseFrom": "2024-11-07T02:04:38.999Z",
"AdvertiseTo": "2024-11-07T02:04:38.999Z",
"GameBonuses": "string",
"TotalPlannedSeconds": 0,
"TotalActualSeconds": 0,
"BreakPlannedSeconds": 0,
"BreakActualSeconds": 0,
"DisplayBreakPlannedHours": "string",
"DisplayBreakActualHours": "string",
"DisplayPlannedHours": "string",
"DisplayActualHours": "string",
"CurrencySymbol": "string",
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"DisplayPlannedCost": "string",
"DisplayActualCost": "string",
"DistinctCount": 0,
"SwapRequested": true,
"ShiftPatternHours": true,
"ShiftPatternDeploymentId": 0
}
],
"NumberOfSlotsInDay": 0,
"GhostSlotsInDay": [
{
"PlannedStart": "2024-11-07T02:04:38.999Z",
"PlannedEnd": "2024-11-07T02:04:38.999Z",
"DisplayStartTime": "string",
"ActualStart": "2024-11-07T02:04:38.999Z",
"ActualEnd": "2024-11-07T02:04:38.999Z",
"DisplayEndTime": "string",
"GroupName": "string",
"SlotTypeName": "string",
"ColourHex": "string"
}
],
"DayOfWeek": 1,
"IsToday": true,
"IsSpecialDay": true,
"SlotDayCSS": "string",
"CellTitle": "string",
"CellNumber": 0,
"IsNoShow": true,
"NoShowCSS": "string",
"IsPersonUnemployed": true,
"PersonUnemployedCSS": "string",
"IsCellDisabled": true,
"CellDisabledCSS": "string",
"IsRotaLocked": true
}
],
"DetailedDay": {
"Slots": [
{
"SlotId": 0,
"PlannedSlotChunks": [
{
"SlotChunkId": 0,
"SlotId": 0,
"SlotCategoryColour": "string",
"IsBlankGantt": true,
"SlotChunkTypeId": 1,
"StartTime": "string",
"EndTime": "string",
"Cost": 0,
"PercentageOfDay": 0,
"PercentageOfDayString": "string",
"DisplayTimes": "string"
}
],
"ActualSlotChunks": [
{
"SlotChunkId": 0,
"SlotId": 0,
"SlotCategoryColour": "string",
"IsBlankGantt": true,
"SlotChunkTypeId": 1,
"StartTime": "string",
"EndTime": "string",
"Cost": 0,
"PercentageOfDay": 0,
"PercentageOfDayString": "string",
"DisplayTimes": "string"
}
]
}
]
},
"HighestNumberOfSlotsInOneDay": 0,
"DefaultJobName": "string"
}
]
}
]
<?xml version="1.0"?>
<Inline Model>
<AmountOfDayRows>1</AmountOfDayRows>
<RotaGroup>
<GroupEnabled>true</GroupEnabled>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<Path>string</Path>
<Name>string</Name>
<RotaLockDate>1970-01-01T00:00:00.001Z</RotaLockDate>
<PeriodSlotTypeContainerId>00000000-0000-0000-0000-000000000000</PeriodSlotTypeContainerId>
<PeriodStart1>string</PeriodStart1>
<PeriodEnd1>string</PeriodEnd1>
<PeriodStart2>string</PeriodStart2>
<PeriodEnd2>string</PeriodEnd2>
<PeriodStart3>string</PeriodStart3>
<PeriodEnd3>string</PeriodEnd3>
<PeriodStart4>string</PeriodStart4>
<PeriodEnd4>string</PeriodEnd4>
<HideUnallocatedRow>true</HideUnallocatedRow>
<OverallPlannedHours>1.1</OverallPlannedHours>
<DisplayOverallPlannedHours>string</DisplayOverallPlannedHours>
<OverallActualHours>1.1</OverallActualHours>
<DisplayOverallActualHours>string</DisplayOverallActualHours>
<OverallPlannedBudgetHours>1.1</OverallPlannedBudgetHours>
<DisplayOverallPlannedBudgetHours>string</DisplayOverallPlannedBudgetHours>
<CurrencySymbol>string</CurrencySymbol>
<OverallPlannedCost>1.1</OverallPlannedCost>
<DisplayOverallPlannedCost>string</DisplayOverallPlannedCost>
<OverallActualCost>1.1</OverallActualCost>
<DisplayOverallActualCost>string</DisplayOverallActualCost>
<OverallPlannedBudgetCost>1.1</OverallPlannedBudgetCost>
<DisplayOverallPlannedBudgetCost>string</DisplayOverallPlannedBudgetCost>
<OverallTotalShiftPeriodHeadCount>
<ShiftPeriodName>string</ShiftPeriodName>
<BudgetHeadCount>1</BudgetHeadCount>
<PlannedHeadCount>1</PlannedHeadCount>
<ActualHeadCount>1</ActualHeadCount>
<OverPlannedHeadCount>true</OverPlannedHeadCount>
<OverActualHeadCount>true</OverActualHeadCount>
</OverallTotalShiftPeriodHeadCount>
<DisplayOverallTotalShiftPeriodHeadCount>string</DisplayOverallTotalShiftPeriodHeadCount>
<OverallTotalBudgetShiftPeriodHeadCount>
<ShiftPeriodName>string</ShiftPeriodName>
<BudgetHeadCount>1</BudgetHeadCount>
<PlannedHeadCount>1</PlannedHeadCount>
<ActualHeadCount>1</ActualHeadCount>
<OverPlannedHeadCount>true</OverPlannedHeadCount>
<OverActualHeadCount>true</OverActualHeadCount>
</OverallTotalBudgetShiftPeriodHeadCount>
<DisplayOverallTotalBudgetShiftPeriodHeadCount>string</DisplayOverallTotalBudgetShiftPeriodHeadCount>
</RotaGroup>
<GroupHeaders>
<TotalPlannedHours>1.1</TotalPlannedHours>
<DisplayTotalPlannedHours>string</DisplayTotalPlannedHours>
<TotalActualHours>1.1</TotalActualHours>
<DisplayTotalActualHours>string</DisplayTotalActualHours>
<CurrencySymbol>string</CurrencySymbol>
<TotalPlannedCost>1.1</TotalPlannedCost>
<DisplayTotalPlannedCost>string</DisplayTotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<DisplayTotalActualCost>string</DisplayTotalActualCost>
<TotalPlannedBudgetHours>1.1</TotalPlannedBudgetHours>
<DisplayTotalPlannedBudgetHours>string</DisplayTotalPlannedBudgetHours>
<OverPlannedBudgetHours>true</OverPlannedBudgetHours>
<OverActualBudgetHours>true</OverActualBudgetHours>
<TotalPlannedBudgetCost>1.1</TotalPlannedBudgetCost>
<DisplayTotalPlannedBudgetCost>string</DisplayTotalPlannedBudgetCost>
<OverPlannedBudgetCost>true</OverPlannedBudgetCost>
<OverActualBudgetCost>true</OverActualBudgetCost>
<TotalPlannedHeadCount>1</TotalPlannedHeadCount>
<TotalActualHeadCount>1</TotalActualHeadCount>
<TotalShiftPeriodHeadCount>
<ShiftPeriodName>string</ShiftPeriodName>
<BudgetHeadCount>1</BudgetHeadCount>
<PlannedHeadCount>1</PlannedHeadCount>
<ActualHeadCount>1</ActualHeadCount>
<OverPlannedHeadCount>true</OverPlannedHeadCount>
<OverActualHeadCount>true</OverActualHeadCount>
</TotalShiftPeriodHeadCount>
<DisplayTotalShiftPeriodHeadCount>string</DisplayTotalShiftPeriodHeadCount>
<DayOfWeek>1</DayOfWeek>
</GroupHeaders>
<People>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<DisplayName>string</DisplayName>
<FirstName>string</FirstName>
<LastName>string</LastName>
<HasPermission>true</HasPermission>
<CanAddRota>true</CanAddRota>
<CanEditRota>true</CanEditRota>
<TotalPlannedHours>1.1</TotalPlannedHours>
<TotalActualHours>1.1</TotalActualHours>
<TotalContractedHours>1.1</TotalContractedHours>
<OverContractedHours>true</OverContractedHours>
<DisplayTotalPlannedHours>string</DisplayTotalPlannedHours>
<DisplayTotalActualHours>string</DisplayTotalActualHours>
<DisplayTotalContractedHours>string</DisplayTotalContractedHours>
<CurrencySymbol>string</CurrencySymbol>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<DisplayTotalPlannedCost>string</DisplayTotalPlannedCost>
<DisplayTotalActualCost>string</DisplayTotalActualCost>
<PersonsDays>
<SlotsInDay>
<SlotId>1</SlotId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<ColourHex>string</ColourHex>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<JobName>string</JobName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<ShiftShortName>string</ShiftShortName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<SlotDate>1970-01-01T00:00:00.001Z</SlotDate>
<SwipeActualStart>1970-01-01T00:00:00.001Z</SwipeActualStart>
<SwipeActualEnd>1970-01-01T00:00:00.001Z</SwipeActualEnd>
<SwipeRoundedStart>1970-01-01T00:00:00.001Z</SwipeRoundedStart>
<SwipeRoundedEnd>1970-01-01T00:00:00.001Z</SwipeRoundedEnd>
<StatusColour>string</StatusColour>
<SlotStatusId>0</SlotStatusId>
<HasSwipes>true</HasSwipes>
<HasNotes>true</HasNotes>
<Notes>string</Notes>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<DisplayRoundedStartAndEndTimes>string</DisplayRoundedStartAndEndTimes>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayTimes>string</DisplayTimes>
<Published>true</Published>
<WorkingFlag>true</WorkingFlag>
<GamePoints>1</GamePoints>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<GameBonuses>string</GameBonuses>
<TotalPlannedSeconds>1</TotalPlannedSeconds>
<TotalActualSeconds>1</TotalActualSeconds>
<BreakPlannedSeconds>1</BreakPlannedSeconds>
<BreakActualSeconds>1</BreakActualSeconds>
<DisplayBreakPlannedHours>string</DisplayBreakPlannedHours>
<DisplayBreakActualHours>string</DisplayBreakActualHours>
<DisplayPlannedHours>string</DisplayPlannedHours>
<DisplayActualHours>string</DisplayActualHours>
<CurrencySymbol>string</CurrencySymbol>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<DisplayPlannedCost>string</DisplayPlannedCost>
<DisplayActualCost>string</DisplayActualCost>
<DistinctCount>1</DistinctCount>
<SwapRequested>true</SwapRequested>
<ShiftPatternHours>true</ShiftPatternHours>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
</SlotsInDay>
<NumberOfSlotsInDay>1</NumberOfSlotsInDay>
<GhostSlotsInDay>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<DisplayStartTime>string</DisplayStartTime>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<DisplayEndTime>string</DisplayEndTime>
<GroupName>string</GroupName>
<SlotTypeName>string</SlotTypeName>
<ColourHex>string</ColourHex>
</GhostSlotsInDay>
<DayOfWeek>1</DayOfWeek>
<IsToday>true</IsToday>
<IsSpecialDay>true</IsSpecialDay>
<SlotDayCSS>string</SlotDayCSS>
<CellTitle>string</CellTitle>
<CellNumber>1</CellNumber>
<IsNoShow>true</IsNoShow>
<NoShowCSS>string</NoShowCSS>
<IsPersonUnemployed>true</IsPersonUnemployed>
<PersonUnemployedCSS>string</PersonUnemployedCSS>
<IsCellDisabled>true</IsCellDisabled>
<CellDisabledCSS>string</CellDisabledCSS>
<IsRotaLocked>true</IsRotaLocked>
</PersonsDays>
<DetailedDay>
<Slots>
<SlotId>1</SlotId>
<PlannedSlotChunks>
<SlotChunkId>1</SlotChunkId>
<SlotId>1</SlotId>
<SlotCategoryColour>string</SlotCategoryColour>
<IsBlankGantt>true</IsBlankGantt>
<SlotChunkTypeId>1</SlotChunkTypeId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Cost>1.1</Cost>
<PercentageOfDay>1.1</PercentageOfDay>
<PercentageOfDayString>string</PercentageOfDayString>
<DisplayTimes>string</DisplayTimes>
</PlannedSlotChunks>
<ActualSlotChunks>
<SlotChunkId>1</SlotChunkId>
<SlotId>1</SlotId>
<SlotCategoryColour>string</SlotCategoryColour>
<IsBlankGantt>true</IsBlankGantt>
<SlotChunkTypeId>1</SlotChunkTypeId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Cost>1.1</Cost>
<PercentageOfDay>1.1</PercentageOfDay>
<PercentageOfDayString>string</PercentageOfDayString>
<DisplayTimes>string</DisplayTimes>
</ActualSlotChunks>
</Slots>
</DetailedDay>
<HighestNumberOfSlotsInOneDay>1</HighestNumberOfSlotsInOneDay>
<DefaultJobName>string</DefaultJobName>
</People>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTA/MONTHROTA/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
WeekRow (Array[RotaIndividualPersonDayDto], optional)
}
RotaIndividualPersonDayDto {
IncludedDayNumber (boolean, optional),
DayNumber (integer, optional),
Date (string, optional),
SpecialDays (Array[string], optional),
Slots (Array[RotaSlotDto], optional)
}
RotaSlotDto {
SlotId (integer, optional),
GroupId (string, optional),
GroupName (string, optional),
PersonKey (string, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
ColourHex (string, optional),
JobKey (string, optional),
JobName (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
ShiftShortName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
SlotDate (string, optional),
SwipeActualStart (string, optional),
SwipeActualEnd (string, optional),
SwipeRoundedStart (string, optional),
SwipeRoundedEnd (string, optional),
StatusColour (string, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
HasSwipes (boolean, optional),
HasNotes (boolean, optional),
Notes (string, optional),
DisplayActualStartAndEndTimes (string, optional, read only),
DisplayRoundedStartAndEndTimes (string, optional, read only),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayTimes (string, optional, read only),
Published (boolean, optional),
WorkingFlag (boolean, optional),
GamePoints (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
GameBonuses (string, optional),
TotalPlannedSeconds (integer, optional),
TotalActualSeconds (integer, optional),
BreakPlannedSeconds (integer, optional),
BreakActualSeconds (integer, optional),
DisplayBreakPlannedHours (string, optional, read only),
DisplayBreakActualHours (string, optional, read only),
DisplayPlannedHours (string, optional, read only),
DisplayActualHours (string, optional, read only),
CurrencySymbol (string, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
DisplayPlannedCost (string, optional, read only),
DisplayActualCost (string, optional, read only),
DistinctCount (integer, optional),
SwapRequested (boolean, optional),
ShiftPatternHours (boolean, optional),
ShiftPatternDeploymentId (integer, optional)
}
[
{
"WeekRow": [
{
"IncludedDayNumber": true,
"DayNumber": 0,
"Date": "2024-11-07T02:04:39.012Z",
"SpecialDays": [
"string"
],
"Slots": [
{
"SlotId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"ColourHex": "string",
"JobKey": "00000000-0000-0000-0000-000000000000",
"JobName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"ShiftShortName": "string",
"PlannedStart": "2024-11-07T02:04:39.012Z",
"PlannedEnd": "2024-11-07T02:04:39.012Z",
"ActualStart": "2024-11-07T02:04:39.012Z",
"ActualEnd": "2024-11-07T02:04:39.012Z",
"SlotDate": "2024-11-07T02:04:39.012Z",
"SwipeActualStart": "2024-11-07T02:04:39.012Z",
"SwipeActualEnd": "2024-11-07T02:04:39.012Z",
"SwipeRoundedStart": "2024-11-07T02:04:39.012Z",
"SwipeRoundedEnd": "2024-11-07T02:04:39.012Z",
"StatusColour": "string",
"SlotStatusId": 0,
"HasSwipes": true,
"HasNotes": true,
"Notes": "string",
"DisplayActualStartAndEndTimes": "string",
"DisplayRoundedStartAndEndTimes": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayTimes": "string",
"Published": true,
"WorkingFlag": true,
"GamePoints": 0,
"AdvertiseFrom": "2024-11-07T02:04:39.012Z",
"AdvertiseTo": "2024-11-07T02:04:39.012Z",
"GameBonuses": "string",
"TotalPlannedSeconds": 0,
"TotalActualSeconds": 0,
"BreakPlannedSeconds": 0,
"BreakActualSeconds": 0,
"DisplayBreakPlannedHours": "string",
"DisplayBreakActualHours": "string",
"DisplayPlannedHours": "string",
"DisplayActualHours": "string",
"CurrencySymbol": "string",
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"DisplayPlannedCost": "string",
"DisplayActualCost": "string",
"DistinctCount": 0,
"SwapRequested": true,
"ShiftPatternHours": true,
"ShiftPatternDeploymentId": 0
}
]
}
]
}
]
<?xml version="1.0"?>
<Inline Model>
<WeekRow>
<IncludedDayNumber>true</IncludedDayNumber>
<DayNumber>1</DayNumber>
<Date>1970-01-01T00:00:00.001Z</Date>
<SpecialDays>string</SpecialDays>
<Slots>
<SlotId>1</SlotId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<ColourHex>string</ColourHex>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<JobName>string</JobName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<ShiftShortName>string</ShiftShortName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<SlotDate>1970-01-01T00:00:00.001Z</SlotDate>
<SwipeActualStart>1970-01-01T00:00:00.001Z</SwipeActualStart>
<SwipeActualEnd>1970-01-01T00:00:00.001Z</SwipeActualEnd>
<SwipeRoundedStart>1970-01-01T00:00:00.001Z</SwipeRoundedStart>
<SwipeRoundedEnd>1970-01-01T00:00:00.001Z</SwipeRoundedEnd>
<StatusColour>string</StatusColour>
<SlotStatusId>0</SlotStatusId>
<HasSwipes>true</HasSwipes>
<HasNotes>true</HasNotes>
<Notes>string</Notes>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<DisplayRoundedStartAndEndTimes>string</DisplayRoundedStartAndEndTimes>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayTimes>string</DisplayTimes>
<Published>true</Published>
<WorkingFlag>true</WorkingFlag>
<GamePoints>1</GamePoints>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<GameBonuses>string</GameBonuses>
<TotalPlannedSeconds>1</TotalPlannedSeconds>
<TotalActualSeconds>1</TotalActualSeconds>
<BreakPlannedSeconds>1</BreakPlannedSeconds>
<BreakActualSeconds>1</BreakActualSeconds>
<DisplayBreakPlannedHours>string</DisplayBreakPlannedHours>
<DisplayBreakActualHours>string</DisplayBreakActualHours>
<DisplayPlannedHours>string</DisplayPlannedHours>
<DisplayActualHours>string</DisplayActualHours>
<CurrencySymbol>string</CurrencySymbol>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<DisplayPlannedCost>string</DisplayPlannedCost>
<DisplayActualCost>string</DisplayActualCost>
<DistinctCount>1</DistinctCount>
<SwapRequested>true</SwapRequested>
<ShiftPatternHours>true</ShiftPatternHours>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
</Slots>
</WeekRow>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTA/YEARROTA/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
StartMonthDate (string, optional),
PlannedHours (number, optional),
ActualHours (number, optional),
PlannedCost (number, optional),
ActualCost (number, optional),
MonthRow (Array[RotaIndividualMonthPersonDto], optional)
}
RotaIndividualMonthPersonDto {
WeekRow (Array[RotaIndividualPersonDayDto], optional)
}
RotaIndividualPersonDayDto {
IncludedDayNumber (boolean, optional),
DayNumber (integer, optional),
Date (string, optional),
SpecialDays (Array[string], optional),
Slots (Array[RotaSlotDto], optional)
}
RotaSlotDto {
SlotId (integer, optional),
GroupId (string, optional),
GroupName (string, optional),
PersonKey (string, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
ColourHex (string, optional),
JobKey (string, optional),
JobName (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
ShiftShortName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
SlotDate (string, optional),
SwipeActualStart (string, optional),
SwipeActualEnd (string, optional),
SwipeRoundedStart (string, optional),
SwipeRoundedEnd (string, optional),
StatusColour (string, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
HasSwipes (boolean, optional),
HasNotes (boolean, optional),
Notes (string, optional),
DisplayActualStartAndEndTimes (string, optional, read only),
DisplayRoundedStartAndEndTimes (string, optional, read only),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayTimes (string, optional, read only),
Published (boolean, optional),
WorkingFlag (boolean, optional),
GamePoints (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
GameBonuses (string, optional),
TotalPlannedSeconds (integer, optional),
TotalActualSeconds (integer, optional),
BreakPlannedSeconds (integer, optional),
BreakActualSeconds (integer, optional),
DisplayBreakPlannedHours (string, optional, read only),
DisplayBreakActualHours (string, optional, read only),
DisplayPlannedHours (string, optional, read only),
DisplayActualHours (string, optional, read only),
CurrencySymbol (string, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
DisplayPlannedCost (string, optional, read only),
DisplayActualCost (string, optional, read only),
DistinctCount (integer, optional),
SwapRequested (boolean, optional),
ShiftPatternHours (boolean, optional),
ShiftPatternDeploymentId (integer, optional)
}
[
{
"StartMonthDate": "2024-11-07T02:04:39.015Z",
"PlannedHours": 0,
"ActualHours": 0,
"PlannedCost": 0,
"ActualCost": 0,
"MonthRow": [
{
"WeekRow": [
{
"IncludedDayNumber": true,
"DayNumber": 0,
"Date": "2024-11-07T02:04:39.015Z",
"SpecialDays": [
"string"
],
"Slots": [
{
"SlotId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"ColourHex": "string",
"JobKey": "00000000-0000-0000-0000-000000000000",
"JobName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"ShiftShortName": "string",
"PlannedStart": "2024-11-07T02:04:39.015Z",
"PlannedEnd": "2024-11-07T02:04:39.015Z",
"ActualStart": "2024-11-07T02:04:39.015Z",
"ActualEnd": "2024-11-07T02:04:39.015Z",
"SlotDate": "2024-11-07T02:04:39.015Z",
"SwipeActualStart": "2024-11-07T02:04:39.015Z",
"SwipeActualEnd": "2024-11-07T02:04:39.015Z",
"SwipeRoundedStart": "2024-11-07T02:04:39.015Z",
"SwipeRoundedEnd": "2024-11-07T02:04:39.015Z",
"StatusColour": "string",
"SlotStatusId": 0,
"HasSwipes": true,
"HasNotes": true,
"Notes": "string",
"DisplayActualStartAndEndTimes": "string",
"DisplayRoundedStartAndEndTimes": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayTimes": "string",
"Published": true,
"WorkingFlag": true,
"GamePoints": 0,
"AdvertiseFrom": "2024-11-07T02:04:39.015Z",
"AdvertiseTo": "2024-11-07T02:04:39.015Z",
"GameBonuses": "string",
"TotalPlannedSeconds": 0,
"TotalActualSeconds": 0,
"BreakPlannedSeconds": 0,
"BreakActualSeconds": 0,
"DisplayBreakPlannedHours": "string",
"DisplayBreakActualHours": "string",
"DisplayPlannedHours": "string",
"DisplayActualHours": "string",
"CurrencySymbol": "string",
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"DisplayPlannedCost": "string",
"DisplayActualCost": "string",
"DistinctCount": 0,
"SwapRequested": true,
"ShiftPatternHours": true,
"ShiftPatternDeploymentId": 0
}
]
}
]
}
]
}
]
<?xml version="1.0"?>
<Inline Model>
<StartMonthDate>1970-01-01T00:00:00.001Z</StartMonthDate>
<PlannedHours>1.1</PlannedHours>
<ActualHours>1.1</ActualHours>
<PlannedCost>1.1</PlannedCost>
<ActualCost>1.1</ActualCost>
<MonthRow>
<WeekRow>
<IncludedDayNumber>true</IncludedDayNumber>
<DayNumber>1</DayNumber>
<Date>1970-01-01T00:00:00.001Z</Date>
<SpecialDays>string</SpecialDays>
<Slots>
<SlotId>1</SlotId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<ColourHex>string</ColourHex>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<JobName>string</JobName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<ShiftShortName>string</ShiftShortName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<SlotDate>1970-01-01T00:00:00.001Z</SlotDate>
<SwipeActualStart>1970-01-01T00:00:00.001Z</SwipeActualStart>
<SwipeActualEnd>1970-01-01T00:00:00.001Z</SwipeActualEnd>
<SwipeRoundedStart>1970-01-01T00:00:00.001Z</SwipeRoundedStart>
<SwipeRoundedEnd>1970-01-01T00:00:00.001Z</SwipeRoundedEnd>
<StatusColour>string</StatusColour>
<SlotStatusId>0</SlotStatusId>
<HasSwipes>true</HasSwipes>
<HasNotes>true</HasNotes>
<Notes>string</Notes>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<DisplayRoundedStartAndEndTimes>string</DisplayRoundedStartAndEndTimes>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayTimes>string</DisplayTimes>
<Published>true</Published>
<WorkingFlag>true</WorkingFlag>
<GamePoints>1</GamePoints>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<GameBonuses>string</GameBonuses>
<TotalPlannedSeconds>1</TotalPlannedSeconds>
<TotalActualSeconds>1</TotalActualSeconds>
<BreakPlannedSeconds>1</BreakPlannedSeconds>
<BreakActualSeconds>1</BreakActualSeconds>
<DisplayBreakPlannedHours>string</DisplayBreakPlannedHours>
<DisplayBreakActualHours>string</DisplayBreakActualHours>
<DisplayPlannedHours>string</DisplayPlannedHours>
<DisplayActualHours>string</DisplayActualHours>
<CurrencySymbol>string</CurrencySymbol>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<DisplayPlannedCost>string</DisplayPlannedCost>
<DisplayActualCost>string</DisplayActualCost>
<DistinctCount>1</DistinctCount>
<SwapRequested>true</SwapRequested>
<ShiftPatternHours>true</ShiftPatternHours>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
</Slots>
</WeekRow>
</MonthRow>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ROTAONECONNECT
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/ROTAONECONNECT/ALIVE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type isAliveMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ClientAliveDto {
OrganisationId (string, optional),
ConnectorIds (Array[string], optional),
MachineName (string, optional),
AwakeTime (string, optional),
VersionNumber (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorIds": [
"00000000-0000-0000-0000-000000000000"
],
"MachineName": "string",
"AwakeTime": "2024-11-07T02:04:39.020Z",
"VersionNumber": "string"
}
<?xml version="1.0"?>
<ClientAliveDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorIds>00000000-0000-0000-0000-000000000000</ConnectorIds>
<MachineName>string</MachineName>
<AwakeTime>1970-01-01T00:00:00.001Z</AwakeTime>
<VersionNumber>string</VersionNumber>
</ClientAliveDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTAONECONNECT/APISTATUS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/ROTAONECONNECT/MEMORYUSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type message
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
RotaOneConnectEventLogMessageDto {
OrganisationGuid (string, optional),
ConnectorGuid (string, optional),
TimeStamp (string, optional),
Message (string, optional),
ClientVersion (string, optional),
ClientName (string, optional),
MethodName (string, optional),
MessageType (string, optional),
AllData (string, optional)
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"TimeStamp": "2024-11-07T02:04:39.022Z",
"Message": "string",
"ClientVersion": "string",
"ClientName": "string",
"MethodName": "string",
"MessageType": "string",
"AllData": "string"
}
<?xml version="1.0"?>
<RotaOneConnectEventLogMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<Message>string</Message>
<ClientVersion>string</ClientVersion>
<ClientName>string</ClientName>
<MethodName>string</MethodName>
<MessageType>string</MessageType>
<AllData>string</AllData>
</RotaOneConnectEventLogMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTAONECONNECT/CHECKFORUPDATES
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTAONECONNECT/DOWNLOADCLIENT
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type name query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ROTAONECONNECT/GETMONITORSERVICESETTINGS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type InstanceGuid query
string OrganisationGuid query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/ROTAONECONNECT/GETCOMMANDS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type message
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
CommandTypeDto {
ConnectorGuid (string, optional),
OrganisationGuid (string, optional),
CommandType (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
}
{
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"CommandType": 0
}
<?xml version="1.0"?>
<CommandTypeDto>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<CommandType>0</CommandType>
</CommandTypeDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/ROTAONECONNECT/COMPLETECOMMAND/{COMMANDID}
*
RESPONSE CLASS (STATUS 200)
boolean
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type commandId path long
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ROTAONECONNECTBACKUP
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/BACKUPS/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type backupMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
RotaOneConnectBackupMessageDto {
OrganisationId (string, optional),
BackupFile (string, optional),
MachineName (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"BackupFile": "string",
"MachineName": "string"
}
<?xml version="1.0"?>
<RotaOneConnectBackupMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<BackupFile>string</BackupFile>
<MachineName>string</MachineName>
</RotaOneConnectBackupMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/BACKUPS/GETBACKUPLISTSP
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type OrganisationId query
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/BACKUPS/GETBACKUPBYIDSP
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type OrganisationId query
string Id query integer
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/BACKUPS/GETBACKUPBYID
*
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
byte
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type OrganisationId query
string Id query integer
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/BACKUPS/GETBACKUPLIST
*
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type OrganisationId query
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ROTAONECONNECTERRORLOG
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/ERRORLOGS/WRITE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type errorMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
RotaOneConnectErrorLogMessageDto {
OrganisationGuid (string, optional),
ConnectorGuid (string, optional),
TimeStamp (string, optional),
ErrorMessage (string, optional),
ClientName (string, optional),
InnerException (string, optional),
ClientVersion (string, optional),
MethodName (string, optional),
ExceptionType (string, optional),
AllData (string, optional)
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"TimeStamp": "2024-11-07T02:04:39.032Z",
"ErrorMessage": "string",
"ClientName": "string",
"InnerException": "string",
"ClientVersion": "string",
"MethodName": "string",
"ExceptionType": "string",
"AllData": "string"
}
<?xml version="1.0"?>
<RotaOneConnectErrorLogMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<ErrorMessage>string</ErrorMessage>
<ClientName>string</ClientName>
<InnerException>string</InnerException>
<ClientVersion>string</ClientVersion>
<MethodName>string</MethodName>
<ExceptionType>string</ExceptionType>
<AllData>string</AllData>
</RotaOneConnectErrorLogMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ROTAONECONNECTEVENTLOG
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/EVENTLOGS/WRITE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type eventMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
RotaOneConnectEventLogMessageDto {
OrganisationGuid (string, optional),
ConnectorGuid (string, optional),
TimeStamp (string, optional),
Message (string, optional),
ClientVersion (string, optional),
ClientName (string, optional),
MethodName (string, optional),
MessageType (string, optional),
AllData (string, optional)
}
{
"OrganisationGuid": "00000000-0000-0000-0000-000000000000",
"ConnectorGuid": "00000000-0000-0000-0000-000000000000",
"TimeStamp": "2024-11-07T02:04:39.034Z",
"Message": "string",
"ClientVersion": "string",
"ClientName": "string",
"MethodName": "string",
"MessageType": "string",
"AllData": "string"
}
<?xml version="1.0"?>
<RotaOneConnectEventLogMessageDto>
<OrganisationGuid>00000000-0000-0000-0000-000000000000</OrganisationGuid>
<ConnectorGuid>00000000-0000-0000-0000-000000000000</ConnectorGuid>
<TimeStamp>1970-01-01T00:00:00.001Z</TimeStamp>
<Message>string</Message>
<ClientVersion>string</ClientVersion>
<ClientName>string</ClientName>
<MethodName>string</MethodName>
<MessageType>string</MessageType>
<AllData>string</AllData>
</RotaOneConnectEventLogMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SETTINGS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/SELFSERVICE/USER/SETTINGS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SELFSERVICE/USER/SETTINGS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
selfServiceSettingsDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SelfServiceSettingsDto {
TimeOffRequestEmail (boolean, optional),
TimeOffRequestMobileApp (boolean, optional),
UnallocatedSlotRequestEmail (boolean, optional),
UnallocatedSlotRequestMobileApp (boolean, optional),
RotaNotification (boolean, optional),
RotaUpdatesEmail (boolean, optional),
RotaUpdatesMobileApp (boolean, optional)
}
{
"TimeOffRequestEmail": true,
"TimeOffRequestMobileApp": true,
"UnallocatedSlotRequestEmail": true,
"UnallocatedSlotRequestMobileApp": true,
"RotaNotification": true,
"RotaUpdatesEmail": true,
"RotaUpdatesMobileApp": true
}
<?xml version="1.0"?>
<SelfServiceSettingsDto>
<TimeOffRequestEmail>true</TimeOffRequestEmail>
<TimeOffRequestMobileApp>true</TimeOffRequestMobileApp>
<UnallocatedSlotRequestEmail>true</UnallocatedSlotRequestEmail>
<UnallocatedSlotRequestMobileApp>true</UnallocatedSlotRequestMobileApp>
<RotaNotification>true</RotaNotification>
<RotaUpdatesEmail>true</RotaUpdatesEmail>
<RotaUpdatesMobileApp>true</RotaUpdatesMobileApp>
</SelfServiceSettingsDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SHIFTPATTERNS
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/SHIFTPATTERNS/RUNSCHEDULE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type organisationId
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SHIFTS
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/SHIFTS/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type shiftMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ShiftMessageDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
ShiftId (string, optional),
Name (string, optional),
Status (boolean, optional),
HistoryStartDate (string, optional),
HistoryEndDate (string, optional),
StartTime (string, optional),
EndTime (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"ShiftId": "string",
"Name": "string",
"Status": true,
"HistoryStartDate": "2024-11-07T02:04:39.039Z",
"HistoryEndDate": "2024-11-07T02:04:39.039Z",
"StartTime": "string",
"EndTime": "string"
}
<?xml version="1.0"?>
<ShiftMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<ShiftId>string</ShiftId>
<Name>string</Name>
<Status>true</Status>
<HistoryStartDate>1970-01-01T00:00:00.001Z</HistoryStartDate>
<HistoryEndDate>1970-01-01T00:00:00.001Z</HistoryEndDate>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
</ShiftMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SLOTSWAP
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/SLOTSWAP/OFFERSLOT
*
RESPONSE CLASS (STATUS 200)
boolean
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type offerDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SlotOfferDto {
SlotOfferId (integer, optional),
SlotId (integer, optional),
OfferedByPersonKey (string, optional),
OfferedDate (string, optional),
OfferedToPersonKeys (Array[string], optional),
SlotRequestType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
RequestedSlotId (integer, optional),
Message (string, optional)
}
{
"SlotOfferId": 0,
"SlotId": 0,
"OfferedByPersonKey": "00000000-0000-0000-0000-000000000000",
"OfferedDate": "2024-11-07T02:04:39.041Z",
"OfferedToPersonKeys": [
"00000000-0000-0000-0000-000000000000"
],
"SlotRequestType": 0,
"RequestedSlotId": 0,
"Message": "string"
}
<?xml version="1.0"?>
<SlotOfferDto>
<SlotOfferId>1</SlotOfferId>
<SlotId>1</SlotId>
<OfferedByPersonKey>00000000-0000-0000-0000-000000000000</OfferedByPersonKey>
<OfferedDate>1970-01-01T00:00:00.001Z</OfferedDate>
<OfferedToPersonKeys>00000000-0000-0000-0000-000000000000</OfferedToPersonKeys>
<SlotRequestType>0</SlotRequestType>
<RequestedSlotId>1</RequestedSlotId>
<Message>string</Message>
</SlotOfferDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SLOTSWAP/UNOFFERSLOT
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type slotId
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body long
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SLOTSWAP/ACCEPTOFFER
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type slotRequestDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SlotSwapAcceptOfferSelfServiceDto {
OrganisationId (integer, optional),
SlotOfferId (integer, optional),
PersonKey (string, optional),
RequestedSlotId (integer, optional)
}
{
"OrganisationId": 0,
"SlotOfferId": 0,
"PersonKey": "00000000-0000-0000-0000-000000000000",
"RequestedSlotId": 0
}
<?xml version="1.0"?>
<SlotSwapAcceptOfferSelfServiceDto>
<OrganisationId>1</OrganisationId>
<SlotOfferId>1</SlotOfferId>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<RequestedSlotId>1</RequestedSlotId>
</SlotSwapAcceptOfferSelfServiceDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SLOTSWAP/CANCELREQUEST
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type slotSwapRequestId
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body long
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SLOTSWAP/SLOTSWAPREQUESTS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
SlotOfferId (integer, optional),
OfferDate (string, optional),
OfferedByPersonKey (string, optional),
OfferedByPersonName (string, optional),
SlotSwapId (integer, optional),
OrganisationId (integer, optional),
Status (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
DateOfRequest (string, optional),
DateProcessed (string, optional),
PersonKey (string, optional),
PersonRequestedDisplayName (string, optional),
SlotId (integer, optional),
OriginalPersonKeyOnSlot (string, optional),
PersonOriginalSlotDisplayName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
SlotDisplayPlannedTimes (string, optional, read only),
GroupId (string, optional),
GroupName (string, optional),
ShiftName (string, optional),
JobName (string, optional),
RequesterNotes (string, optional),
ApproverUserId (string, optional),
ApprovedUserName (string, optional),
ApproverNotes (string, optional),
ApproverPersonKey (string, optional),
ApproverPersonDisplayName (string, optional),
SlotOfferRequestType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
RequestedPerson (string, optional),
RequestedSlotId (integer, optional),
RequestedSlotPlannedStart (string, optional),
RequestedSlotPlannedEnd (string, optional),
RequestedSlotDisplayPlannedTimes (string, optional, read only),
RequestedSlotColourHex (string, optional),
RequestedSlotShiftName (string, optional),
RequestedSlotGroupName (string, optional),
RequestedSlotJobName (string, optional),
RequestedSlotSlotTypeName (string, optional),
HasNotes (boolean, optional)
}
[
{
"SlotOfferId": 0,
"OfferDate": "2024-11-07T02:04:39.045Z",
"OfferedByPersonKey": "00000000-0000-0000-0000-000000000000",
"OfferedByPersonName": "string",
"SlotSwapId": 0,
"OrganisationId": 0,
"Status": 0,
"DateOfRequest": "2024-11-07T02:04:39.045Z",
"DateProcessed": "2024-11-07T02:04:39.045Z",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonRequestedDisplayName": "string",
"SlotId": 0,
"OriginalPersonKeyOnSlot": "00000000-0000-0000-0000-000000000000",
"PersonOriginalSlotDisplayName": "string",
"PlannedStart": "2024-11-07T02:04:39.045Z",
"PlannedEnd": "2024-11-07T02:04:39.045Z",
"SlotDisplayPlannedTimes": "string",
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"ShiftName": "string",
"JobName": "string",
"RequesterNotes": "string",
"ApproverUserId": "string",
"ApprovedUserName": "string",
"ApproverNotes": "string",
"ApproverPersonKey": "00000000-0000-0000-0000-000000000000",
"ApproverPersonDisplayName": "string",
"SlotOfferRequestType": 0,
"RequestedPerson": "string",
"RequestedSlotId": 0,
"RequestedSlotPlannedStart": "2024-11-07T02:04:39.045Z",
"RequestedSlotPlannedEnd": "2024-11-07T02:04:39.045Z",
"RequestedSlotDisplayPlannedTimes": "string",
"RequestedSlotColourHex": "string",
"RequestedSlotShiftName": "string",
"RequestedSlotGroupName": "string",
"RequestedSlotJobName": "string",
"RequestedSlotSlotTypeName": "string",
"HasNotes": true
}
]
<?xml version="1.0"?>
<Inline Model>
<SlotOfferId>1</SlotOfferId>
<OfferDate>1970-01-01T00:00:00.001Z</OfferDate>
<OfferedByPersonKey>00000000-0000-0000-0000-000000000000</OfferedByPersonKey>
<OfferedByPersonName>string</OfferedByPersonName>
<SlotSwapId>1</SlotSwapId>
<OrganisationId>1</OrganisationId>
<Status>0</Status>
<DateOfRequest>1970-01-01T00:00:00.001Z</DateOfRequest>
<DateProcessed>1970-01-01T00:00:00.001Z</DateProcessed>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonRequestedDisplayName>string</PersonRequestedDisplayName>
<SlotId>1</SlotId>
<OriginalPersonKeyOnSlot>00000000-0000-0000-0000-000000000000</OriginalPersonKeyOnSlot>
<PersonOriginalSlotDisplayName>string</PersonOriginalSlotDisplayName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<SlotDisplayPlannedTimes>string</SlotDisplayPlannedTimes>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<ShiftName>string</ShiftName>
<JobName>string</JobName>
<RequesterNotes>string</RequesterNotes>
<ApproverUserId>string</ApproverUserId>
<ApprovedUserName>string</ApprovedUserName>
<ApproverNotes>string</ApproverNotes>
<ApproverPersonKey>00000000-0000-0000-0000-000000000000</ApproverPersonKey>
<ApproverPersonDisplayName>string</ApproverPersonDisplayName>
<SlotOfferRequestType>0</SlotOfferRequestType>
<RequestedPerson>string</RequestedPerson>
<RequestedSlotId>1</RequestedSlotId>
<RequestedSlotPlannedStart>1970-01-01T00:00:00.001Z</RequestedSlotPlannedStart>
<RequestedSlotPlannedEnd>1970-01-01T00:00:00.001Z</RequestedSlotPlannedEnd>
<RequestedSlotDisplayPlannedTimes>string</RequestedSlotDisplayPlannedTimes>
<RequestedSlotColourHex>string</RequestedSlotColourHex>
<RequestedSlotShiftName>string</RequestedSlotShiftName>
<RequestedSlotGroupName>string</RequestedSlotGroupName>
<RequestedSlotJobName>string</RequestedSlotJobName>
<RequestedSlotSlotTypeName>string</RequestedSlotSlotTypeName>
<HasNotes>true</HasNotes>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey query
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SLOTSWAP/ADVERTISEDSLOTSFORSWAP
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
SlotOfferId (integer, optional),
OfferedDate (string, optional),
OfferedByPersonName (string, optional),
OfferedToPersonNames (string, optional),
OfferedByPersonKey (string, optional),
SlotId (integer, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ColourHex (string, optional),
ShiftName (string, optional),
ShiftKey (string, optional),
GroupName (string, optional),
JobName (string, optional),
JobKey (string, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
Message (string, optional),
SlotOfferRequestType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
RequestedSlotId (integer, optional),
RequestedSlotPlannedStart (string, optional),
RequestedSlotPlannedEnd (string, optional),
RequestedSlotColourHex (string, optional),
RequestedSlotShiftName (string, optional),
RequestedSlotGroupName (string, optional),
RequestedSlotJobName (string, optional),
RequestedSlotSlotTypeName (string, optional)
}
[
{
"SlotOfferId": 0,
"OfferedDate": "2024-11-07T02:04:39.049Z",
"OfferedByPersonName": "string",
"OfferedToPersonNames": "string",
"OfferedByPersonKey": "00000000-0000-0000-0000-000000000000",
"SlotId": 0,
"PlannedStart": "2024-11-07T02:04:39.049Z",
"PlannedEnd": "2024-11-07T02:04:39.049Z",
"ColourHex": "string",
"ShiftName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"JobName": "string",
"JobKey": "00000000-0000-0000-0000-000000000000",
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"Message": "string",
"SlotOfferRequestType": 0,
"RequestedSlotId": 0,
"RequestedSlotPlannedStart": "2024-11-07T02:04:39.049Z",
"RequestedSlotPlannedEnd": "2024-11-07T02:04:39.049Z",
"RequestedSlotColourHex": "string",
"RequestedSlotShiftName": "string",
"RequestedSlotGroupName": "string",
"RequestedSlotJobName": "string",
"RequestedSlotSlotTypeName": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<SlotOfferId>1</SlotOfferId>
<OfferedDate>1970-01-01T00:00:00.001Z</OfferedDate>
<OfferedByPersonName>string</OfferedByPersonName>
<OfferedToPersonNames>string</OfferedToPersonNames>
<OfferedByPersonKey>00000000-0000-0000-0000-000000000000</OfferedByPersonKey>
<SlotId>1</SlotId>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ColourHex>string</ColourHex>
<ShiftName>string</ShiftName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<GroupName>string</GroupName>
<JobName>string</JobName>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<Message>string</Message>
<SlotOfferRequestType>0</SlotOfferRequestType>
<RequestedSlotId>1</RequestedSlotId>
<RequestedSlotPlannedStart>1970-01-01T00:00:00.001Z</RequestedSlotPlannedStart>
<RequestedSlotPlannedEnd>1970-01-01T00:00:00.001Z</RequestedSlotPlannedEnd>
<RequestedSlotColourHex>string</RequestedSlotColourHex>
<RequestedSlotShiftName>string</RequestedSlotShiftName>
<RequestedSlotGroupName>string</RequestedSlotGroupName>
<RequestedSlotJobName>string</RequestedSlotJobName>
<RequestedSlotSlotTypeName>string</RequestedSlotSlotTypeName>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey query
string startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SLOTSWAP/GETRECEIVEDOFFERS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
SlotOfferId (integer, optional),
OfferedDate (string, optional),
OfferedByPersonName (string, optional),
OfferedToPersonNames (string, optional),
OfferedByPersonKey (string, optional),
SlotId (integer, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ColourHex (string, optional),
ShiftName (string, optional),
ShiftKey (string, optional),
GroupName (string, optional),
JobName (string, optional),
JobKey (string, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
Message (string, optional),
SlotOfferRequestType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
RequestedSlotId (integer, optional),
RequestedSlotPlannedStart (string, optional),
RequestedSlotPlannedEnd (string, optional),
RequestedSlotColourHex (string, optional),
RequestedSlotShiftName (string, optional),
RequestedSlotGroupName (string, optional),
RequestedSlotJobName (string, optional),
RequestedSlotSlotTypeName (string, optional)
}
[
{
"SlotOfferId": 0,
"OfferedDate": "2024-11-07T02:04:39.052Z",
"OfferedByPersonName": "string",
"OfferedToPersonNames": "string",
"OfferedByPersonKey": "00000000-0000-0000-0000-000000000000",
"SlotId": 0,
"PlannedStart": "2024-11-07T02:04:39.052Z",
"PlannedEnd": "2024-11-07T02:04:39.052Z",
"ColourHex": "string",
"ShiftName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"JobName": "string",
"JobKey": "00000000-0000-0000-0000-000000000000",
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"Message": "string",
"SlotOfferRequestType": 0,
"RequestedSlotId": 0,
"RequestedSlotPlannedStart": "2024-11-07T02:04:39.052Z",
"RequestedSlotPlannedEnd": "2024-11-07T02:04:39.052Z",
"RequestedSlotColourHex": "string",
"RequestedSlotShiftName": "string",
"RequestedSlotGroupName": "string",
"RequestedSlotJobName": "string",
"RequestedSlotSlotTypeName": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<SlotOfferId>1</SlotOfferId>
<OfferedDate>1970-01-01T00:00:00.001Z</OfferedDate>
<OfferedByPersonName>string</OfferedByPersonName>
<OfferedToPersonNames>string</OfferedToPersonNames>
<OfferedByPersonKey>00000000-0000-0000-0000-000000000000</OfferedByPersonKey>
<SlotId>1</SlotId>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ColourHex>string</ColourHex>
<ShiftName>string</ShiftName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<GroupName>string</GroupName>
<JobName>string</JobName>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<Message>string</Message>
<SlotOfferRequestType>0</SlotOfferRequestType>
<RequestedSlotId>1</RequestedSlotId>
<RequestedSlotPlannedStart>1970-01-01T00:00:00.001Z</RequestedSlotPlannedStart>
<RequestedSlotPlannedEnd>1970-01-01T00:00:00.001Z</RequestedSlotPlannedEnd>
<RequestedSlotColourHex>string</RequestedSlotColourHex>
<RequestedSlotShiftName>string</RequestedSlotShiftName>
<RequestedSlotGroupName>string</RequestedSlotGroupName>
<RequestedSlotJobName>string</RequestedSlotJobName>
<RequestedSlotSlotTypeName>string</RequestedSlotSlotTypeName>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey query
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SLOTSWAP/GETSENTOFFERS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
SlotOfferId (integer, optional),
OfferedDate (string, optional),
OfferedByPersonName (string, optional),
OfferedToPersonNames (string, optional),
OfferedByPersonKey (string, optional),
SlotId (integer, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ColourHex (string, optional),
ShiftName (string, optional),
ShiftKey (string, optional),
GroupName (string, optional),
JobName (string, optional),
JobKey (string, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
Message (string, optional),
SlotOfferRequestType (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
RequestedSlotId (integer, optional),
RequestedSlotPlannedStart (string, optional),
RequestedSlotPlannedEnd (string, optional),
RequestedSlotColourHex (string, optional),
RequestedSlotShiftName (string, optional),
RequestedSlotGroupName (string, optional),
RequestedSlotJobName (string, optional),
RequestedSlotSlotTypeName (string, optional)
}
[
{
"SlotOfferId": 0,
"OfferedDate": "2024-11-07T02:04:39.054Z",
"OfferedByPersonName": "string",
"OfferedToPersonNames": "string",
"OfferedByPersonKey": "00000000-0000-0000-0000-000000000000",
"SlotId": 0,
"PlannedStart": "2024-11-07T02:04:39.054Z",
"PlannedEnd": "2024-11-07T02:04:39.054Z",
"ColourHex": "string",
"ShiftName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"JobName": "string",
"JobKey": "00000000-0000-0000-0000-000000000000",
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"Message": "string",
"SlotOfferRequestType": 0,
"RequestedSlotId": 0,
"RequestedSlotPlannedStart": "2024-11-07T02:04:39.054Z",
"RequestedSlotPlannedEnd": "2024-11-07T02:04:39.054Z",
"RequestedSlotColourHex": "string",
"RequestedSlotShiftName": "string",
"RequestedSlotGroupName": "string",
"RequestedSlotJobName": "string",
"RequestedSlotSlotTypeName": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<SlotOfferId>1</SlotOfferId>
<OfferedDate>1970-01-01T00:00:00.001Z</OfferedDate>
<OfferedByPersonName>string</OfferedByPersonName>
<OfferedToPersonNames>string</OfferedToPersonNames>
<OfferedByPersonKey>00000000-0000-0000-0000-000000000000</OfferedByPersonKey>
<SlotId>1</SlotId>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ColourHex>string</ColourHex>
<ShiftName>string</ShiftName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<GroupName>string</GroupName>
<JobName>string</JobName>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<Message>string</Message>
<SlotOfferRequestType>0</SlotOfferRequestType>
<RequestedSlotId>1</RequestedSlotId>
<RequestedSlotPlannedStart>1970-01-01T00:00:00.001Z</RequestedSlotPlannedStart>
<RequestedSlotPlannedEnd>1970-01-01T00:00:00.001Z</RequestedSlotPlannedEnd>
<RequestedSlotColourHex>string</RequestedSlotColourHex>
<RequestedSlotShiftName>string</RequestedSlotShiftName>
<RequestedSlotGroupName>string</RequestedSlotGroupName>
<RequestedSlotJobName>string</RequestedSlotJobName>
<RequestedSlotSlotTypeName>string</RequestedSlotSlotTypeName>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey query
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SLOTSWAP/GETPEOPLETOSWAPWITH
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
PersonKey (string, optional),
ParentId (string, optional),
GroupName (string, optional),
NationalityId (integer, optional),
Title (integer, optional) = ['1', '2', '3', '4', '5']
integerEnum:1, 2, 3, 4, 5
,
FirstName (string, optional),
MiddleName (string, optional),
LastName (string, optional),
DisplayName (string, optional),
DateOfBirth (string, optional),
ProbationEnd (string, optional),
Gender (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
,
GovernmentId (string, optional),
SecurityStatusLevel (integer, optional) = ['1', '2', '3', '4', '5', '6',
'7', '8', '9', '10']
integerEnum:1, 2, 3, 4, 5, 6, 7, 8, 9, 10
,
IsSelfServiceRequired (boolean, optional),
IsSystemUser (boolean, optional),
IsMusterdUser (boolean, optional),
IsMusterdImSafeUser (boolean, optional),
EmailAddress (string, optional),
WorkEmail (string, optional),
PersonalEmail (string, optional),
SelectedGroupId (string, optional),
StartDateThisEmployment (string, optional),
EndDateThisEmployment (string, optional),
ReceiveRotaUpdates (boolean, optional),
ReceiveUnallocatedSlotsUpdates (boolean, optional),
TimeOffRequestEmail (boolean, optional),
TimeOffRequestMobileApp (boolean, optional),
UnallocatedSlotRequestEmail (boolean, optional),
UnallocatedSlotRequestMobileApp (boolean, optional),
SlotSwapRequestEmail (boolean, optional),
SlotSwapRequestMobileApp (boolean, optional),
RotaUpdatesEmail (boolean, optional),
RotaUpdatesMobileApp (boolean, optional),
Disability (boolean, optional),
DisabilityDescription (string, optional),
AvailabilityLockDate (string, optional),
HasChanged (boolean, optional),
SuppressExceptions (boolean, optional),
GuestPerson (boolean, optional),
Id (integer, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
Status (integer, optional) = ['0', '1']
integerEnum:0, 1
,
CreatedDate (string, optional),
UpdatedDate (string, optional),
HistoryCreated (string, optional),
HistoryStart (string, optional),
HistoryEnd (string, optional),
UserId (string, optional),
Terminate (boolean, optional)
}
[
{
"PersonKey": "00000000-0000-0000-0000-000000000000",
"ParentId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"NationalityId": 0,
"Title": 1,
"FirstName": "string",
"MiddleName": "string",
"LastName": "string",
"DisplayName": "string",
"DateOfBirth": "2024-11-07T02:04:39.056Z",
"ProbationEnd": "2024-11-07T02:04:39.056Z",
"Gender": 1,
"GovernmentId": "string",
"SecurityStatusLevel": 1,
"IsSelfServiceRequired": true,
"IsSystemUser": true,
"IsMusterdUser": true,
"IsMusterdImSafeUser": true,
"EmailAddress": "string",
"WorkEmail": "string",
"PersonalEmail": "string",
"SelectedGroupId": "00000000-0000-0000-0000-000000000000",
"StartDateThisEmployment": "2024-11-07T02:04:39.056Z",
"EndDateThisEmployment": "2024-11-07T02:04:39.056Z",
"ReceiveRotaUpdates": true,
"ReceiveUnallocatedSlotsUpdates": true,
"TimeOffRequestEmail": true,
"TimeOffRequestMobileApp": true,
"UnallocatedSlotRequestEmail": true,
"UnallocatedSlotRequestMobileApp": true,
"SlotSwapRequestEmail": true,
"SlotSwapRequestMobileApp": true,
"RotaUpdatesEmail": true,
"RotaUpdatesMobileApp": true,
"Disability": true,
"DisabilityDescription": "string",
"AvailabilityLockDate": "2024-11-07T02:04:39.056Z",
"HasChanged": true,
"SuppressExceptions": true,
"GuestPerson": true,
"Id": 0,
"OrganisationId": 0,
"CustomTypeId": 0,
"Status": 0,
"CreatedDate": "2024-11-07T02:04:39.056Z",
"UpdatedDate": "2024-11-07T02:04:39.056Z",
"HistoryCreated": "2024-11-07T02:04:39.056Z",
"HistoryStart": "2024-11-07T02:04:39.056Z",
"HistoryEnd": "2024-11-07T02:04:39.056Z",
"UserId": "string",
"Terminate": true
}
]
<?xml version="1.0"?>
<Inline Model>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<ParentId>00000000-0000-0000-0000-000000000000</ParentId>
<GroupName>string</GroupName>
<NationalityId>1</NationalityId>
<Title>1</Title>
<FirstName>string</FirstName>
<MiddleName>string</MiddleName>
<LastName>string</LastName>
<DisplayName>string</DisplayName>
<DateOfBirth>1970-01-01T00:00:00.001Z</DateOfBirth>
<ProbationEnd>1970-01-01T00:00:00.001Z</ProbationEnd>
<Gender>1</Gender>
<GovernmentId>string</GovernmentId>
<SecurityStatusLevel>1</SecurityStatusLevel>
<IsSelfServiceRequired>true</IsSelfServiceRequired>
<IsSystemUser>true</IsSystemUser>
<IsMusterdUser>true</IsMusterdUser>
<IsMusterdImSafeUser>true</IsMusterdImSafeUser>
<EmailAddress>string</EmailAddress>
<WorkEmail>string</WorkEmail>
<PersonalEmail>string</PersonalEmail>
<SelectedGroupId>00000000-0000-0000-0000-000000000000</SelectedGroupId>
<StartDateThisEmployment>1970-01-01T00:00:00.001Z</StartDateThisEmployment>
<EndDateThisEmployment>1970-01-01T00:00:00.001Z</EndDateThisEmployment>
<ReceiveRotaUpdates>true</ReceiveRotaUpdates>
<ReceiveUnallocatedSlotsUpdates>true</ReceiveUnallocatedSlotsUpdates>
<TimeOffRequestEmail>true</TimeOffRequestEmail>
<TimeOffRequestMobileApp>true</TimeOffRequestMobileApp>
<UnallocatedSlotRequestEmail>true</UnallocatedSlotRequestEmail>
<UnallocatedSlotRequestMobileApp>true</UnallocatedSlotRequestMobileApp>
<SlotSwapRequestEmail>true</SlotSwapRequestEmail>
<SlotSwapRequestMobileApp>true</SlotSwapRequestMobileApp>
<RotaUpdatesEmail>true</RotaUpdatesEmail>
<RotaUpdatesMobileApp>true</RotaUpdatesMobileApp>
<Disability>true</Disability>
<DisabilityDescription>string</DisabilityDescription>
<AvailabilityLockDate>1970-01-01T00:00:00.001Z</AvailabilityLockDate>
<HasChanged>true</HasChanged>
<SuppressExceptions>true</SuppressExceptions>
<GuestPerson>true</GuestPerson>
<Id>1</Id>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Status>0</Status>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<UpdatedDate>1970-01-01T00:00:00.001Z</UpdatedDate>
<HistoryCreated>1970-01-01T00:00:00.001Z</HistoryCreated>
<HistoryStart>1970-01-01T00:00:00.001Z</HistoryStart>
<HistoryEnd>1970-01-01T00:00:00.001Z</HistoryEnd>
<UserId>string</UserId>
<Terminate>true</Terminate>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey query
string slotId query long
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SLOTSWAP/GETPERSONSAVAILABLESLOTS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
OrganisationId (integer, optional),
SlotId (integer, optional),
GroupId (string, optional),
GroupName (string, optional),
JobMandatory (boolean, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
SlotTypeNoSwipesAllowed (boolean, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
JobKey (string, optional),
PersonKey (string, optional),
PersonDisplayName (string, optional),
PersonalSecurityStatusLevel (integer, optional) = ['1', '2', '3', '4',
'5', '6', '7', '8', '9', '10']
integerEnum:1, 2, 3, 4, 5, 6, 7, 8, 9, 10
,
JobName (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
ShiftRestDay (boolean, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
GamePoints (integer, optional),
SlotDate (integer, optional),
SlotDateAsDate (string, optional, read only),
DisplayDateStart (string, optional, read only),
DisplayDateEnd (string, optional, read only),
TotalPlannedSeconds (integer, optional),
TotalActualSeconds (integer, optional),
TotalPlannedCost (number, optional),
TotalActualCost (number, optional),
ShiftPatternHours (boolean, optional),
Published (boolean, optional),
PreviousPublished (boolean, optional),
NoBreaks (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
ActualStartLock (boolean, optional),
ActualEndLock (boolean, optional),
LieuStatus (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
ShiftPatternDeploymentId (integer, optional),
ShiftPatternName (string, optional),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayActualStartAndEndTimes (string, optional, read only),
BonusKeys (string, optional),
ProcessingTime (string, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
IsWorkingSlot (boolean, optional),
ColourHex (string, optional),
SwapRequested (boolean, optional),
SlotChunks (Array[SlotChunkDto], optional),
TaskChunks (Array[SlotTaskChunkDto], optional),
SlotTags (Array[SlotTagDto], optional),
SlotAdjustments (Array[SlotAdjustmentDto], optional),
SlotSwipes (Array[SlotSwipeDto], optional),
SlotNotes (Array[SlotNoteDto], optional),
SlotAudits (Array[SlotAuditDto], optional),
SelectedGameSlotBonuses (Array[GameSlotBonusDto], optional),
GameSlotBonuses (Array[GameBonusDto], optional),
SlotAdvertisement (GameSlotAdvertisementDto, optional),
SlotTypes (Array[OtherDataKeyValueDto], optional),
Persons (Array[OtherDataKeyValueDto], optional),
Groups (Array[OtherDataKeyValueDto], optional),
Shifts (Array[OtherDataKeyValueDto], optional),
Jobs (Array[OtherDataKeyValueDto], optional),
OnlyPayRates (Array[OtherDataKeyValueDto], optional),
Adjustments (Array[OtherDataKeyValueDto], optional),
Peripherals (Array[OtherDataKeyValueDto], optional),
RotaLockDate (string, optional),
PlannedSlots (boolean, optional),
DefaultSlotType (string, optional),
HideUnallocatedRow (boolean, optional),
ShowFlexiChunksTab (boolean, optional),
PayUnplannedSlots (boolean, optional),
AutoCreateTaskChunks (boolean, optional),
ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY (string, optional),
ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY (string, optional)
}
SlotChunkDto {
SlotChunkId (integer, optional),
SlotId (integer, optional),
SlotChunkTypeId (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
ChunkTypeName (string, optional, read only),
Start (string, optional),
End (string, optional),
ContractedHours (boolean, optional),
TotalSeconds (integer, optional),
SlotChunkLockTypeId (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
BreakRuleConditionId (string, optional),
PayRuleKey (string, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PayRateValue (number, optional),
PayValue (number, optional),
IncludeForPlannedAndActualHours (boolean, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotTaskChunkDto {
TaskChunkId (integer, optional),
SlotId (integer, optional),
CustomerId (string, optional),
CustomerName (string, optional),
ProductId (string, optional),
ProductName (string, optional),
TaskId (string, optional),
TaskName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
TotalSeconds (integer, optional),
EstimatedCost (number, optional),
TrueCost (number, optional),
TotalHours (number, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotTagDto {
SlotTagId (integer, optional),
SlotId (integer, optional),
TagKey (string, optional),
TagName (string, optional),
StartDate (string, optional),
EndDate (string, optional),
TotalSeconds (integer, optional),
Cost (number, optional),
ToBeDeleted (boolean, optional),
ToBeUpdated (boolean, optional)
}
SlotAdjustmentDto {
SlotAdjustmentId (integer, optional),
SlotId (integer, optional),
PayRateKey (string, optional),
PayRateName (string, optional),
PayRateType (integer, optional) = ['1', '2', '3', '4', '5', '6', '7']
integerEnum:1, 2, 3, 4, 5, 6, 7
,
PayRateValue (number, optional),
Quantity (number, optional),
PayValue (number, optional),
CreatedBy (string, optional),
CreatedByName (string, optional),
CreatedDate (string, optional),
HolidayPayAdjustment (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotSwipeDto {
SwipeId (integer, optional),
SlotId (integer, optional),
OrganisationId (integer, optional),
PersonKey (string, optional),
Direction (integer, optional) = ['1', '2']
integerEnum:1, 2
,
DirectionName (string, optional, read only),
EventDateTime (string, optional),
RevisedDateTime (string, optional),
SwipeTypeId (integer, optional) = ['1', '2']
integerEnum:1, 2
,
SwipeTypeName (string, optional, read only),
PeripheralKey (string, optional),
PeripheralName (string, optional),
PeripheralLocation (string, optional),
Rounded (boolean, optional),
SwipeStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
SwipeReasonId (integer, optional) = ['0', '1', '2', '3', '4', '5', '6',
'7', '8', '9', '10', '11', '12', '13']
integerEnum:0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
,
StartBreakEndTypeId (integer, optional) = ['0', '1', '2', '3', '-1']
integerEnum:0, 1, 2, 3, -1
,
SwipeProcessingTypeId (integer, optional) = ['0', '1', '2']
integerEnum:0, 1, 2
,
Status_Auto (boolean, optional),
Status_Noted (boolean, optional),
Swipe_Latitude (number, optional),
Swipe_Longitude (number, optional),
OutsideSTDistanceAllowed (boolean, optional)
}
SlotNoteDto {
SlotNoteId (integer, optional),
SlotId (integer, optional),
Note (string, optional),
CreatedBy (string, optional),
CreatedByName (string, optional),
CreatedDate (string, optional),
HolidayPayAdjustment (boolean, optional),
HiddenFlag (boolean, optional),
ToBeUpdated (boolean, optional),
ToBeDeleted (boolean, optional)
}
SlotAuditDto {
ActionId (integer, optional),
CreatedDate (string, optional),
Id (integer, optional),
SlotId (integer, optional),
OrganisationId (integer, optional),
Result (string, optional),
UserId (string, optional),
UserDisplayName (string, optional)
}
GameSlotBonusDto {
SlotBonusId (integer, optional),
SlotId (integer, optional),
BonusKey (string, optional),
ToBeDeleted (boolean, optional)
}
GameBonusDto {
BonusKey (string, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
Name (string, optional),
PayRateKey (string, optional),
PayRateMultiplier (number, optional)
}
GameSlotAdvertisementDto {
AdvertiseId (integer, optional),
SlotId (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional)
}
OtherDataKeyValueDto {
KeyValue (string, optional),
Name (string, optional),
Sort (integer, optional),
Default (boolean, optional)
}
[
{
"OrganisationId": 0,
"SlotId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"JobMandatory": true,
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"SlotTypeNoSwipesAllowed": true,
"SlotStatusId": 0,
"JobKey": "00000000-0000-0000-0000-000000000000",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonDisplayName": "string",
"PersonalSecurityStatusLevel": 1,
"JobName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"ShiftRestDay": true,
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PlannedStart": "2024-11-07T02:04:39.059Z",
"PlannedEnd": "2024-11-07T02:04:39.059Z",
"ActualStart": "2024-11-07T02:04:39.059Z",
"ActualEnd": "2024-11-07T02:04:39.059Z",
"GamePoints": 0,
"SlotDate": 0,
"SlotDateAsDate": "2024-11-07T02:04:39.059Z",
"DisplayDateStart": "2024-11-07T02:04:39.059Z",
"DisplayDateEnd": "2024-11-07T02:04:39.059Z",
"TotalPlannedSeconds": 0,
"TotalActualSeconds": 0,
"TotalPlannedCost": 0,
"TotalActualCost": 0,
"ShiftPatternHours": true,
"Published": true,
"PreviousPublished": true,
"NoBreaks": 0,
"ActualStartLock": true,
"ActualEndLock": true,
"LieuStatus": 0,
"ShiftPatternDeploymentId": 0,
"ShiftPatternName": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayActualStartAndEndTimes": "string",
"BonusKeys": "string",
"ProcessingTime": "2024-11-07T02:04:39.060Z",
"AdvertiseFrom": "2024-11-07T02:04:39.060Z",
"AdvertiseTo": "2024-11-07T02:04:39.060Z",
"IsWorkingSlot": true,
"ColourHex": "string",
"SwapRequested": true,
"SlotChunks": [
{
"SlotChunkId": 0,
"SlotId": 0,
"SlotChunkTypeId": 1,
"ChunkTypeName": "string",
"Start": "2024-11-07T02:04:39.060Z",
"End": "2024-11-07T02:04:39.060Z",
"ContractedHours": true,
"TotalSeconds": 0,
"SlotChunkLockTypeId": 0,
"BreakRuleConditionId": "00000000-0000-0000-0000-000000000000",
"PayRuleKey": "00000000-0000-0000-0000-000000000000",
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PayRateValue": 0,
"PayValue": 0,
"IncludeForPlannedAndActualHours": true,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"TaskChunks": [
{
"TaskChunkId": 0,
"SlotId": 0,
"CustomerId": "00000000-0000-0000-0000-000000000000",
"CustomerName": "string",
"ProductId": "00000000-0000-0000-0000-000000000000",
"ProductName": "string",
"TaskId": "00000000-0000-0000-0000-000000000000",
"TaskName": "string",
"StartDate": "2024-11-07T02:04:39.060Z",
"EndDate": "2024-11-07T02:04:39.060Z",
"TotalSeconds": 0,
"EstimatedCost": 0,
"TrueCost": 0,
"TotalHours": 0,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"SlotTags": [
{
"SlotTagId": 0,
"SlotId": 0,
"TagKey": "00000000-0000-0000-0000-000000000000",
"TagName": "string",
"StartDate": "2024-11-07T02:04:39.060Z",
"EndDate": "2024-11-07T02:04:39.060Z",
"TotalSeconds": 0,
"Cost": 0,
"ToBeDeleted": true,
"ToBeUpdated": true
}
],
"SlotAdjustments": [
{
"SlotAdjustmentId": 0,
"SlotId": 0,
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateName": "string",
"PayRateType": 1,
"PayRateValue": 0,
"Quantity": 0,
"PayValue": 0,
"CreatedBy": "string",
"CreatedByName": "string",
"CreatedDate": "2024-11-07T02:04:39.060Z",
"HolidayPayAdjustment": true,
"ToBeDeleted": true
}
],
"SlotSwipes": [
{
"SwipeId": 0,
"SlotId": 0,
"OrganisationId": 0,
"PersonKey": "00000000-0000-0000-0000-000000000000",
"Direction": 1,
"DirectionName": "string",
"EventDateTime": "2024-11-07T02:04:39.060Z",
"RevisedDateTime": "2024-11-07T02:04:39.060Z",
"SwipeTypeId": 1,
"SwipeTypeName": "string",
"PeripheralKey": "00000000-0000-0000-0000-000000000000",
"PeripheralName": "string",
"PeripheralLocation": "string",
"Rounded": true,
"SwipeStatusId": 0,
"SwipeReasonId": 0,
"StartBreakEndTypeId": 0,
"SwipeProcessingTypeId": 0,
"Status_Auto": true,
"Status_Noted": true,
"Swipe_Latitude": 0,
"Swipe_Longitude": 0,
"OutsideSTDistanceAllowed": true
}
],
"SlotNotes": [
{
"SlotNoteId": 0,
"SlotId": 0,
"Note": "string",
"CreatedBy": "string",
"CreatedByName": "string",
"CreatedDate": "2024-11-07T02:04:39.060Z",
"HolidayPayAdjustment": true,
"HiddenFlag": true,
"ToBeUpdated": true,
"ToBeDeleted": true
}
],
"SlotAudits": [
{
"ActionId": 0,
"CreatedDate": "2024-11-07T02:04:39.060Z",
"Id": 0,
"SlotId": 0,
"OrganisationId": 0,
"Result": "string",
"UserId": "string",
"UserDisplayName": "string"
}
],
"SelectedGameSlotBonuses": [
{
"SlotBonusId": 0,
"SlotId": 0,
"BonusKey": "00000000-0000-0000-0000-000000000000",
"ToBeDeleted": true
}
],
"GameSlotBonuses": [
{
"BonusKey": "00000000-0000-0000-0000-000000000000",
"OrganisationId": 0,
"CustomTypeId": 0,
"Name": "string",
"PayRateKey": "00000000-0000-0000-0000-000000000000",
"PayRateMultiplier": 0
}
],
"SlotAdvertisement": {
"AdvertiseId": 0,
"SlotId": 0,
"AdvertiseFrom": "2024-11-07T02:04:39.060Z",
"AdvertiseTo": "2024-11-07T02:04:39.060Z"
},
"SlotTypes": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Persons": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Groups": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Shifts": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Jobs": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"OnlyPayRates": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Adjustments": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"Peripherals": [
{
"KeyValue": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Sort": 0,
"Default": true
}
],
"RotaLockDate": "2024-11-07T02:04:39.060Z",
"PlannedSlots": true,
"DefaultSlotType": "00000000-0000-0000-0000-000000000000",
"HideUnallocatedRow": true,
"ShowFlexiChunksTab": true,
"PayUnplannedSlots": true,
"AutoCreateTaskChunks": true,
"ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY": "string",
"ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<OrganisationId>1</OrganisationId>
<SlotId>1</SlotId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<JobMandatory>true</JobMandatory>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<SlotTypeNoSwipesAllowed>true</SlotTypeNoSwipesAllowed>
<SlotStatusId>0</SlotStatusId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonDisplayName>string</PersonDisplayName>
<PersonalSecurityStatusLevel>1</PersonalSecurityStatusLevel>
<JobName>string</JobName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<ShiftRestDay>true</ShiftRestDay>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<GamePoints>1</GamePoints>
<SlotDate>1</SlotDate>
<SlotDateAsDate>1970-01-01T00:00:00.001Z</SlotDateAsDate>
<DisplayDateStart>1970-01-01T00:00:00.001Z</DisplayDateStart>
<DisplayDateEnd>1970-01-01T00:00:00.001Z</DisplayDateEnd>
<TotalPlannedSeconds>1</TotalPlannedSeconds>
<TotalActualSeconds>1</TotalActualSeconds>
<TotalPlannedCost>1.1</TotalPlannedCost>
<TotalActualCost>1.1</TotalActualCost>
<ShiftPatternHours>true</ShiftPatternHours>
<Published>true</Published>
<PreviousPublished>true</PreviousPublished>
<NoBreaks>0</NoBreaks>
<ActualStartLock>true</ActualStartLock>
<ActualEndLock>true</ActualEndLock>
<LieuStatus>0</LieuStatus>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
<ShiftPatternName>string</ShiftPatternName>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<BonusKeys>string</BonusKeys>
<ProcessingTime>1970-01-01T00:00:00.001Z</ProcessingTime>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<IsWorkingSlot>true</IsWorkingSlot>
<ColourHex>string</ColourHex>
<SwapRequested>true</SwapRequested>
<SlotChunks>
<SlotChunkId>1</SlotChunkId>
<SlotId>1</SlotId>
<SlotChunkTypeId>1</SlotChunkTypeId>
<ChunkTypeName>string</ChunkTypeName>
<Start>1970-01-01T00:00:00.001Z</Start>
<End>1970-01-01T00:00:00.001Z</End>
<ContractedHours>true</ContractedHours>
<TotalSeconds>1</TotalSeconds>
<SlotChunkLockTypeId>0</SlotChunkLockTypeId>
<BreakRuleConditionId>00000000-0000-0000-0000-000000000000</BreakRuleConditionId>
<PayRuleKey>00000000-0000-0000-0000-000000000000</PayRuleKey>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PayRateValue>1.1</PayRateValue>
<PayValue>1.1</PayValue>
<IncludeForPlannedAndActualHours>true</IncludeForPlannedAndActualHours>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</SlotChunks>
<TaskChunks>
<TaskChunkId>1</TaskChunkId>
<SlotId>1</SlotId>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>string</CustomerName>
<ProductId>00000000-0000-0000-0000-000000000000</ProductId>
<ProductName>string</ProductName>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
<TaskName>string</TaskName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<TotalSeconds>1</TotalSeconds>
<EstimatedCost>1.1</EstimatedCost>
<TrueCost>1.1</TrueCost>
<TotalHours>1.1</TotalHours>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</TaskChunks>
<SlotTags>
<SlotTagId>1</SlotTagId>
<SlotId>1</SlotId>
<TagKey>00000000-0000-0000-0000-000000000000</TagKey>
<TagName>string</TagName>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
<TotalSeconds>1</TotalSeconds>
<Cost>1.1</Cost>
<ToBeDeleted>true</ToBeDeleted>
<ToBeUpdated>true</ToBeUpdated>
</SlotTags>
<SlotAdjustments>
<SlotAdjustmentId>1</SlotAdjustmentId>
<SlotId>1</SlotId>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateName>string</PayRateName>
<PayRateType>1</PayRateType>
<PayRateValue>1.1</PayRateValue>
<Quantity>1.1</Quantity>
<PayValue>1.1</PayValue>
<CreatedBy>string</CreatedBy>
<CreatedByName>string</CreatedByName>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<HolidayPayAdjustment>true</HolidayPayAdjustment>
<ToBeDeleted>true</ToBeDeleted>
</SlotAdjustments>
<SlotSwipes>
<SwipeId>1</SwipeId>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<Direction>1</Direction>
<DirectionName>string</DirectionName>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<RevisedDateTime>1970-01-01T00:00:00.001Z</RevisedDateTime>
<SwipeTypeId>1</SwipeTypeId>
<SwipeTypeName>string</SwipeTypeName>
<PeripheralKey>00000000-0000-0000-0000-000000000000</PeripheralKey>
<PeripheralName>string</PeripheralName>
<PeripheralLocation>string</PeripheralLocation>
<Rounded>true</Rounded>
<SwipeStatusId>0</SwipeStatusId>
<SwipeReasonId>0</SwipeReasonId>
<StartBreakEndTypeId>0</StartBreakEndTypeId>
<SwipeProcessingTypeId>0</SwipeProcessingTypeId>
<Status_Auto>true</Status_Auto>
<Status_Noted>true</Status_Noted>
<Swipe_Latitude>1.1</Swipe_Latitude>
<Swipe_Longitude>1.1</Swipe_Longitude>
<OutsideSTDistanceAllowed>true</OutsideSTDistanceAllowed>
</SlotSwipes>
<SlotNotes>
<SlotNoteId>1</SlotNoteId>
<SlotId>1</SlotId>
<Note>string</Note>
<CreatedBy>string</CreatedBy>
<CreatedByName>string</CreatedByName>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<HolidayPayAdjustment>true</HolidayPayAdjustment>
<HiddenFlag>true</HiddenFlag>
<ToBeUpdated>true</ToBeUpdated>
<ToBeDeleted>true</ToBeDeleted>
</SlotNotes>
<SlotAudits>
<ActionId>1</ActionId>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<Id>1</Id>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<Result>string</Result>
<UserId>string</UserId>
<UserDisplayName>string</UserDisplayName>
</SlotAudits>
<SelectedGameSlotBonuses>
<SlotBonusId>1</SlotBonusId>
<SlotId>1</SlotId>
<BonusKey>00000000-0000-0000-0000-000000000000</BonusKey>
<ToBeDeleted>true</ToBeDeleted>
</SelectedGameSlotBonuses>
<GameSlotBonuses>
<BonusKey>00000000-0000-0000-0000-000000000000</BonusKey>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Name>string</Name>
<PayRateKey>00000000-0000-0000-0000-000000000000</PayRateKey>
<PayRateMultiplier>1.1</PayRateMultiplier>
</GameSlotBonuses>
<SlotAdvertisement>
<AdvertiseId>1</AdvertiseId>
<SlotId>1</SlotId>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
</SlotAdvertisement>
<SlotTypes>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</SlotTypes>
<Persons>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Persons>
<Groups>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Groups>
<Shifts>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Shifts>
<Jobs>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Jobs>
<OnlyPayRates>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</OnlyPayRates>
<Adjustments>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Adjustments>
<Peripherals>
<KeyValue>00000000-0000-0000-0000-000000000000</KeyValue>
<Name>string</Name>
<Sort>1</Sort>
<Default>true</Default>
</Peripherals>
<RotaLockDate>1970-01-01T00:00:00.001Z</RotaLockDate>
<PlannedSlots>true</PlannedSlots>
<DefaultSlotType>00000000-0000-0000-0000-000000000000</DefaultSlotType>
<HideUnallocatedRow>true</HideUnallocatedRow>
<ShowFlexiChunksTab>true</ShowFlexiChunksTab>
<PayUnplannedSlots>true</PayUnplannedSlots>
<AutoCreateTaskChunks>true</AutoCreateTaskChunks>
<ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY>string</ShowOriginalJobIfMismatchOnShiftPattern_DISPLAY>
<ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY>string</ShowOriginalShiftIfMismatchOnShiftPattern_DISPLAY>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type slotId query long
personKey query string personKeyToSwapWith query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SLOTTYPE
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/SLOTTYPE/PROCESSMESSAGE
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type slotTypeMessage
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SlotTypeMessageDto {
OrganisationId (string, optional),
ConnectorId (string, optional),
SlotTypes (Array[SlotTypeMessageDetailDto], optional)
}
SlotTypeMessageDetailDto {
SlotTypeName (string, optional),
IdNumber (string, optional)
}
{
"OrganisationId": "00000000-0000-0000-0000-000000000000",
"ConnectorId": "00000000-0000-0000-0000-000000000000",
"SlotTypes": [
{
"SlotTypeName": "string",
"IdNumber": "string"
}
]
}
<?xml version="1.0"?>
<SlotTypeMessageDto>
<OrganisationId>00000000-0000-0000-0000-000000000000</OrganisationId>
<ConnectorId>00000000-0000-0000-0000-000000000000</ConnectorId>
<SlotTypes>
<SlotTypeName>string</SlotTypeName>
<IdNumber>string</IdNumber>
</SlotTypes>
</SlotTypeMessageDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SWIPES
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/SELFSERVICES/JOBS/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
JobKey (string, optional),
JobCode (string, optional),
Name (string, optional),
SelectedGroupIds (string, optional),
DefaultValue (boolean, optional),
Sort (integer, optional),
Id (integer, optional),
OrganisationId (integer, optional),
CustomTypeId (integer, optional),
Status (integer, optional) = ['0', '1']
integerEnum:0, 1
,
CreatedDate (string, optional),
UpdatedDate (string, optional),
HistoryCreated (string, optional),
HistoryStart (string, optional),
HistoryEnd (string, optional),
UserId (string, optional),
Terminate (boolean, optional)
}
[
{
"JobKey": "00000000-0000-0000-0000-000000000000",
"JobCode": "string",
"Name": "string",
"SelectedGroupIds": "string",
"DefaultValue": true,
"Sort": 0,
"Id": 0,
"OrganisationId": 0,
"CustomTypeId": 0,
"Status": 0,
"CreatedDate": "2024-11-07T02:04:39.080Z",
"UpdatedDate": "2024-11-07T02:04:39.080Z",
"HistoryCreated": "2024-11-07T02:04:39.080Z",
"HistoryStart": "2024-11-07T02:04:39.080Z",
"HistoryEnd": "2024-11-07T02:04:39.080Z",
"UserId": "string",
"Terminate": true
}
]
<?xml version="1.0"?>
<Inline Model>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<JobCode>string</JobCode>
<Name>string</Name>
<SelectedGroupIds>string</SelectedGroupIds>
<DefaultValue>true</DefaultValue>
<Sort>1</Sort>
<Id>1</Id>
<OrganisationId>1</OrganisationId>
<CustomTypeId>1</CustomTypeId>
<Status>0</Status>
<CreatedDate>1970-01-01T00:00:00.001Z</CreatedDate>
<UpdatedDate>1970-01-01T00:00:00.001Z</UpdatedDate>
<HistoryCreated>1970-01-01T00:00:00.001Z</HistoryCreated>
<HistoryStart>1970-01-01T00:00:00.001Z</HistoryStart>
<HistoryEnd>1970-01-01T00:00:00.001Z</HistoryEnd>
<UserId>string</UserId>
<Terminate>true</Terminate>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/DEPARTMENTS/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
DepartmentId (string, optional),
DepartmentName (string, optional)
}
[
{
"DepartmentId": "00000000-0000-0000-0000-000000000000",
"DepartmentName": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<DepartmentId>00000000-0000-0000-0000-000000000000</DepartmentId>
<DepartmentName>string</DepartmentName>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SWIPES/MOVEOUTSIDE
*
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
No Content
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/LASTSWIPE/{PERSONKEY}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
LastSwipeDto {
Direction (integer, optional) = ['1', '2']
integerEnum:1, 2
,
EventDateTime (string, optional),
GroupName (string, optional),
JobName (string, optional)
}
{
"Direction": 1,
"EventDateTime": "2024-11-07T02:04:39.083Z",
"GroupName": "string",
"JobName": "string"
}
<?xml version="1.0"?>
<LastSwipeDto>
<Direction>1</Direction>
<EventDateTime>1970-01-01T00:00:00.001Z</EventDateTime>
<GroupName>string</GroupName>
<JobName>string</JobName>
</LastSwipeDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey path
string fromDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/ASSIGNEDPERSONS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
GroupId (string, optional),
GroupName (string, optional),
PersonKey (string, optional),
PersonFirstName (string, optional),
PersonLastName (string, optional),
PersonDisplayName (string, optional),
PersonStatus (integer, optional),
IsSystemUser (boolean, optional),
JobIds (string, optional),
PersonDefaultJobName (string, optional),
QualificationIds (string, optional),
PersonDefaultQualificationName (string, optional),
RoleId (string, optional),
PersonRoleName (string, optional),
CustomTypeId (integer, optional),
IdNumbers (string, optional)
}
[
{
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonFirstName": "string",
"PersonLastName": "string",
"PersonDisplayName": "string",
"PersonStatus": 0,
"IsSystemUser": true,
"JobIds": "string",
"PersonDefaultJobName": "string",
"QualificationIds": "string",
"PersonDefaultQualificationName": "string",
"RoleId": "string",
"PersonRoleName": "string",
"CustomTypeId": 0,
"IdNumbers": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonFirstName>string</PersonFirstName>
<PersonLastName>string</PersonLastName>
<PersonDisplayName>string</PersonDisplayName>
<PersonStatus>1</PersonStatus>
<IsSystemUser>true</IsSystemUser>
<JobIds>string</JobIds>
<PersonDefaultJobName>string</PersonDefaultJobName>
<QualificationIds>string</QualificationIds>
<PersonDefaultQualificationName>string</PersonDefaultQualificationName>
<RoleId>string</RoleId>
<PersonRoleName>string</PersonRoleName>
<CustomTypeId>1</CustomTypeId>
<IdNumbers>string</IdNumbers>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SWIPES/GETEARLIESTANDLATESTSWIPEPERDAY
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
swipeRange.connectorId query string swipeRange.rangeStart query date-time
swipeRange.rangeEnd query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TIMEOFFREQUEST
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/SELFSERVICES/ENTITLEMENTDETAILS/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
EntitlementDetailsDto {
TimeAccountTypeId (integer, optional),
DateRanges (Array[DateRangeDatePairsDto], optional)
}
DateRangeDatePairsDto {
StartDate (string, optional),
EndDate (string, optional)
}
{
"TimeAccountTypeId": 0,
"DateRanges": [
{
"StartDate": "2024-11-07T02:04:39.087Z",
"EndDate": "2024-11-07T02:04:39.087Z"
}
]
}
<?xml version="1.0"?>
<EntitlementDetailsDto>
<TimeAccountTypeId>1</TimeAccountTypeId>
<DateRanges>
<StartDate>1970-01-01T00:00:00.001Z</StartDate>
<EndDate>1970-01-01T00:00:00.001Z</EndDate>
</DateRanges>
</EntitlementDetailsDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
timeAccountType query integer
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/ENTITLEMENTTOTALS/PERSON/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
EntitlementTotalsDto {
TimeAccountTypeId (integer, optional),
TotalPaidOutSeconds (integer, optional),
TotalPaidInSeconds (integer, optional),
TotalNetSeconds (integer, optional),
TotalPaidOutDays (number, optional),
TotalPaidInDays (number, optional),
TotalNetDays (number, optional),
TotalPaidOutWeeks (number, optional),
TotalPaidInWeeks (number, optional),
TotalNetWeeks (number, optional),
ShowSelfServiceDefaultTotals (boolean, optional),
ShowHours (boolean, optional),
ShowDays (boolean, optional),
ShowWeeks (boolean, optional),
ShowToDateValues (boolean, optional),
ShowProjectedValues (boolean, optional),
ToDatePaidOutSeconds (integer, optional),
ToDatePaidInSeconds (integer, optional),
ToDateNetSeconds (integer, optional),
ToDatePaidOutDays (number, optional),
ToDatePaidInDays (number, optional),
ToDateNetDays (number, optional),
ToDatePaidOutWeeks (number, optional),
ToDatePaidInWeeks (number, optional),
ToDateNetWeeks (number, optional),
ProjectedPaidOutSeconds (integer, optional),
ProjectedPaidInSeconds (integer, optional),
ProjectedNetSeconds (integer, optional),
ProjectedPaidOutDays (number, optional),
ProjectedPaidInDays (number, optional),
ProjectedNetDays (number, optional),
ProjecedPaidOutTotalWeeks (number, optional),
ProjectedPaidInWeeks (number, optional),
ProjectedNetWeeks (number, optional)
}
{
"TimeAccountTypeId": 0,
"TotalPaidOutSeconds": 0,
"TotalPaidInSeconds": 0,
"TotalNetSeconds": 0,
"TotalPaidOutDays": 0,
"TotalPaidInDays": 0,
"TotalNetDays": 0,
"TotalPaidOutWeeks": 0,
"TotalPaidInWeeks": 0,
"TotalNetWeeks": 0,
"ShowSelfServiceDefaultTotals": true,
"ShowHours": true,
"ShowDays": true,
"ShowWeeks": true,
"ShowToDateValues": true,
"ShowProjectedValues": true,
"ToDatePaidOutSeconds": 0,
"ToDatePaidInSeconds": 0,
"ToDateNetSeconds": 0,
"ToDatePaidOutDays": 0,
"ToDatePaidInDays": 0,
"ToDateNetDays": 0,
"ToDatePaidOutWeeks": 0,
"ToDatePaidInWeeks": 0,
"ToDateNetWeeks": 0,
"ProjectedPaidOutSeconds": 0,
"ProjectedPaidInSeconds": 0,
"ProjectedNetSeconds": 0,
"ProjectedPaidOutDays": 0,
"ProjectedPaidInDays": 0,
"ProjectedNetDays": 0,
"ProjecedPaidOutTotalWeeks": 0,
"ProjectedPaidInWeeks": 0,
"ProjectedNetWeeks": 0
}
<?xml version="1.0"?>
<EntitlementTotalsDto>
<TimeAccountTypeId>1</TimeAccountTypeId>
<TotalPaidOutSeconds>1</TotalPaidOutSeconds>
<TotalPaidInSeconds>1</TotalPaidInSeconds>
<TotalNetSeconds>1</TotalNetSeconds>
<TotalPaidOutDays>1.1</TotalPaidOutDays>
<TotalPaidInDays>1.1</TotalPaidInDays>
<TotalNetDays>1.1</TotalNetDays>
<TotalPaidOutWeeks>1.1</TotalPaidOutWeeks>
<TotalPaidInWeeks>1.1</TotalPaidInWeeks>
<TotalNetWeeks>1.1</TotalNetWeeks>
<ShowSelfServiceDefaultTotals>true</ShowSelfServiceDefaultTotals>
<ShowHours>true</ShowHours>
<ShowDays>true</ShowDays>
<ShowWeeks>true</ShowWeeks>
<ShowToDateValues>true</ShowToDateValues>
<ShowProjectedValues>true</ShowProjectedValues>
<ToDatePaidOutSeconds>1</ToDatePaidOutSeconds>
<ToDatePaidInSeconds>1</ToDatePaidInSeconds>
<ToDateNetSeconds>1</ToDateNetSeconds>
<ToDatePaidOutDays>1.1</ToDatePaidOutDays>
<ToDatePaidInDays>1.1</ToDatePaidInDays>
<ToDateNetDays>1.1</ToDateNetDays>
<ToDatePaidOutWeeks>1.1</ToDatePaidOutWeeks>
<ToDatePaidInWeeks>1.1</ToDatePaidInWeeks>
<ToDateNetWeeks>1.1</ToDateNetWeeks>
<ProjectedPaidOutSeconds>1</ProjectedPaidOutSeconds>
<ProjectedPaidInSeconds>1</ProjectedPaidInSeconds>
<ProjectedNetSeconds>1</ProjectedNetSeconds>
<ProjectedPaidOutDays>1.1</ProjectedPaidOutDays>
<ProjectedPaidInDays>1.1</ProjectedPaidInDays>
<ProjectedNetDays>1.1</ProjectedNetDays>
<ProjecedPaidOutTotalWeeks>1.1</ProjecedPaidOutTotalWeeks>
<ProjectedPaidInWeeks>1.1</ProjectedPaidInWeeks>
<ProjectedNetWeeks>1.1</ProjectedNetWeeks>
</EntitlementTotalsDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
timeAccountType query integer startRange query date-time endRange query
date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SELFSERVICES/TIMEOFFREQUESTS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type timeOffRequest
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
TimeOffRequestMainDto {
TimeOffRequestId (integer, optional),
OrganisationId (integer, optional),
DateOfRequest (string, optional),
PersonKey (string, optional),
PersonName (string, optional),
TimeAccountTypeId (integer, optional),
TimeAccountTypeName (string, optional),
DateFrom (string, optional),
DateTo (string, optional),
Status (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
CancellationStatus (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
DayType (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
ApproverPersonKey1 (string, optional),
ApproverPersonName1 (string, optional),
TimeFrom (string, optional),
TimeTo (string, optional),
RequesterNotes (string, optional),
Notes (Array[TimeOffRequestNoteDto], optional)
}
TimeOffRequestNoteDto {
TimeOffRequestNoteId (integer, optional),
TimeOffRequestId (integer, optional),
NoteType (integer, optional) = ['0', '1']
integerEnum:0, 1
,
NoteProcessType (integer, optional) = ['0', '1', '2', '3', '4', '5', '6']
integerEnum:0, 1, 2, 3, 4, 5, 6
,
DateCreated (string, optional),
Note (string, optional),
PersonKey (string, optional),
DisplayName (string, optional)
}
{
"TimeOffRequestId": 0,
"OrganisationId": 0,
"DateOfRequest": "2024-11-07T02:04:39.092Z",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonName": "string",
"TimeAccountTypeId": 0,
"TimeAccountTypeName": "string",
"DateFrom": "2024-11-07T02:04:39.092Z",
"DateTo": "2024-11-07T02:04:39.092Z",
"Status": 1,
"CancellationStatus": 0,
"DayType": 1,
"ApproverPersonKey1": "00000000-0000-0000-0000-000000000000",
"ApproverPersonName1": "string",
"TimeFrom": "string",
"TimeTo": "string",
"RequesterNotes": "string",
"Notes": [
{
"TimeOffRequestNoteId": 0,
"TimeOffRequestId": 0,
"NoteType": 0,
"NoteProcessType": 0,
"DateCreated": "2024-11-07T02:04:39.092Z",
"Note": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"DisplayName": "string"
}
]
}
<?xml version="1.0"?>
<TimeOffRequestMainDto>
<TimeOffRequestId>1</TimeOffRequestId>
<OrganisationId>1</OrganisationId>
<DateOfRequest>1970-01-01T00:00:00.001Z</DateOfRequest>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonName>string</PersonName>
<TimeAccountTypeId>1</TimeAccountTypeId>
<TimeAccountTypeName>string</TimeAccountTypeName>
<DateFrom>1970-01-01T00:00:00.001Z</DateFrom>
<DateTo>1970-01-01T00:00:00.001Z</DateTo>
<Status>1</Status>
<CancellationStatus>0</CancellationStatus>
<DayType>1</DayType>
<ApproverPersonKey1>00000000-0000-0000-0000-000000000000</ApproverPersonKey1>
<ApproverPersonName1>string</ApproverPersonName1>
<TimeFrom>string</TimeFrom>
<TimeTo>string</TimeTo>
<RequesterNotes>string</RequesterNotes>
<Notes>
<TimeOffRequestNoteId>1</TimeOffRequestNoteId>
<TimeOffRequestId>1</TimeOffRequestId>
<NoteType>0</NoteType>
<NoteProcessType>0</NoteProcessType>
<DateCreated>1970-01-01T00:00:00.001Z</DateCreated>
<Note>string</Note>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<DisplayName>string</DisplayName>
</Notes>
</TimeOffRequestMainDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /API/SELFSERVICES/TIMEOFFREQUEST
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type timeOffRequestId
query integer
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SELFSERVICES/TIMEOFFREQUEST/CANCEL
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type timeOffRequestId
query integer note query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/TIMEOFFREQUESTS/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
TimeOffRequestId (integer, optional),
OrganisationId (integer, optional),
DateOfRequest (string, optional),
PersonKey (string, optional),
PersonName (string, optional),
TimeAccountTypeId (integer, optional),
TimeAccountTypeName (string, optional),
DateFrom (string, optional),
DateTo (string, optional),
Status (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
CancellationStatus (integer, optional) = ['0', '1', '2', '3']
integerEnum:0, 1, 2, 3
,
DayType (integer, optional) = ['1', '2', '3', '4']
integerEnum:1, 2, 3, 4
,
ApproverPersonKey1 (string, optional),
ApproverPersonName1 (string, optional),
TimeFrom (string, optional),
TimeTo (string, optional),
RequesterNotes (string, optional),
Notes (Array[TimeOffRequestNoteDto], optional)
}
TimeOffRequestNoteDto {
TimeOffRequestNoteId (integer, optional),
TimeOffRequestId (integer, optional),
NoteType (integer, optional) = ['0', '1']
integerEnum:0, 1
,
NoteProcessType (integer, optional) = ['0', '1', '2', '3', '4', '5', '6']
integerEnum:0, 1, 2, 3, 4, 5, 6
,
DateCreated (string, optional),
Note (string, optional),
PersonKey (string, optional),
DisplayName (string, optional)
}
[
{
"TimeOffRequestId": 0,
"OrganisationId": 0,
"DateOfRequest": "2024-11-07T02:04:39.099Z",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonName": "string",
"TimeAccountTypeId": 0,
"TimeAccountTypeName": "string",
"DateFrom": "2024-11-07T02:04:39.099Z",
"DateTo": "2024-11-07T02:04:39.099Z",
"Status": 1,
"CancellationStatus": 0,
"DayType": 1,
"ApproverPersonKey1": "00000000-0000-0000-0000-000000000000",
"ApproverPersonName1": "string",
"TimeFrom": "string",
"TimeTo": "string",
"RequesterNotes": "string",
"Notes": [
{
"TimeOffRequestNoteId": 0,
"TimeOffRequestId": 0,
"NoteType": 0,
"NoteProcessType": 0,
"DateCreated": "2024-11-07T02:04:39.099Z",
"Note": "string",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"DisplayName": "string"
}
]
}
]
<?xml version="1.0"?>
<Inline Model>
<TimeOffRequestId>1</TimeOffRequestId>
<OrganisationId>1</OrganisationId>
<DateOfRequest>1970-01-01T00:00:00.001Z</DateOfRequest>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonName>string</PersonName>
<TimeAccountTypeId>1</TimeAccountTypeId>
<TimeAccountTypeName>string</TimeAccountTypeName>
<DateFrom>1970-01-01T00:00:00.001Z</DateFrom>
<DateTo>1970-01-01T00:00:00.001Z</DateTo>
<Status>1</Status>
<CancellationStatus>0</CancellationStatus>
<DayType>1</DayType>
<ApproverPersonKey1>00000000-0000-0000-0000-000000000000</ApproverPersonKey1>
<ApproverPersonName1>string</ApproverPersonName1>
<TimeFrom>string</TimeFrom>
<TimeTo>string</TimeTo>
<RequesterNotes>string</RequesterNotes>
<Notes>
<TimeOffRequestNoteId>1</TimeOffRequestNoteId>
<TimeOffRequestId>1</TimeOffRequestId>
<NoteType>0</NoteType>
<NoteProcessType>0</NoteProcessType>
<DateCreated>1970-01-01T00:00:00.001Z</DateCreated>
<Note>string</Note>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<DisplayName>string</DisplayName>
</Notes>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/TIMEACCOUNTTYPES/{PERSONKEY}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
TimeAccountTypeId (integer, optional),
Name (string, optional),
Default (boolean, optional),
SortOrder (integer, optional),
MinimumHoursPerRequestSeconds (integer, optional),
MaximumHoursPerRequestSeconds (integer, optional),
DocumentUploadType (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
,
AllowSpecificTimesOnRequest (boolean, optional),
RequestGoBackInDays (integer, optional)
}
[
{
"TimeAccountTypeId": 0,
"Name": "string",
"Default": true,
"SortOrder": 0,
"MinimumHoursPerRequestSeconds": 0,
"MaximumHoursPerRequestSeconds": 0,
"DocumentUploadType": 1,
"AllowSpecificTimesOnRequest": true,
"RequestGoBackInDays": 0
}
]
<?xml version="1.0"?>
<Inline Model>
<TimeAccountTypeId>1</TimeAccountTypeId>
<Name>string</Name>
<Default>true</Default>
<SortOrder>1</SortOrder>
<MinimumHoursPerRequestSeconds>1</MinimumHoursPerRequestSeconds>
<MaximumHoursPerRequestSeconds>1</MaximumHoursPerRequestSeconds>
<DocumentUploadType>1</DocumentUploadType>
<AllowSpecificTimesOnRequest>true</AllowSpecificTimesOnRequest>
<RequestGoBackInDays>1</RequestGoBackInDays>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/TIMEACCOUNTTYPEDETAILS/{PERSONKEY}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
TimeAccountTypeId (integer, optional),
Name (string, optional),
Default (boolean, optional),
SortOrder (integer, optional),
MinimumHoursPerRequestSeconds (integer, optional),
MaximumHoursPerRequestSeconds (integer, optional),
DocumentUploadType (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
,
AllowSpecificTimesOnRequest (boolean, optional),
RequestGoBackInDays (integer, optional)
}
[
{
"TimeAccountTypeId": 0,
"Name": "string",
"Default": true,
"SortOrder": 0,
"MinimumHoursPerRequestSeconds": 0,
"MaximumHoursPerRequestSeconds": 0,
"DocumentUploadType": 1,
"AllowSpecificTimesOnRequest": true,
"RequestGoBackInDays": 0
}
]
<?xml version="1.0"?>
<Inline Model>
<TimeAccountTypeId>1</TimeAccountTypeId>
<Name>string</Name>
<Default>true</Default>
<SortOrder>1</SortOrder>
<MinimumHoursPerRequestSeconds>1</MinimumHoursPerRequestSeconds>
<MaximumHoursPerRequestSeconds>1</MaximumHoursPerRequestSeconds>
<DocumentUploadType>1</DocumentUploadType>
<AllowSpecificTimesOnRequest>true</AllowSpecificTimesOnRequest>
<RequestGoBackInDays>1</RequestGoBackInDays>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey path
string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* UNALLOCATEDSLOTS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/SELFSERVICES/UNALLOCATEDSLOTS/{PERSONKEY}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
SlotId (integer, optional),
OrganisationId (integer, optional),
GroupId (string, optional),
SlotTypeId (string, optional),
SlotTypeName (string, optional),
SlotStatusId (integer, optional) = ['0', '1', '2', '3', '4', '5']
integerEnum:0, 1, 2, 3, 4, 5
,
JobKey (string, optional),
PersonId (string, optional),
DisplayName (string, optional),
ShiftKey (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
ActualStart (string, optional),
ActualEnd (string, optional),
TotalPlannedHours (string, optional),
TotalActualHours (string, optional),
DisplayPlannedHours (string, optional),
DisplayActualHours (string, optional),
DisplayTimeStart (string, optional, read only),
DisplayTimeEnd (string, optional, read only),
DisplayActualStartAndEndTimes (string, optional, read only),
ShiftPatternDeploymentId (integer, optional),
ContractedHours (boolean, optional),
PayRateId (string, optional),
Published (boolean, optional),
ExceptionsCount (integer, optional),
HasSwipes (boolean, optional),
JobName (string, optional),
ShiftName (string, optional),
SlotTypeCSSColour (string, optional),
StatusColour (string, optional),
SlotName (string, optional),
SlotStatus (string, optional),
DepartmentName (string, optional),
LocationName (string, optional),
GamePoints (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
BonusNames (string, optional),
Notes (string, optional),
GameSlotBonuses (string, optional)
}
[
{
"SlotId": 0,
"OrganisationId": 0,
"GroupId": "00000000-0000-0000-0000-000000000000",
"SlotTypeId": "00000000-0000-0000-0000-000000000000",
"SlotTypeName": "string",
"SlotStatusId": 0,
"JobKey": "00000000-0000-0000-0000-000000000000",
"PersonId": "00000000-0000-0000-0000-000000000000",
"DisplayName": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"PlannedStart": "2024-11-07T02:04:39.104Z",
"PlannedEnd": "2024-11-07T02:04:39.104Z",
"ActualStart": "2024-11-07T02:04:39.104Z",
"ActualEnd": "2024-11-07T02:04:39.104Z",
"TotalPlannedHours": "string",
"TotalActualHours": "string",
"DisplayPlannedHours": "string",
"DisplayActualHours": "string",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"DisplayActualStartAndEndTimes": "string",
"ShiftPatternDeploymentId": 0,
"ContractedHours": true,
"PayRateId": "00000000-0000-0000-0000-000000000000",
"Published": true,
"ExceptionsCount": 0,
"HasSwipes": true,
"JobName": "string",
"ShiftName": "string",
"SlotTypeCSSColour": "string",
"StatusColour": "string",
"SlotName": "string",
"SlotStatus": "string",
"DepartmentName": "string",
"LocationName": "string",
"GamePoints": 0,
"AdvertiseFrom": "2024-11-07T02:04:39.104Z",
"AdvertiseTo": "2024-11-07T02:04:39.104Z",
"BonusNames": "string",
"Notes": "string",
"GameSlotBonuses": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<SlotId>1</SlotId>
<OrganisationId>1</OrganisationId>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<SlotTypeId>00000000-0000-0000-0000-000000000000</SlotTypeId>
<SlotTypeName>string</SlotTypeName>
<SlotStatusId>0</SlotStatusId>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<PersonId>00000000-0000-0000-0000-000000000000</PersonId>
<DisplayName>string</DisplayName>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<ActualStart>1970-01-01T00:00:00.001Z</ActualStart>
<ActualEnd>1970-01-01T00:00:00.001Z</ActualEnd>
<TotalPlannedHours>string</TotalPlannedHours>
<TotalActualHours>string</TotalActualHours>
<DisplayPlannedHours>string</DisplayPlannedHours>
<DisplayActualHours>string</DisplayActualHours>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<DisplayActualStartAndEndTimes>string</DisplayActualStartAndEndTimes>
<ShiftPatternDeploymentId>1</ShiftPatternDeploymentId>
<ContractedHours>true</ContractedHours>
<PayRateId>00000000-0000-0000-0000-000000000000</PayRateId>
<Published>true</Published>
<ExceptionsCount>1</ExceptionsCount>
<HasSwipes>true</HasSwipes>
<JobName>string</JobName>
<ShiftName>string</ShiftName>
<SlotTypeCSSColour>string</SlotTypeCSSColour>
<StatusColour>string</StatusColour>
<SlotName>string</SlotName>
<SlotStatus>string</SlotStatus>
<DepartmentName>string</DepartmentName>
<LocationName>string</LocationName>
<GamePoints>1</GamePoints>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<BonusNames>string</BonusNames>
<Notes>string</Notes>
<GameSlotBonuses>string</GameSlotBonuses>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personKey path
string startDate query date-time endDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/UNALLOCATEDSLOTREQUESTS/{PERSONID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
UnallocatedSlotRequestId (integer, optional),
OrganisationId (integer, optional),
Status (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
,
DateOfRequest (string, optional),
PersonKey (string, optional),
PersonName (string, optional),
SlotId (integer, optional),
RequesterNotes (string, optional),
ApproverPersonKey (string, optional),
ApproverPersonName (string, optional),
ApproverNotes (string, optional),
ShiftKey (string, optional),
ShiftName (string, optional),
GroupId (string, optional),
DepartmentName (string, optional),
PlannedStart (string, optional),
PlannedEnd (string, optional),
DisplayTimeStart (string, optional),
DisplayTimeEnd (string, optional),
JobKey (string, optional),
JobName (string, optional),
GamePoints (integer, optional),
AdvertiseFrom (string, optional),
AdvertiseTo (string, optional),
BonusNames (string, optional)
}
[
{
"UnallocatedSlotRequestId": 0,
"OrganisationId": 0,
"Status": 1,
"DateOfRequest": "2024-11-07T02:04:39.107Z",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonName": "string",
"SlotId": 0,
"RequesterNotes": "string",
"ApproverPersonKey": "00000000-0000-0000-0000-000000000000",
"ApproverPersonName": "string",
"ApproverNotes": "string",
"ShiftKey": "00000000-0000-0000-0000-000000000000",
"ShiftName": "string",
"GroupId": "00000000-0000-0000-0000-000000000000",
"DepartmentName": "string",
"PlannedStart": "2024-11-07T02:04:39.107Z",
"PlannedEnd": "2024-11-07T02:04:39.107Z",
"DisplayTimeStart": "string",
"DisplayTimeEnd": "string",
"JobKey": "00000000-0000-0000-0000-000000000000",
"JobName": "string",
"GamePoints": 0,
"AdvertiseFrom": "2024-11-07T02:04:39.107Z",
"AdvertiseTo": "2024-11-07T02:04:39.107Z",
"BonusNames": "string"
}
]
<?xml version="1.0"?>
<Inline Model>
<UnallocatedSlotRequestId>1</UnallocatedSlotRequestId>
<OrganisationId>1</OrganisationId>
<Status>1</Status>
<DateOfRequest>1970-01-01T00:00:00.001Z</DateOfRequest>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonName>string</PersonName>
<SlotId>1</SlotId>
<RequesterNotes>string</RequesterNotes>
<ApproverPersonKey>00000000-0000-0000-0000-000000000000</ApproverPersonKey>
<ApproverPersonName>string</ApproverPersonName>
<ApproverNotes>string</ApproverNotes>
<ShiftKey>00000000-0000-0000-0000-000000000000</ShiftKey>
<ShiftName>string</ShiftName>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<DepartmentName>string</DepartmentName>
<PlannedStart>1970-01-01T00:00:00.001Z</PlannedStart>
<PlannedEnd>1970-01-01T00:00:00.001Z</PlannedEnd>
<DisplayTimeStart>string</DisplayTimeStart>
<DisplayTimeEnd>string</DisplayTimeEnd>
<JobKey>00000000-0000-0000-0000-000000000000</JobKey>
<JobName>string</JobName>
<GamePoints>1</GamePoints>
<AdvertiseFrom>1970-01-01T00:00:00.001Z</AdvertiseFrom>
<AdvertiseTo>1970-01-01T00:00:00.001Z</AdvertiseTo>
<BonusNames>string</BonusNames>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type personId path string
startDate query date-time
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /API/SELFSERVICES/UNALLOCATEDSLOTREQUEST
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
unallocatedSlotRequestId query integer
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SELFSERVICES/UNALLOCATEDSLOTREQUEST
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
unallocatedSlotRequest
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
UnallocatedSlotRequestMainDto {
UnallocatedSlotRequestId (integer, optional),
OrganisationId (integer, optional),
Status (integer, optional) = ['1', '2', '3']
integerEnum:1, 2, 3
,
DisplayStatus (integer, optional) = ['1', '2']
integerEnum:1, 2
,
DateOfRequest (string, optional),
DateProcessed (string, optional),
PersonKey (string, optional),
PersonName (string, optional),
ApprovedPersonNames (string, optional),
RejectedPersonNames (string, optional),
SlotId (integer, optional),
RequesterNotes (string, optional),
ApproverUserId (string, optional),
ApproverPersonName (string, optional),
ApproverNotes (string, optional),
SlotDetails (string, optional),
SlotDisplayPlannedTimes (string, optional),
GroupId (string, optional),
GroupName (string, optional)
}
{
"UnallocatedSlotRequestId": 0,
"OrganisationId": 0,
"Status": 1,
"DisplayStatus": 1,
"DateOfRequest": "2024-11-07T02:04:39.109Z",
"DateProcessed": "2024-11-07T02:04:39.109Z",
"PersonKey": "00000000-0000-0000-0000-000000000000",
"PersonName": "string",
"ApprovedPersonNames": "string",
"RejectedPersonNames": "string",
"SlotId": 0,
"RequesterNotes": "string",
"ApproverUserId": "string",
"ApproverPersonName": "string",
"ApproverNotes": "string",
"SlotDetails": "string",
"SlotDisplayPlannedTimes": "string",
"GroupId": "00000000-0000-0000-0000-000000000000",
"GroupName": "string"
}
<?xml version="1.0"?>
<UnallocatedSlotRequestMainDto>
<UnallocatedSlotRequestId>1</UnallocatedSlotRequestId>
<OrganisationId>1</OrganisationId>
<Status>1</Status>
<DisplayStatus>1</DisplayStatus>
<DateOfRequest>1970-01-01T00:00:00.001Z</DateOfRequest>
<DateProcessed>1970-01-01T00:00:00.001Z</DateProcessed>
<PersonKey>00000000-0000-0000-0000-000000000000</PersonKey>
<PersonName>string</PersonName>
<ApprovedPersonNames>string</ApprovedPersonNames>
<RejectedPersonNames>string</RejectedPersonNames>
<SlotId>1</SlotId>
<RequesterNotes>string</RequesterNotes>
<ApproverUserId>string</ApproverUserId>
<ApproverPersonName>string</ApproverPersonName>
<ApproverNotes>string</ApproverNotes>
<SlotDetails>string</SlotDetails>
<SlotDisplayPlannedTimes>string</SlotDisplayPlannedTimes>
<GroupId>00000000-0000-0000-0000-000000000000</GroupId>
<GroupName>string</GroupName>
</UnallocatedSlotRequestMainDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USER
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/SELFSERVICES/USERDETAILS/{ID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
UserDetailsDto {
Id (string, optional),
PersonId (string, optional),
FirstName (string, optional),
LastName (string, optional),
DisplayName (string, optional),
CanBookTimeOff (boolean, optional),
CanClockIn (boolean, optional),
DefaultUnavailable (boolean, optional),
CanSetAvailability (boolean, optional),
CanRequestWork (boolean, optional),
CanSlotSwap (boolean, optional),
CanClockInPersons (boolean, optional),
GPSData (integer, optional) = ['1', '2']
integerEnum:1, 2
,
CanViewRota (boolean, optional),
CanViewTeamRota (boolean, optional),
ViewPeopleType (integer, optional) = ['0', '1']
integerEnum:0, 1
,
CanViewSlotDetails (boolean, optional),
ViewFiles (boolean, optional),
ViewSlotSwap (boolean, optional),
QRCode (boolean, optional),
KioskMode (boolean, optional),
GamificationEnabled (boolean, optional),
ViewCosts (boolean, optional),
Currency (string, optional)
}
{
"Id": "string",
"PersonId": "00000000-0000-0000-0000-000000000000",
"FirstName": "string",
"LastName": "string",
"DisplayName": "string",
"CanBookTimeOff": true,
"CanClockIn": true,
"DefaultUnavailable": true,
"CanSetAvailability": true,
"CanRequestWork": true,
"CanSlotSwap": true,
"CanClockInPersons": true,
"GPSData": 1,
"CanViewRota": true,
"CanViewTeamRota": true,
"ViewPeopleType": 0,
"CanViewSlotDetails": true,
"ViewFiles": true,
"ViewSlotSwap": true,
"QRCode": true,
"KioskMode": true,
"GamificationEnabled": true,
"ViewCosts": true,
"Currency": "string"
}
<?xml version="1.0"?>
<UserDetailsDto>
<Id>string</Id>
<PersonId>00000000-0000-0000-0000-000000000000</PersonId>
<FirstName>string</FirstName>
<LastName>string</LastName>
<DisplayName>string</DisplayName>
<CanBookTimeOff>true</CanBookTimeOff>
<CanClockIn>true</CanClockIn>
<DefaultUnavailable>true</DefaultUnavailable>
<CanSetAvailability>true</CanSetAvailability>
<CanRequestWork>true</CanRequestWork>
<CanSlotSwap>true</CanSlotSwap>
<CanClockInPersons>true</CanClockInPersons>
<GPSData>1</GPSData>
<CanViewRota>true</CanViewRota>
<CanViewTeamRota>true</CanViewTeamRota>
<ViewPeopleType>0</ViewPeopleType>
<CanViewSlotDetails>true</CanViewSlotDetails>
<ViewFiles>true</ViewFiles>
<ViewSlotSwap>true</ViewSlotSwap>
<QRCode>true</QRCode>
<KioskMode>true</KioskMode>
<GamificationEnabled>true</GamificationEnabled>
<ViewCosts>true</ViewCosts>
<Currency>string</Currency>
</UserDetailsDto>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type Id path string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/USERDETAILSOKTA
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
UserDetailsOktaDto {
Id (string, optional),
FirstName (string, optional),
LastName (string, optional),
CanHaveSelfService (boolean, optional)
}
{
"Id": "string",
"FirstName": "string",
"LastName": "string",
"CanHaveSelfService": true
}
<?xml version="1.0"?>
<UserDetailsOktaDto>
<Id>string</Id>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CanHaveSelfService>true</CanHaveSelfService>
</UserDetailsOktaDto>
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SELFSERVICES/RESETPASSWORD
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type forgotPasswordModel
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ForgotPasswordDto {
Email (string)
}
{
"Email": "string"
}
<?xml version="1.0"?>
<ForgotPasswordDto>
<Email>string</Email>
</ForgotPasswordDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/SELFSERVICES/CHANGEPASSWORD
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type changePasswordModel
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
ChangePasswordDto {
UserId (string),
CurrentPassword (string),
NewPassword (string)
}
{
"UserId": "string",
"CurrentPassword": "string",
"NewPassword": "string"
}
<?xml version="1.0"?>
<ChangePasswordDto>
<UserId>string</UserId>
<CurrentPassword>string</CurrentPassword>
<NewPassword>string</NewPassword>
</ChangePasswordDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/SELFSERVICES/USER/PERMISSIONS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /API/SELFSERVICES/SETTWOFACTOR
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USERTRACKING
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/USERTRACKING
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
<?xml version="1.0"?>
<!-- invalid XML -->
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
selfServiceUserTrackingApiDto
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
SelfServiceUserTrackingApiDto {
DateTime (string, optional),
Event (string, optional),
Browser (string, optional),
OperatingSystem (string, optional),
Domain (string, optional),
UserAgent (string, optional)
}
{
"DateTime": "2024-11-07T02:04:39.118Z",
"Event": "string",
"Browser": "string",
"OperatingSystem": "string",
"Domain": "string",
"UserAgent": "string"
}
<?xml version="1.0"?>
<SelfServiceUserTrackingApiDto>
<DateTime>1970-01-01T00:00:00.001Z</DateTime>
<Event>string</Event>
<Browser>string</Browser>
<OperatingSystem>string</OperatingSystem>
<Domain>string</Domain>
<UserAgent>string</UserAgent>
</SelfServiceUserTrackingApiDto>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: , API VERSION: V1 ]