api.helloflex.com
Open in
urlscan Pro
40.68.42.228
Public Scan
Submitted URL: https://api.helloflex.com/
Effective URL: https://api.helloflex.com/docs/index
Submission: On June 13 via api from NL — Scanned from NL
Effective URL: https://api.helloflex.com/docs/index
Submission: On June 13 via api from NL — Scanned from NL
Form analysis 89 forms found in the DOM
<form id="api_selector" style="display: none;">
<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"><label for="msearch0.20104757137261253">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.20104757137261253" type="text" value="">
</td>
<td class="markdown">
<p>String value for search by activity title name and description., Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.6300744713538253">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.6300744713538253" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>You can find possible values at GET api/domainTypes/927/domainValues. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpriorityIds0.8227218162526402">priorityIds</label></td>
<td>
<textarea class="body-textarea" name="priorityIds" id="mpriorityIds0.8227218162526402" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>You can find possible values at GET api/domainTypes/926/domainValues. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtypeIds0.22772183297301596">typeIds</label></td>
<td>
<textarea class="body-textarea" name="typeIds" id="mtypeIds0.22772183297301596" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>You can find possible values at GET api/domainTypes/918/domainValues. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="msubjectIds0.5422651332215236">subjectIds</label></td>
<td>
<textarea class="body-textarea" name="subjectIds" id="msubjectIds0.5422651332215236" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>You can find possible values at GET api/domainTypes/865/domainValues. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mownerUserGuids0.08336437919333628">ownerUserGuids</label></td>
<td>
<textarea class="body-textarea" name="ownerUserGuids" id="mownerUserGuids0.08336437919333628" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>You can find possible values at GET /api/agencies/{agencyGuid}/contactperson, GET /api/employers/{employerGuid}/contactpersons or GET /api/candidates. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="massigneeTypeId0.3809599960357426">assigneeTypeId</label></td>
<td>
<input class="parameter" minlength="0" name="assigneeTypeId" placeholder="" id="massigneeTypeId0.3809599960357426" type="text" value="">
</td>
<td class="markdown">
<p>1 = User, 2 = Department, 3 = Agency.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="massignedUserGuids0.5574376060431896">assignedUserGuids</label></td>
<td>
<textarea class="body-textarea" name="assignedUserGuids" id="massignedUserGuids0.5574376060431896" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>You can find possible values at GET /api/agencies/{agencyGuid}/contactperson, GET /api/employers/{employerGuid}/contactpersons or GET /api/candidates. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mdepartmentIds0.880391065270834">departmentIds</label></td>
<td>
<textarea class="body-textarea" name="departmentIds" id="mdepartmentIds0.880391065270834" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>You can find possible values at GET api/domainTypes/930/domainValues. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="magencyGuids0.9522691866933823">agencyGuids</label></td>
<td>
<textarea class="body-textarea" name="agencyGuids" id="magencyGuids0.9522691866933823" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>You can find possible values at GET /api/agencies. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mdueDateFrom0.27597522107078487">dueDateFrom</label></td>
<td>
<input class="parameter" minlength="0" name="dueDateFrom" placeholder="" id="mdueDateFrom0.27597522107078487" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get activities with due date after the specified date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mdueDateTo0.4580217775621518">dueDateTo</label></td>
<td>
<input class="parameter" minlength="0" name="dueDateTo" placeholder="" id="mdueDateTo0.4580217775621518" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get activities with due date before the specified date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mincludeArchived0.014049858031154994">includeArchived</label></td>
<td>
<select class="parameter " name="includeArchived" id="mincludeArchived0.014049858031154994">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value. Get archived activities.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedDateTimeUtcFrom0.763527382358226">lastUpdatedDateTimeUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedDateTimeUtcFrom" placeholder="" id="mlastUpdatedDateTimeUtcFrom0.763527382358226" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get activities from last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.7285837578231202">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.7285837578231202" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.5034177094208598">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.5034177094208598" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mrequest0.5926563665013695">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.5926563665013695"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.27386034876894394" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.27386034876894394">
<option value="application/json">application/json</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">ActivityAddRequest {</span>
<div><span class="propName required">typeId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>You can find possible values at GET api/domainTypes/918/domainValues.</p>
</span>,</div>
<div><span class="propName required">priorityId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>You can find possible values at GET api/domainTypes/926/domainValues.</p>
</span>,</div>
<div><span class="propName required">entityStateId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>You can find possible values at GET api/domainTypes/927/domainValues.</p>
</span>,</div>
<div><span class="propName ">dueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The current date will be used if a value is not defined</p>
</span>,</div>
<div><span class="propName required">title</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 5000</p>
</span>,</div>
<div><span class="propName ">entityGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">entityTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET api/domainTypes/928/domainValues.</p>
</span>,</div>
<div><span class="propName required">ownerUserGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/agencies/{agencyGuid}/contactpersons, GET /api/employers/{employerGuid}/contactpersons or GET /api/candidates.</p>
</span>,</div>
<div><span class="propName ">assignedUserGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/agencies/{agencyGuid}/contactpersons, GET /api/employers/{employerGuid}/contactpersons or GET /api/candidates. Either assignedUserGuid, departmentId or agencyGuid should be set.
</p>
</span>,</div>
<div><span class="propName ">departmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/domainTypes/930/domainValues. Either assignedUserGuid, departmentId or agencyGuid should be set.</p>
</span>,</div>
<div><span class="propName ">agencyGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/agencies. Either assignedUserGuid, departmentId or agencyGuid should be set.</p>
</span>,</div>
<div><span class="propName ">subjectId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/domainTypes/865/domainValues.</p>
</span>,</div>
<div><span class="propName ">customCandidateGuids</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/candidates</p>
</span>,</div>
<div><span class="propName ">customContactPersonGuids</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/employers/contactpersons</p>
</span>,</div>
<div><span class="propName ">customEmployerGuids</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/employers</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"typeId": 0,
"priorityId": 0,
"entityStateId": 0,
"dueDate": "2024-06-13T09:50:13.243Z",
"title": "string",
"description": "string",
"entityGuid": "00000000-0000-0000-0000-000000000000",
"entityTypeId": 0,
"ownerUserGuid": "00000000-0000-0000-0000-000000000000",
"assignedUserGuid": "00000000-0000-0000-0000-000000000000",
"departmentId": 0,
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"subjectId": 0,
"customCandidateGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customContactPersonGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customEmployerGuids": [
"00000000-0000-0000-0000-000000000000"
]
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mactivityGuid0.8034577375879679">activityGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="activityGuid" placeholder="(required)" id="mactivityGuid0.8034577375879679" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Activity</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Activity with specified Guid was not found</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="mactivityGuid0.3801263598560949">activityGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="activityGuid" placeholder="(required)" id="mactivityGuid0.3801263598560949" 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="mrequest0.8729625035996504">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8729625035996504"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.835736934767424" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.835736934767424">
<option value="application/json">application/json</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">ActivityUpdateRequest {</span>
<div><span class="propName required">typeId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>You can find possible values at GET api/domainTypes/918/domainValues.</p>
</span>,</div>
<div><span class="propName required">priorityId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>You can find possible values at GET api/domainTypes/926/domainValues.</p>
</span>,</div>
<div><span class="propName required">entityStateId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>You can find possible values at GET api/domainTypes/927/domainValues.</p>
</span>,</div>
<div><span class="propName ">dueDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The current date will be used if a value is not defined</p>
</span>,</div>
<div><span class="propName required">title</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 5000</p>
</span>,</div>
<div><span class="propName ">entityGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">entityTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET api/domainTypes/928/domainValues.</p>
</span>,</div>
<div><span class="propName required">ownerUserGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/agencies/{agencyGuid}/contactpersons, GET /api/employers/{employerGuid}/contactpersons or GET /api/candidates.</p>
</span>,</div>
<div><span class="propName ">assignedUserGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/agencies/{agencyGuid}/contactpersons, GET /api/employers/{employerGuid}/contactpersons or GET /api/candidates. Either assignedUserGuid, departmentId or agencyGuid should be set.
</p>
</span>,</div>
<div><span class="propName ">departmentId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/domainTypes/930/domainValues. Either assignedUserGuid, departmentId or agencyGuid should be set.</p>
</span>,</div>
<div><span class="propName ">agencyGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/agencies. Either assignedUserGuid, departmentId or agencyGuid should be set.</p>
</span>,</div>
<div><span class="propName ">subjectId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/domainTypes/865/domainValues.</p>
</span>,</div>
<div><span class="propName ">customCandidateGuids</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/candidates</p>
</span>,</div>
<div><span class="propName ">customContactPersonGuids</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/employers/contactpersons</p>
</span>,</div>
<div><span class="propName ">customEmployerGuids</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>You can find possible values at GET /api/employers</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"typeId": 0,
"priorityId": 0,
"entityStateId": 0,
"dueDate": "2024-06-13T09:50:13.254Z",
"title": "string",
"description": "string",
"entityGuid": "00000000-0000-0000-0000-000000000000",
"entityTypeId": 0,
"ownerUserGuid": "00000000-0000-0000-0000-000000000000",
"assignedUserGuid": "00000000-0000-0000-0000-000000000000",
"departmentId": 0,
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"subjectId": 0,
"customCandidateGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customContactPersonGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customEmployerGuids": [
"00000000-0000-0000-0000-000000000000"
]
}</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>Updated successfully</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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"><label for="mentityStateIds0.8473482999787791">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.8473482999787791" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Agency. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="morganizationTypeIds0.10801721425039124">organizationTypeIds</label></td>
<td>
<textarea class="body-textarea" name="organizationTypeIds" id="morganizationTypeIds0.10801721425039124" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for OrganizationTypes of Agency. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.6154388841087517">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.6154388841087517" type="text" value="">
</td>
<td class="markdown">
<p>String value for search by agency name., Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.560979185576302">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.560979185576302" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get agency from last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.5393903849226396">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.5393903849226396" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get agency to last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.10313361528323384">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.10313361528323384" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.4824862351793513">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.4824862351793513" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mrequest0.0004785002148535167">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.0004785002148535167"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7484166481788184" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7484166481788184">
<option value="application/json">application/json</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">AgencyAddRequest {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">shortName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">legalName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">phone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Should be a valid email : , Max. length : 128</p>
</span>,</div>
<div><span class="propName ">parentGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>GUID of parent agency. If empty will be assigned to customer organization</p>
</span>,</div>
<div><span class="propName required">organizationTypeId</span> (<span class="propType">integer</span>),</div>
<div><span class="propName ">contactUserGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>GUID of ContactUser. If empty will be assigned to customer user</p>
</span>,</div>
<div><span class="propName ">entityStateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for EntityStateId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">number</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName ">unit</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">countryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for CountryId. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"name": "string",
"shortName": "string",
"legalName": "string",
"phone": "string",
"email": "string",
"parentGuid": "00000000-0000-0000-0000-000000000000",
"organizationTypeId": 0,
"contactUserGuid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"countryId": 0
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="magencyGuid0.8813317778404273">agencyGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="agencyGuid" placeholder="(required)" id="magencyGuid0.8813317778404273" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of Agency</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Agency with specified GUID was not found</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="magencyGuid0.8000297893694279">agencyGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="agencyGuid" placeholder="(required)" id="magencyGuid0.8000297893694279" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Agency</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.5977107230441436">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.5977107230441436"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.039136672950020435" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.039136672950020435">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Supported operations: add, replace, copy, move, remove</p>
</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">JsonPatchDocument[AgencyUpdateRequest] {</span>
<div class="readOnly"><span class="propName ">operations</span> (<span class="propType">Array[Operation[AgencyUpdateRequest]]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>)</div>
<span class="strong">}</span><br><span class="strong">Operation[AgencyUpdateRequest] {</span>
<div><span class="propName ">value</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new property value</p>
</span>,</div>
<div><span class="propName ">path</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Property name. Should start with “/”</p>
</span>,</div>
<div><span class="propName ">op</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move” and “copy”. The operations are applied in order: if any of them fail then the whole patch operation should abort.</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Using with Move operation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"value": "new value",
"path": "/Name",
"op": "replace"
},
{
"value": "new value",
"path": "/ShortName",
"op": "replace"
},
{
"value": "new value",
"path": "/LegalName",
"op": "replace"
},
{
"value": "new value",
"path": "/Description",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/ContactUserGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/EntityStateId",
"op": "replace"
},
{
"value": "new value",
"path": "/Street",
"op": "replace"
},
{
"value": "new value",
"path": "/Number",
"op": "replace"
},
{
"value": "new value",
"path": "/Unit",
"op": "replace"
},
{
"value": "new value",
"path": "/PostalCode",
"op": "replace"
},
{
"value": "new value",
"path": "/City",
"op": "replace"
},
{
"value": "new value",
"path": "/CountryId",
"op": "replace"
}
]</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>Agency has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Agency with specified GUID was not found</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="magencyGuid0.35786945909651857">agencyGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="agencyGuid" placeholder="(required)" id="magencyGuid0.35786945909651857" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of agency</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="msearch0.9357458543947308">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.9357458543947308" type="text" value="">
</td>
<td class="markdown">
<p>Search field. You can search by contact person name/email</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.5909692807069766">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.5909692807069766" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Agency Contact Person. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET . You can enter a comma separated list of values.
</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.7920062989006313">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.7920062989006313" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get contact person from last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.5132611278314667">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.5132611278314667" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get contact person to last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.5672529348899213">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.5672529348899213" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.028378862519106596">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.028378862519106596" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Agency with specified GUID was not found</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="magencyGuid0.22332704484453392">agencyGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="agencyGuid" placeholder="(required)" id="magencyGuid0.22332704484453392" 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="mrequest0.9375959976301513">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.9375959976301513"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.40503610288700376" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.40503610288700376">
<option value="application/json">application/json</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">AgencyContactPersonAddRequest {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>String for First Names., Max. length : 64</p>
</span>,</div>
<div><span class="propName ">preferredFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>String for Preferred First Name., Max. length : 64</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>String for Middle Name., Max. length : 32</p>
</span>,</div>
<div><span class="propName required">lastName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>String for Last Name., Max. length : 64</p>
</span>,</div>
<div><span class="propName ">salutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>String for Salutation., Max. length : 32</p>
</span>,</div>
<div><span class="propName ">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>String for Email., Should be a valid email : , Max. length : 128</p>
</span>,</div>
<div><span class="propName ">mobileNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>String for Mobile Number., Max. length : 32</p>
</span>,</div>
<div><span class="propName ">phone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>String for Phone Number., Max. length : 32</p>
</span>,</div>
<div><span class="propName ">genderId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for GenderId of contact person. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET .Male - 1, Female - 2, NotSpecified - 3</p>
</span>,</div>
<div><span class="propName ">agencyContactPersonGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Guid for AgencyContactPersonGuid of Bureau.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"firstName": "string",
"preferredFirstName": "string",
"middleName": "string",
"lastName": "string",
"salutation": "string",
"email": "string",
"mobileNumber": "string",
"phone": "string",
"genderId": 0,
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000"
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Agency with specified GUID was not found</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="magencyGuid0.4566223322893175">agencyGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="agencyGuid" placeholder="(required)" id="magencyGuid0.4566223322893175" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of agency</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mcontactPersonGuid0.3882084262470964">contactPersonGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="contactPersonGuid" placeholder="(required)" id="mcontactPersonGuid0.3882084262470964" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of agency contact person</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Agency or Contact person with specified GUID was not found</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="magencyGuid0.6743965577536959">agencyGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="agencyGuid" placeholder="(required)" id="magencyGuid0.6743965577536959" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Agency</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mcontactPersonGuid0.871739536233743">contactPersonGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="contactPersonGuid" placeholder="(required)" id="mcontactPersonGuid0.871739536233743" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Contact Person</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.1084049346283471">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.1084049346283471"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.33748460244761036" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.33748460244761036">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Supported operations: add, replace, copy, move, remove</p>
</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">JsonPatchDocument[AgencyContactPersonUpdateRequest] {</span>
<div class="readOnly"><span class="propName ">operations</span> (<span class="propType">Array[Operation[AgencyContactPersonUpdateRequest]]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read
only</span>)</div><span class="strong">}</span><br><span class="strong">Operation[AgencyContactPersonUpdateRequest] {</span>
<div><span class="propName ">value</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new property value</p>
</span>,</div>
<div><span class="propName ">path</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Property name. Should start with “/”</p>
</span>,</div>
<div><span class="propName ">op</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move” and “copy”. The operations are applied in order: if any of them fail then the whole patch operation should abort.</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Using with Move operation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"value": "new value",
"path": "/FirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/PreferredFirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/MiddleName",
"op": "replace"
},
{
"value": "new value",
"path": "/PrefixSurname",
"op": "replace"
},
{
"value": "new value",
"path": "/LastName",
"op": "replace"
},
{
"value": "new value",
"path": "/Surname",
"op": "replace"
},
{
"value": "new value",
"path": "/Salutation",
"op": "replace"
},
{
"value": "new value",
"path": "/GenderId",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/Mobile",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/AgencyContactPersonGuid",
"op": "replace"
}
]</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>Contact persons for agency has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Agency or contact person with specified GUID was not found</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"><label for="mwhatSearch0.1882006177491946">whatSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whatSearch" placeholder="" id="mwhatSearch0.1882006177491946" type="text" value="">
</td>
<td class="markdown">
<p>Job title or applicant name or applicant email or source. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mjobGuids0.5541292107527642">jobGuids</label></td>
<td>
<textarea class="body-textarea" name="jobGuids" id="mjobGuids0.5541292107527642" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Jobs of Application. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="magencyGuids0.7255720466830133">agencyGuids</label></td>
<td>
<textarea class="body-textarea" name="agencyGuids" id="magencyGuids0.7255720466830133" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Agencies of Job. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="memployerGuids0.814105159399241">employerGuids</label></td>
<td>
<textarea class="body-textarea" name="employerGuids" id="memployerGuids0.814105159399241" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Employers of Job. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcandidateGuids0.7566975786226338">candidateGuids</label></td>
<td>
<textarea class="body-textarea" name="candidateGuids" id="mcandidateGuids0.7566975786226338" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Candidates of Application. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.609848369919676">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.609848369919676" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Application. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateFrom0.2005761998139659">lastUpdateFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateFrom" placeholder="" id="mlastUpdateFrom0.2005761998139659" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get application from last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateTo0.005930473120475677">lastUpdateTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateTo" placeholder="" id="mlastUpdateTo0.005930473120475677" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get application to last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.33410794986044756">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.33410794986044756" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.33179157222313593">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.33179157222313593" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mrequest0.5685011505965631">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.5685011505965631"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.896275787085365" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.896275787085365">
<option value="application/json">application/json</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">ApplicationAddRequest {</span>
<div><span class="propName required">jobGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>GUID of active public job</p>
</span>,</div>
<div><span class="propName required">firstName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 128</p>
</span>,</div>
<div><span class="propName ">prefix</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName required">lastName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 128</p>
</span>,</div>
<div><span class="propName required">email</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Should be a valid email : , Max. length : 128</p>
</span>,</div>
<div><span class="propName ">phone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Phone format: +XX-XXX-XXX-XXXX, Max. length : 32</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 128</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 20000</p>
</span>,</div>
<div><span class="propName ">genderId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for GenderId of Applicant. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET . You can enter a value: Male - 1, Female - 2,
NotSpecified - 3</p>
</span>,</div>
<div><span class="propName ">birthDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Min. value : 13 years</p>
</span>,</div>
<div><span class="propName ">acceptPrivacyStatement</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">allowUseDataForOtherJobs</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">sourceJobBoardInstanceGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The domain of the referrer site that linked to the job page, Max. length : 100</p>
</span>,</div>
<div><span class="propName ">documents</span> (<span class="propType">Array[ApplicationAddRequestDocument]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">ApplicationAddRequestDocument {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName required">extension</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 8</p>
</span>,</div>
<div><span class="propName required">base64Data</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">bytesData</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>{
"jobGuid": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"prefix": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"skype": "string",
"message": "string",
"genderId": 0,
"birthDate": "2024-06-13T09:50:13.302Z",
"acceptPrivacyStatement": true,
"allowUseDataForOtherJobs": true,
"sourceJobBoardInstanceGuid": "00000000-0000-0000-0000-000000000000",
"source": "string",
"documents": [
{
"name": "string",
"extension": "string",
"base64Data": "string",
"bytesData": "string"
}
]
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mapplicationGuid0.16923440649654298">applicationGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="applicationGuid" placeholder="(required)" id="mapplicationGuid0.16923440649654298" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Application</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Application with specified GUID was not found</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="mapplicationGuid0.29320825189083854">applicationGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="applicationGuid" placeholder="(required)" id="mapplicationGuid0.29320825189083854" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Application</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.08434343241413145">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.08434343241413145"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7692419821658487" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7692419821658487">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Integer collection for State of Application. For getting available number you can find appropriate type at api / domainTypes GET and use it to find values at api / domainValues GET.You can enter a comma separated list of values.</p>
</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">JsonPatchDocument[ApplicationUpdateRequest] {</span>
<div class="readOnly"><span class="propName ">operations</span> (<span class="propType">Array[Operation[ApplicationUpdateRequest]]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>)
</div><span class="strong">}</span><br><span class="strong">Operation[ApplicationUpdateRequest] {</span>
<div><span class="propName ">value</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new property value</p>
</span>,</div>
<div><span class="propName ">path</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Property name. Should start with “/”</p>
</span>,</div>
<div><span class="propName ">op</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move” and “copy”. The operations are applied in order: if any of them fail then the whole patch operation should abort.</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Using with Move operation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"value": "new value",
"path": "/EntityStateId",
"op": "replace"
}
]</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>Application has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Application with specified GUID was not found</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="mcandidateGuid0.9093042910044211">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.9093042910044211" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="maddressTypeId0.18987857007499764">addressTypeId</label></td>
<td>
<input class="parameter required" minlength="1" name="addressTypeId" placeholder="(required)" id="maddressTypeId0.18987857007499764" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Address type of Candidate. For getting available number you should GET api/candidates/{candidateGuid}/addresses/</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</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>Candidate address has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID or address type was not found</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="mcandidateGuid0.6791996146250063">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.6791996146250063" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="maddressTypeId0.7900238298780033">addressTypeId</label></td>
<td>
<input class="parameter required" minlength="1" name="addressTypeId" placeholder="(required)" id="maddressTypeId0.7900238298780033" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Address type of Candidate. For getting available number you should GET api/candidates/{candidateGuid}/addresses/</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID or address type was not found</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="mcandidateGuid0.6617927454354775">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.6617927454354775" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="maddressTypeId0.38324076225762327">addressTypeId</label></td>
<td>
<input class="parameter required" minlength="1" name="addressTypeId" placeholder="(required)" id="maddressTypeId0.38324076225762327" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Address type of Candidate. You can find possible values at GET api/domainTypes/947/domainValues</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.9267197068605562">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.9267197068605562"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.587015232351144" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.587015232351144">
<option value="application/json">application/json</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">UserAddressAddRequest {</span>
<div><span class="propName required">street</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName required">number</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName ">unit</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName required">postalCode</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName required">city</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName required">countryId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Integer for CountryId. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"countryId": 0
}</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">200</td>
<td class="markdown">
<p>Created succesfully</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
<tr>
<td>Location</td>
<td>Url to created or updated entity</td>
<td></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID was not found</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="mcandidateGuid0.3363894700005694">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.3363894700005694" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="maddressTypeId0.8709886343688822">addressTypeId</label></td>
<td>
<input class="parameter required" minlength="1" name="addressTypeId" placeholder="(required)" id="maddressTypeId0.8709886343688822" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Address type of Candidate. For getting available number you should GET api/candidates/{candidateGuid}/addresses/</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.7931839705529051">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.7931839705529051"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4344283152924884" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4344283152924884">
<option value="application/json">application/json</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">UserAddressUpdateRequest {</span>
<div><span class="propName required">street</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName required">number</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName ">unit</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName required">postalCode</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName required">city</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName required">countryId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Integer for CountryId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"countryId": 0
}</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>Candidate address has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID or address type was not found</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="mcandidateGuid0.8561278252939293">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.8561278252939293" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of candidate</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mskip0.3194927641242371">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.3194927641242371" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.5725112500298233">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.5725112500298233" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID was not found</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="mcandidateGuid0.5329775899468041">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.5329775899468041" 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="mrequest0.9074928919058409">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.9074928919058409"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.21089346684914356" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.21089346684914356">
<option value="application/json">application/json</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">PensionSchemeAddRequest {</span>
<div><span class="propName required">agencyGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Should be Agency with an active model matrix available</p>
</span>,</div>
<div><span class="propName required">year</span> (<span class="propType">integer</span>),</div>
<div><span class="propName required">week</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Min. value : 1, Max. value : 53</p>
</span>,</div>
<div><span class="propName required">pensionSchemeId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Pension scheme Id (Pension step Id). For getting available ids see at /docs/index#!/DomainValues/DomainValues_Get_0, with domainValueTypeId = 919 and isActive = true</p>
</span>,</div>
<div><span class="propName ">numberOfWeeksWorked</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Min. value : 0, Max. value : 999999999</p>
</span>,</div>
<div><span class="propName ">numberOfWeeksBreak</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Min. value : 0, Max. value : 999999999</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"year": 0,
"week": 0,
"pensionSchemeId": 0,
"numberOfWeeksWorked": 0,
"numberOfWeeksBreak": 0
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID was not found</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="mcandidateGuid0.9013062195272019">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.9013062195272019" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mguid0.08475165781852079">guid</label></td>
<td>
<input class="parameter required" minlength="1" name="guid" placeholder="(required)" id="mguid0.08475165781852079" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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>Candidate pension scheme has been successfully deleted</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>Pension scheme year less than current processing year</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate or pension scheme with specified GUID was not found</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="mcandidateGuid0.2924948278764061">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.2924948278764061" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mguid0.7997385638559775">guid</label></td>
<td>
<input class="parameter required" minlength="1" name="guid" placeholder="(required)" id="mguid0.7997385638559775" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.28257025752925924">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.28257025752925924"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.00474117089803916" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.00474117089803916">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Supported operations: add, replace, copy, move, remove</p>
</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">JsonPatchDocument[PensionSchemeUpdateRequest] {</span>
<div class="readOnly"><span class="propName ">operations</span> (<span class="propType">Array[Operation[PensionSchemeUpdateRequest]]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>)
</div><span class="strong">}</span><br><span class="strong">Operation[PensionSchemeUpdateRequest] {</span>
<div><span class="propName ">value</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new property value</p>
</span>,</div>
<div><span class="propName ">path</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Property name. Should start with “/”</p>
</span>,</div>
<div><span class="propName ">op</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move” and “copy”. The operations are applied in order: if any of them fail then the whole patch operation should abort.</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Using with Move operation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"value": "new value",
"path": "/AgencyGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/Year",
"op": "replace"
},
{
"value": "new value",
"path": "/Week",
"op": "replace"
},
{
"value": "new value",
"path": "/PensionSchemeId",
"op": "replace"
},
{
"value": "new value",
"path": "/NumberOfWeeksWorked",
"op": "replace"
},
{
"value": "new value",
"path": "/NumberOfWeeksBreak",
"op": "replace"
}
]</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>Pension scheme of candidate has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate or pension scheme with specified GUID was not found</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="mcandidateGuid0.04105465382025808">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.04105465382025808" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of candidate</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mskip0.6238445169721369">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.6238445169721369" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.8173354093139347">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.8173354093139347" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mcandidateGuid0.9087681047275233">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.9087681047275233" 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="mrequest0.8773670591170233">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8773670591170233"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.645801116424312" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.645801116424312">
<option value="application/json">application/json</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">BankAccountAddRequest {</span>
<div><span class="propName required">bankAccountNumber</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 35, Should be a valid IBAN : </p>
</span>,</div>
<div><span class="propName required">accountHolderName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 50</p>
</span>,</div>
<div><span class="propName required">accountHolderCity</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 50</p>
</span>,</div>
<div><span class="propName ">biccode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>If BankAccountNumber is not NL — Biccode field is required, Max. length : 35, Should be a BIC code : </p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"bankAccountNumber": "string",
"accountHolderName": "string",
"accountHolderCity": "string",
"biccode": "string"
}</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">200</td>
<td class="markdown">
<p>Created succesfully</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
<tr>
<td>Location</td>
<td>Url to created or updated entity</td>
<td></td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID was not found</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="mcandidateGuid0.21409295415686147">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.21409295415686147" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of candidate</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mbankAccountNumber0.12299936099532638">bankAccountNumber</label></td>
<td>
<input class="parameter required" minlength="1" name="bankAccountNumber" placeholder="(required)" id="mbankAccountNumber0.12299936099532638" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Bank account number of candidate, Max. length : 35, Should be a valid IBAN : </p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID or bank account number was not found</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="mcandidateGuid0.4647173008782879">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.4647173008782879" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mbankAccountNumber0.7884377053338099">bankAccountNumber</label></td>
<td>
<input class="parameter required" minlength="1" name="bankAccountNumber" placeholder="(required)" id="mbankAccountNumber0.7884377053338099" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Bank account number of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.34668780698266977">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.34668780698266977"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7909960895143555" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7909960895143555">
<option value="application/json">application/json</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">BankAccountUpdateRequest {</span>
<div><span class="propName required">accountHolderName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 50</p>
</span>,</div>
<div><span class="propName required">accountHolderCity</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 50</p>
</span>,</div>
<div><span class="propName ">biccode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>If BankAccountNumber is not NL — Biccode field is required, Max. length : 35, Should be a BIC code : </p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"accountHolderName": "string",
"accountHolderCity": "string",
"biccode": "string"
}</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>Candidate bank account has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID or bank account number was not found</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"><label for="mentityStateIds0.5868635407279188">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.5868635407279188" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="magencyGuids0.3461904152888995">agencyGuids</label></td>
<td>
<textarea class="body-textarea" name="agencyGuids" id="magencyGuids0.3461904152888995" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Agencies of Candidate. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.6135335741037888">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.6135335741037888" type="text" value="">
</td>
<td class="markdown">
<p>String value for search by candidate name and email., Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.8296401310903978">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.8296401310903978" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get candidates from last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.7396414036338592">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.7396414036338592" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get candidates to last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtagIds0.23792267923534927">tagIds</label></td>
<td>
<textarea class="body-textarea" name="tagIds" id="mtagIds0.23792267923534927" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for TagIds of Candidate. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.3559438633287544">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.3559438633287544" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.7922399276666061">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.7922399276666061" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mrequest0.9666049778332346">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.9666049778332346"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1136365195865312" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1136365195865312">
<option value="application/json">application/json</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">CandidateAddRequest {</span>
<div><span class="propName ">guid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Guid of new candidate</p>
</span>,</div>
<div><span class="propName required">agencyGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>You can input just active agencies</p>
</span>,</div>
<div><span class="propName ">typeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for TypeId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span>,</div>
<div><span class="propName ">contactPersonGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">statusId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for status of Candidate. You can enter a value: To be activated - 1, Activating - 2, Registering - 3 DEPRECATED. Registering status is not used anymore.</p>
</span>,</div>
<div><span class="propName required">firstName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName ">preferredFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName required">lastName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">birthName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName ">initials</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">salutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">nationalityId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for NationalityId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span>,</div>
<div><span class="propName ">genderId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for GenderId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET . You can enter a value: Male - 1, Female - 2,
NotSpecified - 3</p>
</span>,</div>
<div><span class="propName ">birthDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">maritalStateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for MaritalStateId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span>,</div>
<div><span class="propName required">email</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Should be a valid email : , Max. length : 128</p>
</span>,</div>
<div><span class="propName ">phone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">skype</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 128</p>
</span>,</div>
<div><span class="propName ">bankAccountNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>DEPRECATED. You have to use 'api/candidates/{candidateGuid}/bankaccounts' instead, Should be a valid IBAN : , Max. length : 64</p>
</span>,</div>
<div><span class="propName ">bankAccountName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>DEPRECATED. You have to use 'api/candidates/{candidateGuid}/bankaccounts' instead, Max. length : 64</p>
</span>,</div>
<div><span class="propName ">documentTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for DocumentTypeId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span>,</div>
<div><span class="propName ">documentNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">documentEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">documentIssuingCountryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for CountryId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span>,</div>
<div><span class="propName ">ssn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">taxReduction</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Boolean for TaxReduction of Candidate. You can enter a value: true or false</p>
</span>,</div>
<div><span class="propName ">singleElderlyPersonsTaxCreditApplied</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Boolean for SingleElderlyPersonsTaxCreditApplied of Candidate. You can enter a value: true or false. This value cannot be true when 'TaxReduction' is not true</p>
</span>,</div>
<div><span class="propName ">taxReductionStartDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">taxReductionStatementDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">candidatePaymentFrequencyId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for PaymentFrequencyId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span>,</div>
<div><span class="propName ">countryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for CountryId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">number</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName ">unit</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName ">registrationDate</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>{
"guid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"typeId": 0,
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"statusId": 0,
"firstName": "string",
"preferredFirstName": "string",
"lastName": "string",
"middleName": "string",
"birthName": "string",
"initials": "string",
"title": "string",
"salutation": "string",
"nationalityId": 0,
"genderId": 0,
"birthDate": "2024-06-13T09:50:13.348Z",
"maritalStateId": 0,
"email": "string",
"phone": "string",
"mobile": "string",
"skype": "string",
"bankAccountNumber": "string",
"bankAccountName": "string",
"documentTypeId": 0,
"documentNumber": "string",
"documentEndDate": "2024-06-13T09:50:13.348Z",
"documentIssuingCountryId": 0,
"ssn": "string",
"taxReduction": true,
"singleElderlyPersonsTaxCreditApplied": true,
"taxReductionStartDate": "2024-06-13T09:50:13.348Z",
"taxReductionStatementDate": "2024-06-13T09:50:13.348Z",
"candidatePaymentFrequencyId": 0,
"countryId": 0,
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"registrationDate": "2024-06-13T09:50:13.348Z"
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mcandidateGuid0.3170008415997094">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.3170008415997094" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID was not found</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="mcandidateGuid0.6554602274422763">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.6554602274422763" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Candidate</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.6869574697788816">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.6869574697788816"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7259586989765612" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7259586989765612">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Supported operations: add, replace, copy, move, remove</p>
</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">JsonPatchDocument[CandidateUpdateRequest] {</span>
<div class="readOnly"><span class="propName ">operations</span> (<span class="propType">Array[Operation[CandidateUpdateRequest]]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>)
</div><span class="strong">}</span><br><span class="strong">Operation[CandidateUpdateRequest] {</span>
<div><span class="propName ">value</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new property value</p>
</span>,</div>
<div><span class="propName ">path</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Property name. Should start with “/”</p>
</span>,</div>
<div><span class="propName ">op</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move” and “copy”. The operations are applied in order: if any of them fail then the whole patch operation should abort.</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Using with Move operation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"value": "new value",
"path": "/TypeId",
"op": "replace"
},
{
"value": "new value",
"path": "/FirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/PreferredFirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/LastName",
"op": "replace"
},
{
"value": "new value",
"path": "/MiddleName",
"op": "replace"
},
{
"value": "new value",
"path": "/BirthName",
"op": "replace"
},
{
"value": "new value",
"path": "/Initials",
"op": "replace"
},
{
"value": "new value",
"path": "/Title",
"op": "replace"
},
{
"value": "new value",
"path": "/Salutation",
"op": "replace"
},
{
"value": "new value",
"path": "/NationalityId",
"op": "replace"
},
{
"value": "new value",
"path": "/GenderId",
"op": "replace"
},
{
"value": "new value",
"path": "/BirthDate",
"op": "replace"
},
{
"value": "new value",
"path": "/MaritalStateId",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/Mobile",
"op": "replace"
},
{
"value": "new value",
"path": "/Skype",
"op": "replace"
},
{
"value": "new value",
"path": "/BankAccountNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/BankAccountName",
"op": "replace"
},
{
"value": "new value",
"path": "/DocumentTypeId",
"op": "replace"
},
{
"value": "new value",
"path": "/DocumentNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/DocumentEndDate",
"op": "replace"
},
{
"value": "new value",
"path": "/DocumentIssuingCountryId",
"op": "replace"
},
{
"value": "new value",
"path": "/Ssn",
"op": "replace"
},
{
"value": "new value",
"path": "/TaxReduction",
"op": "replace"
},
{
"value": "new value",
"path": "/SingleElderlyPersonsTaxCreditApplied",
"op": "replace"
},
{
"value": "new value",
"path": "/TaxReductionStartDate",
"op": "replace"
},
{
"value": "new value",
"path": "/TaxReductionStatementDate",
"op": "replace"
},
{
"value": "new value",
"path": "/CandidatePaymentFrequencyId",
"op": "replace"
},
{
"value": "new value",
"path": "/CountryId",
"op": "replace"
},
{
"value": "new value",
"path": "/City",
"op": "replace"
},
{
"value": "new value",
"path": "/Street",
"op": "replace"
},
{
"value": "new value",
"path": "/Number",
"op": "replace"
},
{
"value": "new value",
"path": "/Unit",
"op": "replace"
},
{
"value": "new value",
"path": "/PostalCode",
"op": "replace"
},
{
"value": "new value",
"path": "/ContactPersonGuid",
"op": "replace"
}
]</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>Candidate has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Candidate with specified GUID was not found</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="mcandidateGuid0.2597856109748211">candidateGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="candidateGuid" placeholder="(required)" id="mcandidateGuid0.2597856109748211" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of candidate</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mskip0.9855210407697665">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.9855210407697665" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.0690099096239829">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.0690099096239829" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mid0.6436526821413011">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.6436526821413011" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAOInstance</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="misNewsIncluded0.8654466029887191">isNewsIncluded</label></td>
<td>
<select class="parameter " name="isNewsIncluded" id="misNewsIncluded0.8654466029887191">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines to include news to CAOInstance detail response. The default is false.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="misWageChangesIncluded0.3613406832953272">isWageChangesIncluded</label></td>
<td>
<select class="parameter " name="isWageChangesIncluded" id="misWageChangesIncluded0.3613406832953272">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines to include wage changes to CAOInstance detail response. The default is false.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>CAOInstance was not found</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"><label for="mcaoFirstLetter0.010351541987817514">caoFirstLetter</label></td>
<td>
<input class="parameter" minlength="0" name="caoFirstLetter" placeholder="" id="mcaoFirstLetter0.010351541987817514" type="text" value="">
</td>
<td class="markdown">
<p>First leter of CAO name. You can enter a single char.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msbiCode0.7971101284108495">sbiCode</label></td>
<td>
<input class="parameter" minlength="0" name="sbiCode" placeholder="" id="msbiCode0.7971101284108495" type="text" value="">
</td>
<td class="markdown">
<p>SBI Code of CAO. You can enter string value.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="misActualOnly0.08093152849553253">isActualOnly</label></td>
<td>
<select class="parameter " name="isActualOnly" id="misActualOnly0.08093152849553253">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines only actual CAOInstances. The default is false.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mid0.4191603555133767">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.4191603555133767" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAONews</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>CAONews was not found</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"><label for="mskip0.6480255124086225">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.6480255124086225" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.7114429591931655">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.7114429591931655" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page, Min. value : 1</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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"><label for="myear0.578094887801373">year</label></td>
<td>
<input class="parameter" minlength="0" name="year" placeholder="" id="myear0.578094887801373" type="text" value="">
</td>
<td class="markdown">
<p>Year of effective date of CAOWages. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mmonthNumber0.15895098163511534">monthNumber</label></td>
<td>
<input class="parameter" minlength="0" name="monthNumber" placeholder="" id="mmonthNumber0.15895098163511534" type="text" value="">
</td>
<td class="markdown">
<p>Month number of effective date of CAOWages. You can enter single integer value. , Min. value : 0, Max. value : 11</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.7189595379569313">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.7189595379569313" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.7170225506959218">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.7170225506959218" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page, Min. value : 1</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mcontractGuid0.14524380989833552">contractGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="contractGuid" placeholder="(required)" id="mcontractGuid0.14524380989833552" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Contract</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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>Deleted successfully</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Contract with specified GUID was not found</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="mcontractGuid0.9041846696962592">contractGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="contractGuid" placeholder="(required)" id="mcontractGuid0.9041846696962592" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Contract</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Contract with specified GUID was not found</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="mcontractGuid0.8242878517361774">contractGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="contractGuid" placeholder="(required)" id="mcontractGuid0.8242878517361774" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Contract</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.20639819576451512">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.20639819576451512"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.0051124525097152596" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.0051124525097152596">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Supported operations: add, replace, copy, move, remove</p>
</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">JsonPatchDocument[ContractUpdateRequest] {</span>
<div class="readOnly"><span class="propName ">operations</span> (<span class="propType">Array[Operation[ContractUpdateRequest]]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>)</div>
<span class="strong">}</span><br><span class="strong">Operation[ContractUpdateRequest] {</span>
<div><span class="propName ">value</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new property value</p>
</span>,</div>
<div><span class="propName ">path</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Property name. Should start with “/”</p>
</span>,</div>
<div><span class="propName ">op</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move” and “copy”. The operations are applied in order: if any of them fail then the whole patch operation should abort.</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Using with Move operation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"value": "new value",
"path": "/BureauOrganizationGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/BureauContactPersonGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/EmployerContactPersonGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/StartDate",
"op": "replace"
},
{
"value": "new value",
"path": "/EndDate",
"op": "replace"
},
{
"value": "new value",
"path": "/CaoId",
"op": "replace"
},
{
"value": "new value",
"path": "/CaoFunctionId",
"op": "replace"
},
{
"value": "new value",
"path": "/CaoFunctionGroupId",
"op": "replace"
},
{
"value": "new value",
"path": "/JobTitle",
"op": "replace"
},
{
"value": "new value",
"path": "/CostCenterGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/PurchaseOrderNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/TargetHours",
"op": "replace"
},
{
"value": "new value",
"path": "/PayAmountRegularHours",
"op": "replace"
},
{
"value": "new value",
"path": "/BillAmountRegularHours",
"op": "replace"
},
{
"value": "new value",
"path": "/WorkAddress",
"op": "replace"
}
]</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>Updated successfully</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Contract with specified GUID was not found</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"><label for="mentityStateIds0.10730139549992623">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.10730139549992623" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Contract.You can enter a comma separated list of values. ToBeSignedAgency - 110, RejectedAgency - 111, ToBeSignedEmployer - 112, RejectedEmployer - 113, ToBeSignedCandidate - 114, RejectedCandidate - 115,
Active - 167, Signed - 116, Ended - 118, Historical - 119, Deleted - 117, Created - 220, Draft - 232, ToBeSigned - 264, ToBeSent - 380</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcontractTypeIds0.8773175732538536">contractTypeIds</label></td>
<td>
<textarea class="body-textarea" name="contractTypeIds" id="mcontractTypeIds0.8773175732538536" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Type of Contract. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcandidateGuids0.31913858428242836">candidateGuids</label></td>
<td>
<textarea class="body-textarea" name="candidateGuids" id="mcandidateGuids0.31913858428242836" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection of Candidates. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="memployerGuids0.6674759318653103">employerGuids</label></td>
<td>
<textarea class="body-textarea" name="employerGuids" id="memployerGuids0.6674759318653103" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection of Employers. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="magencyGuids0.4060737563258321">agencyGuids</label></td>
<td>
<textarea class="body-textarea" name="agencyGuids" id="magencyGuids0.4060737563258321" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection of Agencies. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.6364454059332201">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.6364454059332201" type="text" value="">
</td>
<td class="markdown">
<p>String value for search by JobTitle., Max. length : 256</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.48244260773638215">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.48244260773638215" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get contracts from last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.32192911752774456">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.32192911752774456" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get contracts to last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mstartDateUtcFrom0.9600416437297583">startDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="startDateUtcFrom" placeholder="" id="mstartDateUtcFrom0.9600416437297583" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get contracts from start date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mstartDateUtcTo0.2468385998313556">startDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="startDateUtcTo" placeholder="" id="mstartDateUtcTo0.2468385998313556" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get contracts to start date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mendDateUtcFrom0.043768443893986486">endDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="endDateUtcFrom" placeholder="" id="mendDateUtcFrom0.043768443893986486" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get contracts from end date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mendDateUtcTo0.5120832625735727">endDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="endDateUtcTo" placeholder="" id="mendDateUtcTo0.5120832625735727" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get contracts to end date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mincludeArchived0.8221139604378098">includeArchived</label></td>
<td>
<select class="parameter " name="includeArchived" id="mincludeArchived0.8221139604378098">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines archived Contract. The default is false.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mincludeAllVersions0.6633187652008974">includeAllVersions</label></td>
<td>
<select class="parameter " name="includeAllVersions" id="mincludeAllVersions0.6633187652008974">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines all version of Contract. The default is false.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mskip0.8363036075180523">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.8363036075180523" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.06398411652248392">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.06398411652248392" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mrequest0.6310392997782581">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.6310392997782581"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5959131074575983" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5959131074575983">
<option value="application/json">application/json</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">ContractAddRequest {</span>
<div><span class="propName required">employerGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>GUID of employer in draft or active status</p>
</span>,</div>
<div><span class="propName ">employerContactPersonGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>GUID of Employer Contact Person</p>
</span>,</div>
<div><span class="propName required">bureauOrganizationGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Bureau GUID</p>
</span>,</div>
<div><span class="propName ">bureauContactPersonGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Bureau User GUID. Active and Draft entity states allowed</p>
</span>,</div>
<div><span class="propName required">candidateGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>GUID of candidate who has active, draft, passive, registering, registered, approved or applicant status</p>
</span>,</div>
<div><span class="propName required">startDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Contract start date</p>
</span>,</div>
<div><span class="propName ">endDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Contract end date</p>
</span>,</div>
<div><span class="propName required">contractTypeId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Contract Type id. For getting available ids see at /docs/index#!/DomainValues/DomainValues_Get_0, with domainValueTypeId = 438 and isActive = true and hrXmlCode = 'P'</p>
</span>,</div>
<div><span class="propName ">caoId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Contract CAO id. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCaos</p>
</span>,</div>
<div><span class="propName ">caoFunctionId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Contract CAO function id. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCaoFunctions</p>
</span>,</div>
<div><span class="propName ">caoFunctionGroupId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Contract CAO function group id. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCaoFunctionGroups</p>
</span>,</div>
<div><span class="propName required">jobTitle</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Contract job title, Max. length : 256</p>
</span>,</div>
<div><span class="propName ">costCenterGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>GUID of employer cost center. For getting available number see at /docs/index#!/Employers/{employerGuid}/CostCenters</p>
</span>,</div>
<div><span class="propName ">purchaseOrderNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Contract purchase order number, Max. length : 128</p>
</span>,</div>
<div><span class="propName ">targetHours</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Contract target hours per week, Min. value : 0, Max. value : 168</p>
</span>,</div>
<div><span class="propName ">payAmountRegularHours</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Contract regular hours rate class Pay value, Min. value : 0, Max. accuracy : 2 decimals</p>
</span>,</div>
<div><span class="propName ">billAmountRegularHours</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Contract regular hours rate class Bill value, Min. value : 0, Max. accuracy : 2 decimals</p>
</span>,</div>
<div><span class="propName ">workAddress</span> (<span class="propType">WorkAddressRequest</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Work address</p>
</span></div><span class="strong">}</span><br><span class="strong">WorkAddressRequest {</span>
<div><span class="propName ">countryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for CountryId of Candidate. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET </p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Work address city, Max. length : 256</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Work address street, Max. length : 256</p>
</span>,</div>
<div><span class="propName ">number</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Work address number, Max. length : 16</p>
</span>,</div>
<div><span class="propName ">unit</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Work address unit, Max. length : 32</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Work address post code, Max. length : 16</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"bureauOrganizationGuid": "00000000-0000-0000-0000-000000000000",
"bureauContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"startDate": "2024-06-13T09:50:13.402Z",
"endDate": "2024-06-13T09:50:13.402Z",
"contractTypeId": 0,
"caoId": 0,
"caoFunctionId": 0,
"caoFunctionGroupId": 0,
"jobTitle": "string",
"costCenterGuid": "00000000-0000-0000-0000-000000000000",
"purchaseOrderNumber": "string",
"targetHours": 0,
"payAmountRegularHours": 0,
"billAmountRegularHours": 0,
"workAddress": {
"countryId": 0,
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string"
}
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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"><label for="msearch0.7950995363175619">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.7950995363175619" type="text" value="">
</td>
<td class="markdown">
<p>String value for search by document name, number, subject, contract number(version)., Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityTypeIds0.0032648014284402116">entityTypeIds</label></td>
<td>
<textarea class="body-textarea" name="entityTypeIds" id="mentityTypeIds0.0032648014284402116" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for EntityType of Document. You can enter a comma separated list of values. Employer - 18, Candidate - 95. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.4020393644877669">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.4020393644877669" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Document. You can enter a comma separated list of values. ToBeApproved - 120, Approved - 121, Rejected - 122, Deleted - 123, ApprovedByAgency - 135, RejectedByAgency - 136, Published - 178, ToBePublished -
14, ToBeSent - 381, Historical - 382</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mdocumentTypeIds0.17127758019452788">documentTypeIds</label></td>
<td>
<textarea class="body-textarea" name="documentTypeIds" id="mdocumentTypeIds0.17127758019452788" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Type of Document. For getting available id you can find values at api/domainTypes/859/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mownerGuids0.3425906956092999">ownerGuids</label></td>
<td>
<textarea class="body-textarea" name="ownerGuids" id="mownerGuids0.3425906956092999" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Employers or Candidates of Document.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.563323167966133">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.563323167966133" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.6085236989030776">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.6085236989030776" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mrequest0.6091747837163835">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.6091747837163835"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09121507678236473" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09121507678236473">
<option value="application/json">application/json</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">DocumentAddRequest {</span>
<div><span class="propName required">ownerOrganizationGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Employer or Candidate GUID</p>
</span>,</div>
<div><span class="propName required">entityStateId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Inital status for document. 14 - ToBePublished, 178 - Published, 120 - ToBeApproved/Signed</p>
</span>,</div>
<div><span class="propName ">categoryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Category for signing process. Required if EntityStateId is 120. Possible values: 1, 2, 3</p>
</span>,</div>
<div><span class="propName required">documentName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Document name, Max. length : 256</p>
</span>,</div>
<div><span class="propName required">documentTypeId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Type of document. For getting available id see at /docs/index#!/Documents/Settings</p>
</span>,</div>
<div><span class="propName ">documentSubTypeId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Document attribute - DomainSubTypeId. Required only for specific DocumentTypeId. For mode details see at /docs/index#!/Documents/Settings/{documentTypeId}</p>
</span>,</div>
<div><span class="propName ">documentNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Document attribute - Number, Max. length : 128</p>
</span>,</div>
<div><span class="propName ">documentStartDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Document attribute - DateFrom</p>
</span>,</div>
<div><span class="propName ">documentEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Document attribute - DateTo</p>
</span>,</div>
<div><span class="propName ">documentIssuingCountryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Document attribute - Country</p>
</span>,</div>
<div><span class="propName ">documentIssuingCountryCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Document attribute - CountryCode, Max. length : 2</p>
</span>,</div>
<div><span class="propName required">documents</span> (<span class="propType">Array[DocumentFile]</span>): <span class="propDesc markdown">
<p>Single document or collection with 5 documents that will be merged into one pdf file</p>
</span></div><span class="strong">}</span><br><span class="strong">DocumentFile {</span>
<div><span class="propName required">fileName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>File name with extension, Max. length : 256</p>
</span>,</div>
<div><span class="propName required">base64Data</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>File. Base 64 encoded file</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"ownerOrganizationGuid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"categoryId": 0,
"documentName": "string",
"documentTypeId": 0,
"documentSubTypeId": 0,
"documentNumber": "string",
"documentStartDate": "2024-06-13T09:50:13.409Z",
"documentEndDate": "2024-06-13T09:50:13.409Z",
"documentIssuingCountryId": 0,
"documentIssuingCountryCode": "string",
"documents": [
{
"fileName": "string",
"base64Data": "string"
}
]
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mdocumentGuid0.4237780406284388">documentGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="documentGuid" placeholder="(required)" id="mdocumentGuid0.4237780406284388" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Document with specified GUID was not found</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>
<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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mdocumentTypeId0.2349642516146182">documentTypeId</label></td>
<td>
<input class="parameter required" minlength="1" name="documentTypeId" placeholder="(required)" id="mdocumentTypeId0.2349642516146182" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of document type from domain value</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Settings with specified documentTypeId was not accessible for current customer</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Settings with specified documentTypeId was not found</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"><label for="mskip0.0829473709720947">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.0829473709720947" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.10964279211504202">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.10964279211504202" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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>
<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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mdomainValueTypeId0.9568060755276688">domainValueTypeId</label></td>
<td>
<input class="parameter required" minlength="1" name="domainValueTypeId" placeholder="(required)" id="mdomainValueTypeId0.9568060755276688" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Domain value type id. Please see Domain Type API for the list of ids</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="misActive0.8698996873310345">isActive</label></td>
<td>
<select class="parameter " name="isActive" id="misActive0.8698996873310345">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value for search by IsActive property of domain value</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mhrXmlCode0.39795186192957277">hrXmlCode</label></td>
<td>
<input class="parameter" minlength="0" name="hrXmlCode" placeholder="" id="mhrXmlCode0.39795186192957277" type="text" value="">
</td>
<td class="markdown">
<p>String value for search by HrXmlCode property of domain value, Max. length : 256</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.9425260687237229">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.9425260687237229" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.6101560019888459">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.6101560019888459" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="memployerGuid0.050754541859289404">employerGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="employerGuid" placeholder="(required)" id="memployerGuid0.050754541859289404" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="msearch0.9837871188298899">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.9837871188298899" type="text" value="">
</td>
<td class="markdown">
<p>Search filed. You can search by contact person name/email</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.19535349250567302">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.19535349250567302" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Employer Contact Person. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values.
</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.019889372376069803">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.019889372376069803" type="text" value="">
</td>
<td class="markdown">
<p>DateTime UTC value. Get user from last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.03646766377152644">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.03646766377152644" type="text" value="">
</td>
<td class="markdown">
<p>DateTime UTC value. Get user to last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.12631239439450814">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.12631239439450814" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.23850099399250912">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.23850099399250912" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Employer with specified GUID was not found</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="memployerGuid0.6486419019047676">employerGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="employerGuid" placeholder="(required)" id="memployerGuid0.6486419019047676" 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="mrequest0.9947090400271823">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.9947090400271823"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.821020157008751" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.821020157008751">
<option value="application/json">application/json</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">EmployerContactPersonAddRequest {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName ">preferredFirstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName required">lastName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName ">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Should be a valid email : , Max. length : 128</p>
</span>,</div>
<div><span class="propName ">mobile</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">phone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">genderId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for GenderId of contact person. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET .Male - 1, Female - 2, NotSpecified - 3</p>
</span>,</div>
<div><span class="propName ">salutation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>String for Salutation., Max. length : 32</p>
</span>,</div>
<div><span class="propName ">agencyContactPersonGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Guid for AgencyContactPersonGuid of Bureau.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"firstName": "string",
"preferredFirstName": "string",
"middleName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"phone": "string",
"genderId": 0,
"salutation": "string",
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000"
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Employer with specified GUID was not found</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"><label for="mentityStateIds0.719175214369772">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.719175214369772" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Employer. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="magencyGuids0.7845381223193051">agencyGuids</label></td>
<td>
<textarea class="body-textarea" name="agencyGuids" id="magencyGuids0.7845381223193051" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for parents Agencies. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="morganizationTypeIds0.11648717167023537">organizationTypeIds</label></td>
<td>
<textarea class="body-textarea" name="organizationTypeIds" id="morganizationTypeIds0.11648717167023537" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for OrganizationTypes of Employer. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET . You can enter a comma separated list of values.
</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtagIds0.8055963034647919">tagIds</label></td>
<td>
<textarea class="body-textarea" name="tagIds" id="mtagIds0.8055963034647919" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for TagIds of Employer. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="msearch0.19290421809395397">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.19290421809395397" type="text" value="">
</td>
<td class="markdown">
<p>String value for search by employer name., Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.23412768355884994">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.23412768355884994" type="text" value="">
</td>
<td class="markdown">
<p>DateTime UTC value. Get employer organizations from last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.8496072262057313">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.8496072262057313" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get employer organizations to last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mkvkMainNumber0.7895516827275242">kvkMainNumber</label></td>
<td>
<input class="parameter" minlength="0" name="kvkMainNumber" placeholder="" id="mkvkMainNumber0.7895516827275242" type="text" value="">
</td>
<td class="markdown">
<p>String value for search by KVK number., Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.559072848863031">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.559072848863031" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.5757010243740546">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.5757010243740546" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mrequest0.8414540339758261">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8414540339758261"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8969816150908752" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8969816150908752">
<option value="application/json">application/json</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">EmployerAddRequest {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">shortName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 50</p>
</span>,</div>
<div><span class="propName ">legalName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">phone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Should be a valid email : , Max. length : 128</p>
</span>,</div>
<div><span class="propName ">totalHoursPerWeek</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Min. value : 0, Max. value : 84</p>
</span>,</div>
<div><span class="propName ">agencyGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>GUID of active agency</p>
</span>,</div>
<div><span class="propName ">parentGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>GUID of active agency or employer</p>
</span>,</div>
<div><span class="propName ">isDepartment</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Boolean value which determines if organization is Department</p>
</span>,</div>
<div><span class="propName ">kvkMainNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 8</p>
</span>,</div>
<div><span class="propName ">kvkSubNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 12</p>
</span>,</div>
<div><span class="propName ">contactUserGuid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>It is optional if setting [default contactperson] for that bureau is filled on HelloFlex settings. Otherwise, this attribute is required, and we return 'Value is invalid' error</p>
</span>,</div>
<div><span class="propName ">entityStateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for EntityStateId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">website</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256, Should be a valid url : </p>
</span>,</div>
<div><span class="propName ">debtorNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName ">debtorStatusId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for DebtorStatusId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">debtorStatusDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">debtorStatusDescription</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 512</p>
</span>,</div>
<div><span class="propName ">paymentTermsId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for PaymentTermsId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">vatNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 64</p>
</span>,</div>
<div><span class="propName ">vatConditionId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for VATConditionId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">vatRateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for VATRateId. TO BE DEPRECATED IN FUTURE. Use VATGroupRateId instead. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at
/docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">vatGroupRateId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for VATGroupRateId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">gAccountUsage</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">gAccountAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Min. value : 0,01, Max. value : 100, Max. accuracy : 2 decimals</p>
</span>,</div>
<div><span class="propName ">gAccountInclusiveTAX</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">bankAccountNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Should be a valid IBAN : , Max. length : 64</p>
</span>,</div>
<div><span class="propName ">bicCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Should be a BIC code : </p>
</span>,</div>
<div><span class="propName ">invoiceMethodId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for InvoiceMethodId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">invoiceScheduleId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for InvoiceScheduleId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">invoiceEmail</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Should be a valid email : , Max. length : 128</p>
</span>,</div>
<div><span class="propName ">invoiceEmailSecondary</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Should be a valid email : , Max. length : 128</p>
</span>,</div>
<div><span class="propName ">creditStatusId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for CreditStatusId. For getting available number you can find appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use it to find values at /docs/index#!/DomainValues/DomainValues_Get_0</p>
</span>,</div>
<div><span class="propName ">creditStatusDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">creditStatusDescription</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 512</p>
</span>,</div>
<div><span class="propName ">creditLimitAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. value : 10000000, Min. value : 0</p>
</span>,</div>
<div><span class="propName ">creditLimitEndDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">creditRemark</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 512</p>
</span>,</div>
<div><span class="propName ">regelingId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>For getting available number see at DomainValues - Regeling Domain Type</p>
</span>,</div>
<div><span class="propName ">caoId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCaos. Obsolete. Please use RegelingId</p>
</span>,</div>
<div><span class="propName ">marginWarning</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. value : 1000000, Min. value : -1000000, Max. accuracy : 2 decimals</p>
</span>,</div>
<div><span class="propName ">marginBlocking</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. value : 1000000, Min. value : -1000000, Max. accuracy : 2 decimals</p>
</span>,</div>
<div><span class="propName ">deliveryDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">toAttention</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 50</p>
</span>,</div>
<div><span class="propName ">emailForReminders</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Should be a valid email. Allows multiple values separated by semicolon : , Max. length : 50</p>
</span>,</div>
<div><span class="propName ">addresses</span> (<span class="propType">Array[AddressAddRequest]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">AddressAddRequest
{</span>
<div><span class="propName required">addressTypeId</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>Integer for AddressTypeId. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET</p>
</span>,</div>
<div><span class="propName ">street</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">number</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName ">unit</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 32</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 16</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Max. length : 256</p>
</span>,</div>
<div><span class="propName ">countryId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Integer for CountryId. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"name": "string",
"shortName": "string",
"legalName": "string",
"phone": "string",
"email": "string",
"totalHoursPerWeek": 0,
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"parentGuid": "00000000-0000-0000-0000-000000000000",
"isDepartment": true,
"kvkMainNumber": "string",
"kvkSubNumber": "string",
"contactUserGuid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"website": "string",
"debtorNumber": "string",
"debtorStatusId": 0,
"debtorStatusDate": "2024-06-13T09:50:13.434Z",
"debtorStatusDescription": "string",
"paymentTermsId": 0,
"vatNumber": "string",
"vatConditionId": 0,
"vatRateId": 0,
"vatGroupRateId": 0,
"gAccountUsage": true,
"gAccountAmount": 0,
"gAccountInclusiveTAX": true,
"bankAccountNumber": "string",
"bicCode": "string",
"invoiceMethodId": 0,
"invoiceScheduleId": 0,
"invoiceEmail": "string",
"invoiceEmailSecondary": "string",
"creditStatusId": 0,
"creditStatusDate": "2024-06-13T09:50:13.434Z",
"creditStatusDescription": "string",
"creditLimitAmount": 0,
"creditLimitEndDate": "2024-06-13T09:50:13.434Z",
"creditRemark": "string",
"regelingId": 0,
"caoId": 0,
"marginWarning": 0,
"marginBlocking": 0,
"deliveryDate": "2024-06-13T09:50:13.434Z",
"toAttention": "string",
"emailForReminders": "string",
"addresses": [
{
"addressTypeId": 0,
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"countryId": 0
}
]
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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"><label for="msearch0.3282127555814449">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.3282127555814449" type="text" value="">
</td>
<td class="markdown">
<p>Search filed. You can search by contact person name/email</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.07849875888473279">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.07849875888473279" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Employer Contact Person. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values.
</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.04859793629985898">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.04859793629985898" type="text" value="">
</td>
<td class="markdown">
<p>DateTime UTC value. Get user from last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.07512760134322605">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.07512760134322605" type="text" value="">
</td>
<td class="markdown">
<p>DateTime UTC value. Get user to last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.1616212176015932">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.1616212176015932" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.6157539799072538">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.6157539799072538" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="memployerGuid0.9256049329050882">employerGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="employerGuid" placeholder="(required)" id="memployerGuid0.9256049329050882" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of employer</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mcontactPersonGuid0.3045937887121424">contactPersonGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="contactPersonGuid" placeholder="(required)" id="mcontactPersonGuid0.3045937887121424" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of employer contact person</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Employer or Contact person with specified GUID was not found</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="memployerGuid0.41266442826444183">employerGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="employerGuid" placeholder="(required)" id="memployerGuid0.41266442826444183" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mcontactPersonGuid0.6707786989190108">contactPersonGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="contactPersonGuid" placeholder="(required)" id="mcontactPersonGuid0.6707786989190108" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Contact Person</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.3388953804868575">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.3388953804868575"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.15692639184707935" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.15692639184707935">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Supported operations: add, replace, copy, move, remove</p>
</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">JsonPatchDocument[EmployerContactPersonUpdateRequest] {</span>
<div class="readOnly"><span class="propName ">operations</span> (<span class="propType">Array[Operation[EmployerContactPersonUpdateRequest]]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read
only</span>)</div><span class="strong">}</span><br><span class="strong">Operation[EmployerContactPersonUpdateRequest] {</span>
<div><span class="propName ">value</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new property value</p>
</span>,</div>
<div><span class="propName ">path</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Property name. Should start with “/”</p>
</span>,</div>
<div><span class="propName ">op</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move” and “copy”. The operations are applied in order: if any of them fail then the whole patch operation should abort.</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Using with Move operation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"value": "new value",
"path": "/FirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/PreferredFirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/MiddleName",
"op": "replace"
},
{
"value": "new value",
"path": "/PrefixSurname",
"op": "replace"
},
{
"value": "new value",
"path": "/Surname",
"op": "replace"
},
{
"value": "new value",
"path": "/LastName",
"op": "replace"
},
{
"value": "new value",
"path": "/Salutation",
"op": "replace"
},
{
"value": "new value",
"path": "/GenderId",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/Mobile",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/AgencyContactPersonGuid",
"op": "replace"
}
]</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>Contact persons for employer has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Employer or contact person with specified GUID was not found</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="memployerGuid0.23462106304139496">employerGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="employerGuid" placeholder="(required)" id="memployerGuid0.23462106304139496" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Employer with specified GUID was not found</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="memployerGuid0.2044162631307549">employerGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="employerGuid" placeholder="(required)" id="memployerGuid0.2044162631307549" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.6031118224831675">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.6031118224831675"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.030021143744382695" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.030021143744382695">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Supported operations: add, replace, copy, move, remove</p>
</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">JsonPatchDocument[EmployerUpdateRequest] {</span>
<div class="readOnly"><span class="propName ">operations</span> (<span class="propType">Array[Operation[EmployerUpdateRequest]]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>)</div>
<span class="strong">}</span><br><span class="strong">Operation[EmployerUpdateRequest] {</span>
<div><span class="propName ">value</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new property value</p>
</span>,</div>
<div><span class="propName ">path</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Property name. Should start with “/”</p>
</span>,</div>
<div><span class="propName ">op</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The patch operations supported by JSON Patch are “add”, “remove”, “replace”, “move” and “copy”. The operations are applied in order: if any of them fail then the whole patch operation should abort.</p>
</span>,</div>
<div><span class="propName ">from</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Using with Move operation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>[
{
"value": "new value",
"path": "/TotalHoursPerWeek",
"op": "replace"
},
{
"value": "new value",
"path": "/Name",
"op": "replace"
},
{
"value": "new value",
"path": "/ShortName",
"op": "replace"
},
{
"value": "new value",
"path": "/LegalName",
"op": "replace"
},
{
"value": "new value",
"path": "/Description",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/KvkMainNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/KvkSubNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/ContactUserGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/EntityStateId",
"op": "replace"
},
{
"value": "new value",
"path": "/Website",
"op": "replace"
},
{
"value": "new value",
"path": "/PaymentTermsId",
"op": "replace"
},
{
"value": "new value",
"path": "/VATNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/VATConditionId",
"op": "replace"
},
{
"value": "new value",
"path": "/VATRateId",
"op": "replace"
},
{
"value": "new value",
"path": "/VATGroupRateId",
"op": "replace"
},
{
"value": "new value",
"path": "/BankAccountNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/BICCode",
"op": "replace"
},
{
"value": "new value",
"path": "/InvoiceMethodId",
"op": "replace"
},
{
"value": "new value",
"path": "/InvoiceScheduleId",
"op": "replace"
},
{
"value": "new value",
"path": "/InvoiceEmail",
"op": "replace"
},
{
"value": "new value",
"path": "/InvoiceEmailSecondary",
"op": "replace"
},
{
"value": "new value",
"path": "/CaoId",
"op": "replace"
},
{
"value": "new value",
"path": "/RegelingId",
"op": "replace"
},
{
"value": "new value",
"path": "/MarginWarning",
"op": "replace"
},
{
"value": "new value",
"path": "/MarginBlocking",
"op": "replace"
},
{
"value": "new value",
"path": "/DeliveryDate",
"op": "replace"
},
{
"value": "new value",
"path": "/GAccountUsage",
"op": "replace"
},
{
"value": "new value",
"path": "/GAccountAmount",
"op": "replace"
},
{
"value": "new value",
"path": "/GAccountInclusiveTAX",
"op": "replace"
},
{
"value": "new value",
"path": "/ToAttention",
"op": "replace"
},
{
"value": "new value",
"path": "/Addresses",
"op": "replace"
},
{
"value": "new value",
"path": "/CreditStatusId",
"op": "replace"
},
{
"value": "new value",
"path": "/CreditLimitAmount",
"op": "replace"
},
{
"value": "new value",
"path": "/CreditLimitEndDate",
"op": "replace"
},
{
"value": "new value",
"path": "/CreditRemark",
"op": "replace"
},
{
"value": "new value",
"path": "/EmailForReminders",
"op": "replace"
}
]</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>Employer has been successfully updated</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Employer with specified GUID was not found</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="memployerGuid0.941543558515779">employerGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="employerGuid" placeholder="(required)" id="memployerGuid0.941543558515779" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of employer</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mcostCenterGuid0.03649139834882886">costCenterGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="costCenterGuid" placeholder="(required)" id="mcostCenterGuid0.03649139834882886" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of employer cost center</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Employer or cost center with specified GUID was not found</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="memployerGuid0.09902478182206731">employerGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="employerGuid" placeholder="(required)" id="memployerGuid0.09902478182206731" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>GUID of employer</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="msearch0.7563126273757765">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.7563126273757765" type="text" value="">
</td>
<td class="markdown">
<p>Search filed. You can search by cost center name or code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.46743518308274323">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.46743518308274323" type="text" value="">
</td>
<td class="markdown">
<p>DateTime UTC value. Get cost center from last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.6269018949512812">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.6269018949512812" type="text" value="">
</td>
<td class="markdown">
<p>DateTime UTC value. Get cost center to last updated date. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.005553862744531068">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.005553862744531068" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.9530594571792541">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.9530594571792541" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Employer with specified GUID was not found</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"><label for="mwhatSearch0.3514813443448248">whatSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whatSearch" placeholder="" id="mwhatSearch0.3514813443448248" type="text" value="">
</td>
<td class="markdown">
<p>Job title or description. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mwhereSearch0.13963581682802895">whereSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whereSearch" placeholder="" id="mwhereSearch0.13963581682802895" type="text" value="">
</td>
<td class="markdown">
<p>Job city, country. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlocationAreaRadius0.22876043167295812">locationAreaRadius</label></td>
<td>
<input class="parameter" minlength="0" name="locationAreaRadius" placeholder="" id="mlocationAreaRadius0.22876043167295812" type="text" value="">
</td>
<td class="markdown">
<p>Location area radius of search. You can enter single integer value. , Min. value : 0, Max. value : 80</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.1093892772670142">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.1093892772670142" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="memployerGuids0.8264803555524356">employerGuids</label></td>
<td>
<textarea class="body-textarea" name="employerGuids" id="memployerGuids0.8264803555524356" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Employers of Job. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="massigneeGuids0.43615342710882676">assigneeGuids</label></td>
<td>
<textarea class="body-textarea" name="assigneeGuids" id="massigneeGuids0.43615342710882676" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Agency Users of Job. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mownerGuids0.8348305259025304">ownerGuids</label></td>
<td>
<textarea class="body-textarea" name="ownerGuids" id="mownerGuids0.8348305259025304" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Agencies of Job. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mjobCategoryIds0.7501040987130227">jobCategoryIds</label></td>
<td>
<textarea class="body-textarea" name="jobCategoryIds" id="mjobCategoryIds0.7501040987130227" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Job Category of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of
values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mindustryIds0.9313697908249223">industryIds</label></td>
<td>
<textarea class="body-textarea" name="industryIds" id="mindustryIds0.9313697908249223" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Industries of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values.
</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="miscoJobFunctionIds0.8186986429473759">iscoJobFunctionIds</label></td>
<td>
<textarea class="body-textarea" name="iscoJobFunctionIds" id="miscoJobFunctionIds0.8186986429473759" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values ISCO Job Function of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of
values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtagIds0.7432175399995422">tagIds</label></td>
<td>
<textarea class="body-textarea" name="tagIds" id="mtagIds0.7432175399995422" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for TagIds of Job. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskillIds0.383499869117669">skillIds</label></td>
<td>
<textarea class="body-textarea" name="skillIds" id="mskillIds0.383499869117669" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for SkillIds of Job. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mworkingHoursMin0.33077122122126323">workingHoursMin</label></td>
<td>
<input class="parameter" minlength="0" name="workingHoursMin" placeholder="" id="mworkingHoursMin0.33077122122126323" type="text" value="">
</td>
<td class="markdown">
<p>Min value for interval of working hours per week. You can enter single integer value. , Min. value : 0, Max. value : 168</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mworkingHoursMax0.6062369146504256">workingHoursMax</label></td>
<td>
<input class="parameter" minlength="0" name="workingHoursMax" placeholder="" id="mworkingHoursMax0.6062369146504256" type="text" value="">
</td>
<td class="markdown">
<p>Max value for interval of working hours per week. You can enter single integer value. , Min. value : 0, Max. value : 168</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="memploymentTypeIds0.5491824705143051">employmentTypeIds</label></td>
<td>
<textarea class="body-textarea" name="employmentTypeIds" id="memploymentTypeIds0.5491824705143051" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Job Type and Employment Type of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET . You can enter a comma
separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedFrom0.5525850653956299">lastUpdatedFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedFrom" placeholder="" id="mlastUpdatedFrom0.5525850653956299" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get job from last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedTo0.05474596742109683">lastUpdatedTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedTo" placeholder="" id="mlastUpdatedTo0.05474596742109683" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get job to last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="msalaryMin0.7546839404697236">salaryMin</label></td>
<td>
<input class="parameter" minlength="0" name="salaryMin" placeholder="" id="msalaryMin0.7546839404697236" type="text" value="">
</td>
<td class="markdown">
<p>Min salary per month value. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msalaryMax0.9721892750782875">salaryMax</label></td>
<td>
<input class="parameter" minlength="0" name="salaryMax" placeholder="" id="msalaryMax0.9721892750782875" type="text" value="">
</td>
<td class="markdown">
<p>Max salary per month value. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcreatedByEmployerOnly0.550054521024461">createdByEmployerOnly</label></td>
<td>
<select class="parameter " name="createdByEmployerOnly" id="mcreatedByEmployerOnly0.550054521024461">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines whether to show or not to show jobs created by the employer only. </p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mincludeArchived0.24960964120653428">includeArchived</label></td>
<td>
<select class="parameter " name="includeArchived" id="mincludeArchived0.24960964120653428">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines if include archived jobs. The default is false. </p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="misTopOnly0.8692988802131987">isTopOnly</label></td>
<td>
<select class="parameter " name="isTopOnly" id="misTopOnly0.8692988802131987">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines whether to show top jobs only. The default is false. </p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="misPublishedOnly0.5281960126950855">isPublishedOnly</label></td>
<td>
<select class="parameter " name="isPublishedOnly" id="misPublishedOnly0.5281960126950855">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines whether to show published jobs only. The default is false. </p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mskip0.2919420534744266">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.2919420534744266" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.6574360335370459">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.6574360335370459" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mjobGuid0.08717953156371427">jobGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="jobGuid" placeholder="(required)" id="mjobGuid0.08717953156371427" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Job</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Job with specified GUID was not found</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="mtype0.8413885409008615">type</label></td>
<td>
<input class="parameter required" minlength="1" name="type" placeholder="(required)" id="mtype0.8413885409008615" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Type of indicator - EmploymentType - 1, JobCategory - 2, Industry - 3, ISCOJobFunction - 4</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mwhatSearch0.4521190386988465">whatSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whatSearch" placeholder="" id="mwhatSearch0.4521190386988465" type="text" value="">
</td>
<td class="markdown">
<p>Job title or description. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mwhereSearch0.3261781764046674">whereSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whereSearch" placeholder="" id="mwhereSearch0.3261781764046674" type="text" value="">
</td>
<td class="markdown">
<p>Job city, country. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlocationAreaRadius0.525587947207407">locationAreaRadius</label></td>
<td>
<input class="parameter" minlength="0" name="locationAreaRadius" placeholder="" id="mlocationAreaRadius0.525587947207407" type="text" value="">
</td>
<td class="markdown">
<p>Location area radius of search. You can enter single integer value. , Min. value : 0, Max. value : 80</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.4456324780369536">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.4456324780369536" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="memployerGuids0.07410123945125746">employerGuids</label></td>
<td>
<textarea class="body-textarea" name="employerGuids" id="memployerGuids0.07410123945125746" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Employers of Job. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="massigneeGuids0.3098494399404301">assigneeGuids</label></td>
<td>
<textarea class="body-textarea" name="assigneeGuids" id="massigneeGuids0.3098494399404301" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Agency Users of Job. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mownerGuids0.6223272900505614">ownerGuids</label></td>
<td>
<textarea class="body-textarea" name="ownerGuids" id="mownerGuids0.6223272900505614" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection for Agencies of Job. You can enter a comma separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mjobCategoryIds0.1873776378797105">jobCategoryIds</label></td>
<td>
<textarea class="body-textarea" name="jobCategoryIds" id="mjobCategoryIds0.1873776378797105" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Job Category of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of
values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mindustryIds0.11287804883514951">industryIds</label></td>
<td>
<textarea class="body-textarea" name="industryIds" id="mindustryIds0.11287804883514951" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Industries of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values.
</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="miscoJobFunctionIds0.520131053781594">iscoJobFunctionIds</label></td>
<td>
<textarea class="body-textarea" name="iscoJobFunctionIds" id="miscoJobFunctionIds0.520131053781594" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values ISCO Job Function of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of
values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtagIds0.9332943508257971">tagIds</label></td>
<td>
<textarea class="body-textarea" name="tagIds" id="mtagIds0.9332943508257971" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for TagIds of Job. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskillIds0.7924548835604392">skillIds</label></td>
<td>
<textarea class="body-textarea" name="skillIds" id="mskillIds0.7924548835604392" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for SkillIds of Job. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mworkingHoursMin0.07617941508506165">workingHoursMin</label></td>
<td>
<input class="parameter" minlength="0" name="workingHoursMin" placeholder="" id="mworkingHoursMin0.07617941508506165" type="text" value="">
</td>
<td class="markdown">
<p>Min value for interval of working hours per week. You can enter single integer value. , Min. value : 0, Max. value : 168</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mworkingHoursMax0.3258033617653058">workingHoursMax</label></td>
<td>
<input class="parameter" minlength="0" name="workingHoursMax" placeholder="" id="mworkingHoursMax0.3258033617653058" type="text" value="">
</td>
<td class="markdown">
<p>Max value for interval of working hours per week. You can enter single integer value. , Min. value : 0, Max. value : 168</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="memploymentTypeIds0.8189891546781152">employmentTypeIds</label></td>
<td>
<textarea class="body-textarea" name="employmentTypeIds" id="memploymentTypeIds0.8189891546781152" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Job Type and Employment Type of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET . You can enter a comma
separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="msalaryMin0.9238781304517862">salaryMin</label></td>
<td>
<input class="parameter" minlength="0" name="salaryMin" placeholder="" id="msalaryMin0.9238781304517862" type="text" value="">
</td>
<td class="markdown">
<p>Min salary per month value. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msalaryMax0.5895599532572484">salaryMax</label></td>
<td>
<input class="parameter" minlength="0" name="salaryMax" placeholder="" id="msalaryMax0.5895599532572484" type="text" value="">
</td>
<td class="markdown">
<p>Max salary per month value. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedFrom0.11926562501028704">lastUpdatedFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedFrom" placeholder="" id="mlastUpdatedFrom0.11926562501028704" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get job from last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedTo0.9973570415142028">lastUpdatedTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedTo" placeholder="" id="mlastUpdatedTo0.9973570415142028" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get job to last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcreatedByEmployerOnly0.9410212497882311">createdByEmployerOnly</label></td>
<td>
<select class="parameter " name="createdByEmployerOnly" id="mcreatedByEmployerOnly0.9410212497882311">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines whether to show or not to show jobs created by the employer only. </p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="mincludeArchived0.1660838462520584">includeArchived</label></td>
<td>
<select class="parameter " name="includeArchived" id="mincludeArchived0.1660838462520584">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines if include archived jobs. The default is false. </p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="misTopOnly0.8507731668210641">isTopOnly</label></td>
<td>
<select class="parameter " name="isTopOnly" id="misTopOnly0.8507731668210641">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines whether to show top jobs only. The default is false. </p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code"><label for="misPublishedOnly0.18523730808866778">isPublishedOnly</label></td>
<td>
<select class="parameter " name="isPublishedOnly" id="misPublishedOnly0.18523730808866778">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>Boolean value which determines whether to show published jobs only. The default is false. </p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mjobGuid0.0154350123054523">jobGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="jobGuid" placeholder="(required)" id="mjobGuid0.0154350123054523" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of active public job</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Public job with specified GUID was not found</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"><label for="mwhatSearch0.4246738402463093">whatSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whatSearch" placeholder="" id="mwhatSearch0.4246738402463093" type="text" value="">
</td>
<td class="markdown">
<p>Job title or description. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mwhereSearch0.5854170127302349">whereSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whereSearch" placeholder="" id="mwhereSearch0.5854170127302349" type="text" value="">
</td>
<td class="markdown">
<p>Job city, country. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlocationAreaRadius0.3784764136530314">locationAreaRadius</label></td>
<td>
<input class="parameter" minlength="0" name="locationAreaRadius" placeholder="" id="mlocationAreaRadius0.3784764136530314" type="text" value="">
</td>
<td class="markdown">
<p>Location area radius of search. You can enter single integer value. , Min. value : 0, Max. value : 80</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="memploymentTypeIds0.32859083271408074">employmentTypeIds</label></td>
<td>
<textarea class="body-textarea" name="employmentTypeIds" id="memploymentTypeIds0.32859083271408074" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Job Type and Employment Type of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET . You can enter a comma
separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="msalaryMin0.3913569970601818">salaryMin</label></td>
<td>
<input class="parameter" minlength="0" name="salaryMin" placeholder="" id="msalaryMin0.3913569970601818" type="text" value="">
</td>
<td class="markdown">
<p>Min salary per month value. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msalaryMax0.15368110789467448">salaryMax</label></td>
<td>
<input class="parameter" minlength="0" name="salaryMax" placeholder="" id="msalaryMax0.15368110789467448" type="text" value="">
</td>
<td class="markdown">
<p>Max salary per month value. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mjobCategoryIds0.4262364749064529">jobCategoryIds</label></td>
<td>
<textarea class="body-textarea" name="jobCategoryIds" id="mjobCategoryIds0.4262364749064529" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Job Category of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of
values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mindustryIds0.3570480277837935">industryIds</label></td>
<td>
<textarea class="body-textarea" name="industryIds" id="mindustryIds0.3570480277837935" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Industries of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values.
</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mworkingHoursMin0.9891987321497437">workingHoursMin</label></td>
<td>
<input class="parameter" minlength="0" name="workingHoursMin" placeholder="" id="mworkingHoursMin0.9891987321497437" type="text" value="">
</td>
<td class="markdown">
<p>Min value for interval of working hours per week. You can enter single integer value. , Min. value : 0, Max. value : 168</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mworkingHoursMax0.36729254586149507">workingHoursMax</label></td>
<td>
<input class="parameter" minlength="0" name="workingHoursMax" placeholder="" id="mworkingHoursMax0.36729254586149507" type="text" value="">
</td>
<td class="markdown">
<p>Max value for interval of working hours per week. You can enter single integer value. , Min. value : 0, Max. value : 168</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtagIds0.6796664645078159">tagIds</label></td>
<td>
<textarea class="body-textarea" name="tagIds" id="mtagIds0.6796664645078159" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for TagIds of Job. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskillIds0.6589965613457527">skillIds</label></td>
<td>
<textarea class="body-textarea" name="skillIds" id="mskillIds0.6589965613457527" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for SkillIds of Job. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedFrom0.9391675725657045">lastUpdatedFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedFrom" placeholder="" id="mlastUpdatedFrom0.9391675725657045" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get job from last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedTo0.00509552008534242">lastUpdatedTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedTo" placeholder="" id="mlastUpdatedTo0.00509552008534242" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get job to last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.3126102668768258">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.3126102668768258" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.16917214266178204">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.16917214266178204" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mtype0.47598497951201346">type</label></td>
<td>
<input class="parameter required" minlength="1" name="type" placeholder="(required)" id="mtype0.47598497951201346" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Type of indicator - EmploymentType - 1, JobCategory - 2, Industry - 3</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mwhatSearch0.39984784705761345">whatSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whatSearch" placeholder="" id="mwhatSearch0.39984784705761345" type="text" value="">
</td>
<td class="markdown">
<p>Job title or description. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mwhereSearch0.8218901197044683">whereSearch</label></td>
<td>
<input class="parameter" minlength="0" name="whereSearch" placeholder="" id="mwhereSearch0.8218901197044683" type="text" value="">
</td>
<td class="markdown">
<p>Job city, country. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlocationAreaRadius0.85731312596389">locationAreaRadius</label></td>
<td>
<input class="parameter" minlength="0" name="locationAreaRadius" placeholder="" id="mlocationAreaRadius0.85731312596389" type="text" value="">
</td>
<td class="markdown">
<p>Location area radius of search. You can enter single integer value. , Min. value : 0, Max. value : 80</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="memploymentTypeIds0.06616589333430523">employmentTypeIds</label></td>
<td>
<textarea class="body-textarea" name="employmentTypeIds" id="memploymentTypeIds0.06616589333430523" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Job Type and Employment Type of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET . You can enter a comma
separated list of values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="msalaryMin0.013689339184043359">salaryMin</label></td>
<td>
<input class="parameter" minlength="0" name="salaryMin" placeholder="" id="msalaryMin0.013689339184043359" type="text" value="">
</td>
<td class="markdown">
<p>Min salary per month value. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msalaryMax0.26823492957756145">salaryMax</label></td>
<td>
<input class="parameter" minlength="0" name="salaryMax" placeholder="" id="msalaryMax0.26823492957756145" type="text" value="">
</td>
<td class="markdown">
<p>Max salary per month value. You can enter single integer value. , Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mjobCategoryIds0.3006006243862833">jobCategoryIds</label></td>
<td>
<textarea class="body-textarea" name="jobCategoryIds" id="mjobCategoryIds0.3006006243862833" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Job Category of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of
values. </p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mindustryIds0.1346494606204809">industryIds</label></td>
<td>
<textarea class="body-textarea" name="industryIds" id="mindustryIds0.1346494606204809" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Domain Values Industries of Job. For getting available number you can find appropriate type at api/domainTypes GET and use it to find values at api/domainValues GET. You can enter a comma separated list of values.
</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mworkingHoursMin0.25773794870184275">workingHoursMin</label></td>
<td>
<input class="parameter" minlength="0" name="workingHoursMin" placeholder="" id="mworkingHoursMin0.25773794870184275" type="text" value="">
</td>
<td class="markdown">
<p>Min value for interval of working hours per week. You can enter single integer value. , Min. value : 0, Max. value : 168</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mworkingHoursMax0.9337336906237579">workingHoursMax</label></td>
<td>
<input class="parameter" minlength="0" name="workingHoursMax" placeholder="" id="mworkingHoursMax0.9337336906237579" type="text" value="">
</td>
<td class="markdown">
<p>Max value for interval of working hours per week. You can enter single integer value. , Min. value : 0, Max. value : 168</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtagIds0.8818655251409455">tagIds</label></td>
<td>
<textarea class="body-textarea" name="tagIds" id="mtagIds0.8818655251409455" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for TagIds of Job. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskillIds0.6939113011319169">skillIds</label></td>
<td>
<textarea class="body-textarea" name="skillIds" id="mskillIds0.6939113011319169" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for SkillIds of Job. You can enter a comma separated list of values. For getting available number see at /docs/index#!/Tags/Tags_Get_0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedFrom0.25346914211006677">lastUpdatedFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedFrom" placeholder="" id="mlastUpdatedFrom0.25346914211006677" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get job from last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdatedTo0.4869995944354153">lastUpdatedTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdatedTo" placeholder="" id="mlastUpdatedTo0.4869995944354153" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get job to last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mnewsGuid0.807537006541313">newsGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="newsGuid" placeholder="(required)" id="mnewsGuid0.807537006541313" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Public News</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Public News with specified GUID was not found</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"><label for="mskip0.4746954870497331">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.4746954870497331" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.5623854699653668">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.5623854699653668" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mtagId0.5307694378151506">tagId</label></td>
<td>
<input class="parameter required" minlength="1" name="tagId" placeholder="(required)" id="mtagId0.5307694378151506" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of Tag</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Tag with specified Id was not found</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"><label for="msearch0.0076997654736465915">search</label></td>
<td>
<input class="parameter" minlength="0" name="search" placeholder="" id="msearch0.0076997654736465915" type="text" value="">
</td>
<td class="markdown">
<p>Tag name. You can enter a string with max length 128 chars , Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityTypeIds0.09775693564682952">entityTypeIds</label></td>
<td>
<textarea class="body-textarea" name="entityTypeIds" id="mentityTypeIds0.09775693564682952" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Type of Entity wich has connected tag. You can enter a comma separated list of values. Job - 94, Employer - 18, Candidate - 95, User - 105, JobMatchProfile - 321, CandidateMatchProfile - 372</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtagTypeIds0.8297321399722974">tagTypeIds</label></td>
<td>
<textarea class="body-textarea" name="tagTypeIds" id="mtagTypeIds0.8297321399722974" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for Type of Tag. You can enter a comma separated list of values. General - 1, Skill - 2</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.2397708090805153">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.2397708090805153" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.7136955312260989">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.7136955312260989" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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"><label for="magencyGuids0.6315573470829805">agencyGuids</label></td>
<td>
<textarea class="body-textarea" name="agencyGuids" id="magencyGuids0.6315573470829805" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection of Agencies. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="memployerGuids0.5104378515713062">employerGuids</label></td>
<td>
<textarea class="body-textarea" name="employerGuids" id="memployerGuids0.5104378515713062" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection of Employers. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcandidateGuids0.2589739118929619">candidateGuids</label></td>
<td>
<textarea class="body-textarea" name="candidateGuids" id="mcandidateGuids0.2589739118929619" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection of Candidates. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcontractGuids0.9154554003094979">contractGuids</label></td>
<td>
<textarea class="body-textarea" name="contractGuids" id="mcontractGuids0.9154554003094979" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Guid collection of Contracts. You can enter a comma separated list of values.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mentityStateIds0.4829157221104068">entityStateIds</label></td>
<td>
<textarea class="body-textarea" name="entityStateIds" id="mentityStateIds0.4829157221104068" placeholder="Provide multiple values in new lines."></textarea>
</td>
<td class="markdown">
<p>Integer collection for State of Timecard. You can enter a comma separated list of values. Report - 151, Submitted - 152, ToBeApprovedByAgency - 204, Approved - 153, Rejected - 154, Completed - 155, Deleted - 156, ToBeCalculated - 219,
Processed - 231, ToBeCanceled - 391, Canceled - 392</p>
</td>
<td>query</td>
<td>
<span class="model-signature">Array[integer]</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcFrom0.5745373321774043">lastUpdateDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcFrom" placeholder="" id="mlastUpdateDateUtcFrom0.5745373321774043" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get timecards from last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlastUpdateDateUtcTo0.6216869363387723">lastUpdateDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="lastUpdateDateUtcTo" placeholder="" id="mlastUpdateDateUtcTo0.6216869363387723" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get timecards to last updated date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mstartDateUtcFrom0.26395182047771715">startDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="startDateUtcFrom" placeholder="" id="mstartDateUtcFrom0.26395182047771715" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get timecards from start date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mstartDateUtcTo0.8015245147897534">startDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="startDateUtcTo" placeholder="" id="mstartDateUtcTo0.8015245147897534" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get timecards to start date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mendDateUtcFrom0.23633722370543797">endDateUtcFrom</label></td>
<td>
<input class="parameter" minlength="0" name="endDateUtcFrom" placeholder="" id="mendDateUtcFrom0.23633722370543797" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get timecards from end date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mendDateUtcTo0.13472716583543076">endDateUtcTo</label></td>
<td>
<input class="parameter" minlength="0" name="endDateUtcTo" placeholder="" id="mendDateUtcTo0.13472716583543076" type="text" value="">
</td>
<td class="markdown">
<p>DateTime value. Get timecards to end date.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mskip0.10025799378396827">skip</label></td>
<td>
<input class="parameter" minlength="0" name="skip" placeholder="" id="mskip0.10025799378396827" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to skip. The default is 0, Min. value : 0</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mtake0.6580637213628322">take</label></td>
<td>
<input class="parameter" minlength="0" name="take" placeholder="" id="mtake0.6580637213628322" type="text" value="">
</td>
<td class="markdown">
<p>Quantity items to take on the page. The default is 10, Min. value : 1, Max. value : 100</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mtimecardGuid0.7578832794487997">timecardGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="timecardGuid" placeholder="(required)" id="mtimecardGuid0.7578832794487997" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Guid of Timecard</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>Timecard with specified GUID was not found</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>
<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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">410</td>
<td class="markdown">
<p>No longer available</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="mcaoId0.7601818014998358">caoId</label></td>
<td>
<input class="parameter required" minlength="1" name="caoId" placeholder="(required)" id="mcaoId0.7601818014998358" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAO. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCAOs</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mcaoFunctionId0.4524953505071041">caoFunctionId</label></td>
<td>
<input class="parameter required" minlength="1" name="caoFunctionId" placeholder="(required)" id="mcaoFunctionId0.4524953505071041" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAOFunction. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCAOFunctions</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mcaoFunctionGroupId0.0279947535509375">caoFunctionGroupId</label></td>
<td>
<input class="parameter required" minlength="1" name="caoFunctionGroupId" placeholder="(required)" id="mcaoFunctionGroupId0.0279947535509375" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAOFunctionGroup. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCAOFunctionGroups</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mworkWeekHours0.997945423217987">workWeekHours</label></td>
<td>
<input class="parameter required" minlength="1" name="workWeekHours" placeholder="(required)" id="mworkWeekHours0.997945423217987" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Hours of working week. You can enter single float value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetWorkWeekHours, Min. value : 1, Max. value : 168</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">float</span></td>
</tr>
<tr>
<td class="code required"><label for="mbirthdate0.641319867715282">birthdate</label></td>
<td>
<input class="parameter required" minlength="1" name="birthdate" placeholder="(required)" id="mbirthdate0.641319867715282" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Date of birth. You can enter DateTime value., Min. value : 13 years</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mdate0.42207076409443034">date</label></td>
<td>
<input class="parameter required" minlength="1" name="date" placeholder="(required)" id="mdate0.42207076409443034" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Request start date. You can enter DateTime value.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mperiodic0.8418570081069463">periodic</label></td>
<td>
<input class="parameter required" minlength="1" name="periodic" placeholder="(required)" id="mperiodic0.8418570081069463" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Experience. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetPeriodics, Min. value : 0, Max. value : 77</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="memployer0.29283172189576345">employer</label></td>
<td>
<input class="parameter" minlength="0" name="employer" placeholder="" id="memployer0.29283172189576345" type="text" value="">
</td>
<td class="markdown">
<p>Name of Employer. You can enter string with max length 128 chars., Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="magency0.19821505856589638">agency</label></td>
<td>
<input class="parameter" minlength="0" name="agency" placeholder="" id="magency0.19821505856589638" type="text" value="">
</td>
<td class="markdown">
<p>Name of Agency. You can enter string with max length 128 chars., Max. length : 128</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mflexWorker0.9405410525189952">flexWorker</label></td>
<td>
<input class="parameter" minlength="0" name="flexWorker" placeholder="" id="mflexWorker0.9405410525189952" type="text" value="">
</td>
<td class="markdown">
<p>Name of FlexWorker. You can enter string with max length 64 chars., Max. length : 64</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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"><label for="msbiCode0.5208797150368305">sbiCode</label></td>
<td>
<input class="parameter" minlength="0" name="sbiCode" placeholder="" id="msbiCode0.5208797150368305" type="text" value="">
</td>
<td class="markdown">
<p>SBI Code. You can enter string value.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpayrollCode0.44411976771330375">payrollCode</label></td>
<td>
<input class="parameter" minlength="0" name="payrollCode" placeholder="" id="mpayrollCode0.44411976771330375" type="text" value="">
</td>
<td class="markdown">
<p>Payroll Code. You can enter single integer value.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mpayrollName0.8369759461573665">payrollName</label></td>
<td>
<input class="parameter" minlength="0" name="payrollName" placeholder="" id="mpayrollName0.8369759461573665" type="text" value="">
</td>
<td class="markdown">
<p>Payroll Name. You can enter string value.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mcaoId0.6224855798605933">caoId</label></td>
<td>
<input class="parameter required" minlength="1" name="caoId" placeholder="(required)" id="mcaoId0.6224855798605933" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAO. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCAOs</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mcaoFunctionId0.6392300272388614">caoFunctionId</label></td>
<td>
<input class="parameter required" minlength="1" name="caoFunctionId" placeholder="(required)" id="mcaoFunctionId0.6392300272388614" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAOFunction. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCAOFunctions</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mcaoId0.9476817887538003">caoId</label></td>
<td>
<input class="parameter required" minlength="1" name="caoId" placeholder="(required)" id="mcaoId0.9476817887538003" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAO. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCAOs</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mcaoId0.5983053335351614">caoId</label></td>
<td>
<input class="parameter required" minlength="1" name="caoId" placeholder="(required)" id="mcaoId0.5983053335351614" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAO. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCAOs</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mcaoFunctionGroupId0.45096250385026804">caoFunctionGroupId</label></td>
<td>
<input class="parameter required" minlength="1" name="caoFunctionGroupId" placeholder="(required)" id="mcaoFunctionGroupId0.45096250385026804" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of CAOFunctionGroup. You can enter single integer value. For getting available number see at /docs/index#!/WageSearch/WageSearch_GetCAOFunctionGroups</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mbirthDate0.4498668369899874">birthDate</label></td>
<td>
<input class="parameter required" minlength="1" name="birthDate" placeholder="(required)" id="mbirthDate0.4498668369899874" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Date of birth. You can enter DateTime value.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</span></td>
</tr>
<tr>
<td class="code required"><label for="mdate0.3161427149143887">date</label></td>
<td>
<input class="parameter required" minlength="1" name="date" placeholder="(required)" id="mdate0.3161427149143887" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Date of birth. You can enter DateTime value.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">date-time</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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>
<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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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>
<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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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>
<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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mwebHook0.34153241117442334">webHook</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="webHook" id="mwebHook0.34153241117442334"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5834580977886055" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5834580977886055">
<option value="application/json">application/json</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">WebHook {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">webHookUri</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPaused</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div class="readOnly"><span class="propName ">filters</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>),</div>
<div class="readOnly"><span class="propName ">headers</span> (<span class="propType">inline_model_0</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>),</div>
<div class="readOnly"><span class="propName ">properties</span> (<span class="propType">inline_model_1</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>)</div><span
class="strong">}</span><br><span class="strong">inline_model_0 {</span><span class="strong">}</span><br><span class="strong">inline_model_1 {</span><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"id": "string",
"webHookUri": "string",
"secret": "string",
"description": "string",
"isPaused": true,
"filters": [
"string"
],
"headers": {},
"properties": {}
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mid0.07001742230599639">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.07001742230599639" 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 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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mid0.42721960036991313">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.42721960036991313" 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 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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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="mid0.5406573368561498">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.5406573368561498" 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="mwebHook0.22403039991456075">webHook</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="webHook" id="mwebHook0.22403039991456075"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.40019069257429907" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.40019069257429907">
<option value="application/json">application/json</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">WebHook {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName required">webHookUri</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">secret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPaused</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div class="readOnly"><span class="propName ">filters</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>),</div>
<div class="readOnly"><span class="propName ">headers</span> (<span class="propType">inline_model_0</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>),</div>
<div class="readOnly"><span class="propName ">properties</span> (<span class="propType">inline_model_1</span>, <span class="propOptKey">optional</span>, <span class="propReadOnly">read only</span>)</div><span
class="strong">}</span><br><span class="strong">inline_model_0 {</span><span class="strong">}</span><br><span class="strong">inline_model_1 {</span><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"id": "string",
"webHookUri": "string",
"secret": "string",
"description": "string",
"isPaused": true,
"filters": [
"string"
],
"headers": {},
"properties": {}
}</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">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td class="markdown">
<p>Unauthorized</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>Text Content
Explore
Get Started
Webhooks integration
Employer address operations
! Rate limiting of API is 2 concurrent requests and 5 requests in 100 ms at
maximum. A request will be aborted when the rate limits are exceeded.
HelloFlex API
* ACTIVITIES
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/ACTIVITIES
* List Activities
IMPLEMENTATION NOTES
Returns activities for Customer
RESPONSE CLASS (STATUS 200)
Returns list items of activities
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
title (string, optional),
dueDate (string, optional),
entityGuid (string, optional),
entityName (string, optional),
entityTypeId (integer, optional),
entityTypeName (string, optional),
priorityId (integer, optional),
priorityName (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
ownerUserGuid (string, optional),
ownerUserName (string, optional),
assigneeTypeId (integer, optional),
assignedUserGuid (string, optional),
assignedUserName (string, optional),
departmentId (integer, optional),
departmentName (string, optional),
agencyGuid (string, optional),
agencyName (string, optional),
lastUpdatedDateTimeUtc (string, optional),
isArchived (boolean, optional),
typeId (integer, optional),
typeName (string, optional),
subjectId (integer, optional),
subjectName (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"dueDate": "2024-06-13T09:50:13.221Z",
"entityGuid": "00000000-0000-0000-0000-000000000000",
"entityName": "string",
"entityTypeId": 0,
"entityTypeName": "string",
"priorityId": 0,
"priorityName": "string",
"entityStateId": 0,
"entityStateName": "string",
"ownerUserGuid": "00000000-0000-0000-0000-000000000000",
"ownerUserName": "string",
"assigneeTypeId": 0,
"assignedUserGuid": "00000000-0000-0000-0000-000000000000",
"assignedUserName": "string",
"departmentId": 0,
"departmentName": "string",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"lastUpdatedDateTimeUtc": "2024-06-13T09:50:13.222Z",
"isArchived": true,
"typeId": 0,
"typeName": "string",
"subjectId": 0,
"subjectName": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type search
String value for search by activity title name and description., Max.
length : 128
query string entityStateIds
You can find possible values at GET api/domainTypes/927/domainValues. You
can enter a comma separated list of values.
query Array[integer] priorityIds
You can find possible values at GET api/domainTypes/926/domainValues. You
can enter a comma separated list of values.
query Array[integer] typeIds
You can find possible values at GET api/domainTypes/918/domainValues. You
can enter a comma separated list of values.
query Array[integer] subjectIds
You can find possible values at GET api/domainTypes/865/domainValues. You
can enter a comma separated list of values.
query Array[integer] ownerUserGuids
You can find possible values at GET
/api/agencies/{agencyGuid}/contactperson, GET
/api/employers/{employerGuid}/contactpersons or GET /api/candidates. You
can enter a comma separated list of values.
query Array[string] assigneeTypeId
1 = User, 2 = Department, 3 = Agency.
query integer assignedUserGuids
You can find possible values at GET
/api/agencies/{agencyGuid}/contactperson, GET
/api/employers/{employerGuid}/contactpersons or GET /api/candidates. You
can enter a comma separated list of values.
query Array[string] departmentIds
You can find possible values at GET api/domainTypes/930/domainValues. You
can enter a comma separated list of values.
query Array[integer] agencyGuids
You can find possible values at GET /api/agencies. You can enter a comma
separated list of values.
query Array[string] dueDateFrom
DateTime value. Get activities with due date after the specified date.
query date-time dueDateTo
DateTime value. Get activities with due date before the specified date.
query date-time includeArchived true false
Boolean value. Get archived activities.
query boolean lastUpdatedDateTimeUtcFrom
DateTime value. Get activities from last updated date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/ACTIVITIES
* Create Activity
IMPLEMENTATION NOTES
Create an activity, based on typeId. To add an activity for a specific
entity, such as ‘Candidate’ or ‘Employer’, please use both entityGuid and
entityTypeId.
RESPONSE CLASS (STATUS 201)
Created successfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json
body
* Model
* Example Value
ActivityAddRequest {
typeId (integer):
You can find possible values at GET api/domainTypes/918/domainValues.
,
priorityId (integer):
You can find possible values at GET api/domainTypes/926/domainValues.
,
entityStateId (integer):
You can find possible values at GET api/domainTypes/927/domainValues.
,
dueDate (string, optional):
The current date will be used if a value is not defined
,
title (string):
Max. length : 256
,
description (string, optional):
Max. length : 5000
,
entityGuid (string, optional),
entityTypeId (integer, optional):
You can find possible values at GET api/domainTypes/928/domainValues.
,
ownerUserGuid (string):
You can find possible values at GET
/api/agencies/{agencyGuid}/contactpersons, GET
/api/employers/{employerGuid}/contactpersons or GET /api/candidates.
,
assignedUserGuid (string, optional):
You can find possible values at GET
/api/agencies/{agencyGuid}/contactpersons, GET
/api/employers/{employerGuid}/contactpersons or GET /api/candidates.
Either assignedUserGuid, departmentId or agencyGuid should be set.
,
departmentId (integer, optional):
You can find possible values at GET /api/domainTypes/930/domainValues.
Either assignedUserGuid, departmentId or agencyGuid should be set.
,
agencyGuid (string, optional):
You can find possible values at GET /api/agencies. Either
assignedUserGuid, departmentId or agencyGuid should be set.
,
subjectId (integer, optional):
You can find possible values at GET /api/domainTypes/865/domainValues.
,
customCandidateGuids (Array[string], optional):
You can find possible values at GET /api/candidates
,
customContactPersonGuids (Array[string], optional):
You can find possible values at GET /api/employers/contactpersons
,
customEmployerGuids (Array[string], optional):
You can find possible values at GET /api/employers
}
{
"typeId": 0,
"priorityId": 0,
"entityStateId": 0,
"dueDate": "2024-06-13T09:50:13.243Z",
"title": "string",
"description": "string",
"entityGuid": "00000000-0000-0000-0000-000000000000",
"entityTypeId": 0,
"ownerUserGuid": "00000000-0000-0000-0000-000000000000",
"assignedUserGuid": "00000000-0000-0000-0000-000000000000",
"departmentId": 0,
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"subjectId": 0,
"customCandidateGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customContactPersonGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customEmployerGuids": [
"00000000-0000-0000-0000-000000000000"
]
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/ACTIVITIES/{ACTIVITYGUID}
* Activity details
IMPLEMENTATION NOTES
Returns Activity by Guid
RESPONSE CLASS (STATUS 200)
Returns Activity details
* Model
* Example Value
ActivityDetailsResponse {
guid (string, optional),
title (string, optional),
dueDate (string, optional),
description (string, optional),
entityGuid (string, optional),
entityName (string, optional),
entityTypeId (integer, optional),
entityTypeName (string, optional),
priorityId (integer, optional),
priorityName (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
ownerUserGuid (string, optional),
ownerUserName (string, optional),
assigneeTypeId (integer, optional),
assignedUserGuid (string, optional),
assignedUserName (string, optional),
departmentId (integer, optional),
departmentName (string, optional),
agencyId (integer, optional),
agencyGuid (string, optional),
agencyName (string, optional),
isArchived (boolean, optional),
lastUpdatedDateTimeUtc (string, optional),
typeId (integer, optional),
typeName (string, optional),
subjectId (integer, optional),
subjectName (string, optional),
customCandidateGuids (Array[string], optional),
customContactPersonGuids (Array[string], optional),
customEmployerGuids (Array[string], optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"dueDate": "2024-06-13T09:50:13.247Z",
"description": "string",
"entityGuid": "00000000-0000-0000-0000-000000000000",
"entityName": "string",
"entityTypeId": 0,
"entityTypeName": "string",
"priorityId": 0,
"priorityName": "string",
"entityStateId": 0,
"entityStateName": "string",
"ownerUserGuid": "00000000-0000-0000-0000-000000000000",
"ownerUserName": "string",
"assigneeTypeId": 0,
"assignedUserGuid": "00000000-0000-0000-0000-000000000000",
"assignedUserName": "string",
"departmentId": 0,
"departmentName": "string",
"agencyId": 0,
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"isArchived": true,
"lastUpdatedDateTimeUtc": "2024-06-13T09:50:13.248Z",
"typeId": 0,
"typeName": "string",
"subjectId": 0,
"subjectName": "string",
"customCandidateGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customContactPersonGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customEmployerGuids": [
"00000000-0000-0000-0000-000000000000"
]
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type activityGuid
Guid of Activity
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Activity with specified Guid was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /API/ACTIVITIES/{ACTIVITYGUID}
* Update activity
IMPLEMENTATION NOTES
Update activity
PARAMETERS
Parameter Value Description Parameter Type Data Type activityGuid path
string request
Parameter content type: application/json
body
* Model
* Example Value
ActivityUpdateRequest {
typeId (integer):
You can find possible values at GET api/domainTypes/918/domainValues.
,
priorityId (integer):
You can find possible values at GET api/domainTypes/926/domainValues.
,
entityStateId (integer):
You can find possible values at GET api/domainTypes/927/domainValues.
,
dueDate (string, optional):
The current date will be used if a value is not defined
,
title (string):
Max. length : 256
,
description (string, optional):
Max. length : 5000
,
entityGuid (string, optional),
entityTypeId (integer, optional):
You can find possible values at GET api/domainTypes/928/domainValues.
,
ownerUserGuid (string):
You can find possible values at GET
/api/agencies/{agencyGuid}/contactpersons, GET
/api/employers/{employerGuid}/contactpersons or GET /api/candidates.
,
assignedUserGuid (string, optional):
You can find possible values at GET
/api/agencies/{agencyGuid}/contactpersons, GET
/api/employers/{employerGuid}/contactpersons or GET /api/candidates.
Either assignedUserGuid, departmentId or agencyGuid should be set.
,
departmentId (integer, optional):
You can find possible values at GET /api/domainTypes/930/domainValues.
Either assignedUserGuid, departmentId or agencyGuid should be set.
,
agencyGuid (string, optional):
You can find possible values at GET /api/agencies. Either
assignedUserGuid, departmentId or agencyGuid should be set.
,
subjectId (integer, optional):
You can find possible values at GET /api/domainTypes/865/domainValues.
,
customCandidateGuids (Array[string], optional):
You can find possible values at GET /api/candidates
,
customContactPersonGuids (Array[string], optional):
You can find possible values at GET /api/employers/contactpersons
,
customEmployerGuids (Array[string], optional):
You can find possible values at GET /api/employers
}
{
"typeId": 0,
"priorityId": 0,
"entityStateId": 0,
"dueDate": "2024-06-13T09:50:13.254Z",
"title": "string",
"description": "string",
"entityGuid": "00000000-0000-0000-0000-000000000000",
"entityTypeId": 0,
"ownerUserGuid": "00000000-0000-0000-0000-000000000000",
"assignedUserGuid": "00000000-0000-0000-0000-000000000000",
"departmentId": 0,
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"subjectId": 0,
"customCandidateGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customContactPersonGuids": [
"00000000-0000-0000-0000-000000000000"
],
"customEmployerGuids": [
"00000000-0000-0000-0000-000000000000"
]
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Updated successfully
400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* AGENCIES
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/AGENCIES
* List Agencies
IMPLEMENTATION NOTES
Returns agencies for Customer
RESPONSE CLASS (STATUS 200)
Returns list items of agencies
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
name (string, optional),
parentGuid (string, optional),
parentName (string, optional),
countryCode (string, optional),
city (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
organizationTypeId (integer, optional),
organizationTypeName (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
phone (string, optional),
email (string, optional),
contactPersonGuid (string, optional),
contactPersonName (string, optional),
lastUpdateDateUtc (string, optional),
postalCode (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"parentGuid": "00000000-0000-0000-0000-000000000000",
"parentName": "string",
"countryCode": "string",
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"organizationTypeId": 0,
"organizationTypeName": "string",
"entityStateId": 0,
"entityStateName": "string",
"phone": "string",
"email": "string",
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"contactPersonName": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.258Z",
"postalCode": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type entityStateIds
Integer collection for State of Agency. For getting available number you
can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET. You can enter a comma separated list of
values.
query Array[integer] organizationTypeIds
Integer collection for OrganizationTypes of Agency. For getting available
number you can find appropriate type at api/domainTypes GET and use it to
find values at api/domainValues GET. You can enter a comma separated list
of values.
query Array[integer] search
String value for search by agency name., Max. length : 128
query string lastUpdateDateUtcFrom
DateTime value. Get agency from last updated date.
query date-time lastUpdateDateUtcTo
DateTime value. Get agency to last updated date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/AGENCIES
* Agencies Registration
IMPLEMENTATION NOTES
Register agencies
RESPONSE CLASS (STATUS 201)
Registered succesfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json
body
* Model
* Example Value
AgencyAddRequest {
name (string):
Max. length : 256
,
shortName (string, optional):
Max. length : 256
,
legalName (string, optional):
Max. length : 256
,
phone (string, optional):
Max. length : 32
,
email (string, optional):
Should be a valid email : , Max. length : 128
,
parentGuid (string, optional):
GUID of parent agency. If empty will be assigned to customer organization
,
organizationTypeId (integer),
contactUserGuid (string, optional):
GUID of ContactUser. If empty will be assigned to customer user
,
entityStateId (integer, optional):
Integer for EntityStateId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
street (string, optional):
Max. length : 256
,
number (string, optional):
Max. length : 16
,
unit (string, optional):
Max. length : 32
,
postalCode (string, optional):
Max. length : 16
,
city (string, optional):
Max. length : 256
,
countryId (integer, optional):
Integer for CountryId. For getting available number you can find
appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
}
{
"name": "string",
"shortName": "string",
"legalName": "string",
"phone": "string",
"email": "string",
"parentGuid": "00000000-0000-0000-0000-000000000000",
"organizationTypeId": 0,
"contactUserGuid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"countryId": 0
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/AGENCIES/{AGENCYGUID}
* Agency Detail
IMPLEMENTATION NOTES
Returns agency detail by GUID
RESPONSE CLASS (STATUS 200)
Returns agency detail
* Model
* Example Value
AgencyDetailResponse {
guid (string, optional),
name (string, optional),
shortName (string, optional),
legalName (string, optional),
parentGuid (string, optional),
parentName (string, optional),
countryCode (string, optional),
postalCode (string, optional),
city (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
organizationTypeId (integer, optional),
organizationTypeName (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
phone (string, optional),
email (string, optional),
contactPersonGuid (string, optional),
contactPersonName (string, optional),
lastUpdateDateUtc (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"shortName": "string",
"legalName": "string",
"parentGuid": "00000000-0000-0000-0000-000000000000",
"parentName": "string",
"countryCode": "string",
"postalCode": "string",
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"organizationTypeId": 0,
"organizationTypeName": "string",
"entityStateId": 0,
"entityStateName": "string",
"phone": "string",
"email": "string",
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"contactPersonName": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.269Z"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type agencyGuid
GUID of Agency
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Agency with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /API/AGENCIES/{AGENCYGUID}
* Agencies Update
IMPLEMENTATION NOTES
Updating entity agency via JSON Patch standart.
PARAMETERS
Parameter Value Description Parameter Type Data Type agencyGuid
Guid of Agency
path string request
Parameter content type: application/json
Supported operations: add, replace, copy, move, remove
body
* Model
* Example Value
JsonPatchDocument[AgencyUpdateRequest] {
operations (Array[Operation[AgencyUpdateRequest]], optional, read only)
}
Operation[AgencyUpdateRequest] {
value (object, optional):
The new property value
,
path (string, optional):
Property name. Should start with “/”
,
op (string, optional):
The patch operations supported by JSON Patch are “add”, “remove”,
“replace”, “move” and “copy”. The operations are applied in order: if any
of them fail then the whole patch operation should abort.
,
from (string, optional):
Using with Move operation
}
[
{
"value": "new value",
"path": "/Name",
"op": "replace"
},
{
"value": "new value",
"path": "/ShortName",
"op": "replace"
},
{
"value": "new value",
"path": "/LegalName",
"op": "replace"
},
{
"value": "new value",
"path": "/Description",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/ContactUserGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/EntityStateId",
"op": "replace"
},
{
"value": "new value",
"path": "/Street",
"op": "replace"
},
{
"value": "new value",
"path": "/Number",
"op": "replace"
},
{
"value": "new value",
"path": "/Unit",
"op": "replace"
},
{
"value": "new value",
"path": "/PostalCode",
"op": "replace"
},
{
"value": "new value",
"path": "/City",
"op": "replace"
},
{
"value": "new value",
"path": "/CountryId",
"op": "replace"
}
]
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Agency has been successfully updated
400
BadRequest
401
Unauthorized
404
Agency with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/AGENCIES/{AGENCYGUID}/CONTACTPERSONS
* List Agency Contact Persons
IMPLEMENTATION NOTES
Returns contact persons for agency
RESPONSE CLASS (STATUS 200)
Returns list items of agency contact persons
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
formattedName (string, optional),
email (string, optional),
lastUpdateDateUtc (string, optional),
isOwner (boolean, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"entityStateName": "string",
"formattedName": "string",
"email": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.276Z",
"isOwner": true
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type agencyGuid
GUID of agency
path string search
Search field. You can search by contact person name/email
query string entityStateIds
Integer collection for State of Agency Contact Person. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET . You can enter a comma
separated list of values.
query Array[integer] lastUpdateDateUtcFrom
DateTime value. Get contact person from last updated date.
query date-time lastUpdateDateUtcTo
DateTime value. Get contact person to last updated date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Agency with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/AGENCIES/{AGENCYGUID}/CONTACTPERSONS
* Agency Contact Person Add
IMPLEMENTATION NOTES
Create agency contact person
RESPONSE CLASS (STATUS 201)
Created succesfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type agencyGuid path
string request
Parameter content type: application/json
body
* Model
* Example Value
AgencyContactPersonAddRequest {
firstName (string, optional):
String for First Names., Max. length : 64
,
preferredFirstName (string, optional):
String for Preferred First Name., Max. length : 64
,
middleName (string, optional):
String for Middle Name., Max. length : 32
,
lastName (string):
String for Last Name., Max. length : 64
,
salutation (string, optional):
String for Salutation., Max. length : 32
,
email (string, optional):
String for Email., Should be a valid email : , Max. length : 128
,
mobileNumber (string, optional):
String for Mobile Number., Max. length : 32
,
phone (string, optional):
String for Phone Number., Max. length : 32
,
genderId (integer, optional):
Integer for GenderId of contact person. For getting available number you
can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET .Male - 1, Female - 2, NotSpecified - 3
,
agencyContactPersonGuid (string, optional):
Guid for AgencyContactPersonGuid of Bureau.
}
{
"firstName": "string",
"preferredFirstName": "string",
"middleName": "string",
"lastName": "string",
"salutation": "string",
"email": "string",
"mobileNumber": "string",
"phone": "string",
"genderId": 0,
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Agency with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/AGENCIES/{AGENCYGUID}/CONTACTPERSONS/{CONTACTPERSONGUID}
* Agency Contact Person Detail
IMPLEMENTATION NOTES
Returns contact person for agency by GUID
RESPONSE CLASS (STATUS 200)
Returns contact person details
* Model
* Example Value
AgencyContactPersonDetailsResponse {
guid (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
lastName (string, optional),
surname (string, optional):
Should be deprecated. Please use "LastName" instead
,
middleName (string, optional),
prefixSurname (string, optional):
Should be deprecated. Please use "MiddleName" instead
,
firstName (string, optional),
salutation (string, optional),
preferredFirstName (string, optional),
genderId (integer, optional),
genderName (string, optional),
email (string, optional),
mobile (string, optional),
phone (string, optional),
lastUpdateDateUtc (string, optional),
agencyContactPersonGuid (string, optional),
isOwner (boolean, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"entityStateName": "string",
"lastName": "string",
"surname": "string",
"middleName": "string",
"prefixSurname": "string",
"firstName": "string",
"salutation": "string",
"preferredFirstName": "string",
"genderId": 0,
"genderName": "string",
"email": "string",
"mobile": "string",
"phone": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.285Z",
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"isOwner": true
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type agencyGuid
GUID of agency
query string contactPersonGuid
GUID of agency contact person
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Agency or Contact person with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /API/AGENCIES/{AGENCYGUID}/CONTACTPERSONS/{CONTACTPERSONGUID}
* Agency Contact Persons Update
IMPLEMENTATION NOTES
Updating contact persons for agency via JSON Patch standart.
PARAMETERS
Parameter Value Description Parameter Type Data Type agencyGuid
Guid of Agency
path string contactPersonGuid
Guid of Contact Person
path string request
Parameter content type: application/json
Supported operations: add, replace, copy, move, remove
body
* Model
* Example Value
JsonPatchDocument[AgencyContactPersonUpdateRequest] {
operations (Array[Operation[AgencyContactPersonUpdateRequest]], optional,
read only)
}
Operation[AgencyContactPersonUpdateRequest] {
value (object, optional):
The new property value
,
path (string, optional):
Property name. Should start with “/”
,
op (string, optional):
The patch operations supported by JSON Patch are “add”, “remove”,
“replace”, “move” and “copy”. The operations are applied in order: if any
of them fail then the whole patch operation should abort.
,
from (string, optional):
Using with Move operation
}
[
{
"value": "new value",
"path": "/FirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/PreferredFirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/MiddleName",
"op": "replace"
},
{
"value": "new value",
"path": "/PrefixSurname",
"op": "replace"
},
{
"value": "new value",
"path": "/LastName",
"op": "replace"
},
{
"value": "new value",
"path": "/Surname",
"op": "replace"
},
{
"value": "new value",
"path": "/Salutation",
"op": "replace"
},
{
"value": "new value",
"path": "/GenderId",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/Mobile",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/AgencyContactPersonGuid",
"op": "replace"
}
]
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Contact persons for agency has been successfully updated
400
BadRequest
401
Unauthorized
404
Agency or contact person with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* APPLICATIONS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/APPLICATIONS
* List Applications
IMPLEMENTATION NOTES
Returns applications for Agency
RESPONSE CLASS (STATUS 200)
Returns list items of applications
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
agencyGuid (string, optional),
jobGuid (string, optional),
candidateGuid (string, optional),
employerGuid (string, optional),
firstName (string, optional),
prefixSurname (string, optional),
surName (string, optional),
email (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
createdDateUtc (string, optional),
lastUpdateDateUtc (string, optional),
source (string, optional),
rating (number, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"jobGuid": "00000000-0000-0000-0000-000000000000",
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"employerGuid": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"prefixSurname": "string",
"surName": "string",
"email": "string",
"entityStateId": 0,
"entityStateName": "string",
"createdDateUtc": "2024-06-13T09:50:13.293Z",
"lastUpdateDateUtc": "2024-06-13T09:50:13.293Z",
"source": "string",
"rating": 0
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type whatSearch
Job title or applicant name or applicant email or source. You can enter a
string with max length 128 chars , Max. length : 128
query string jobGuids
Guid collection for Jobs of Application. You can enter a comma separated
list of values.
query Array[string] agencyGuids
Guid collection for Agencies of Job. You can enter a comma separated list
of values.
query Array[string] employerGuids
Guid collection for Employers of Job. You can enter a comma separated
list of values.
query Array[string] candidateGuids
Guid collection for Candidates of Application. You can enter a comma
separated list of values.
query Array[string] entityStateIds
Integer collection for State of Application. For getting available number
you can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET. You can enter a comma separated list of
values.
query Array[integer] lastUpdateFrom
DateTime value. Get application from last updated date.
query date-time lastUpdateTo
DateTime value. Get application to last updated date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/APPLICATIONS
* Application Registration
IMPLEMENTATION NOTES
Register application
RESPONSE CLASS (STATUS 201)
Registered succesfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json
body
* Model
* Example Value
ApplicationAddRequest {
jobGuid (string):
GUID of active public job
,
firstName (string):
Max. length : 128
,
prefix (string, optional):
Max. length : 64
,
lastName (string):
Max. length : 128
,
email (string):
Should be a valid email : , Max. length : 128
,
phone (string, optional):
Phone format: +XX-XXX-XXX-XXXX, Max. length : 32
,
skype (string, optional):
Max. length : 128
,
message (string, optional):
Max. length : 20000
,
genderId (integer, optional):
Integer for GenderId of Applicant. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET . You can enter a value: Male - 1, Female - 2,
NotSpecified - 3
,
birthDate (string, optional):
Min. value : 13 years
,
acceptPrivacyStatement (boolean, optional),
allowUseDataForOtherJobs (boolean, optional),
sourceJobBoardInstanceGuid (string, optional),
source (string, optional):
The domain of the referrer site that linked to the job page, Max. length
: 100
,
documents (Array[ApplicationAddRequestDocument], optional)
}
ApplicationAddRequestDocument {
name (string):
Max. length : 256
,
extension (string):
Max. length : 8
,
base64Data (string),
bytesData (string, optional)
}
{
"jobGuid": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"prefix": "string",
"lastName": "string",
"email": "string",
"phone": "string",
"skype": "string",
"message": "string",
"genderId": 0,
"birthDate": "2024-06-13T09:50:13.302Z",
"acceptPrivacyStatement": true,
"allowUseDataForOtherJobs": true,
"sourceJobBoardInstanceGuid": "00000000-0000-0000-0000-000000000000",
"source": "string",
"documents": [
{
"name": "string",
"extension": "string",
"base64Data": "string",
"bytesData": "string"
}
]
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/APPLICATIONS/{APPLICATIONGUID}
* Application Detail
IMPLEMENTATION NOTES
Returns application detail by Id
RESPONSE CLASS (STATUS 200)
Returns application detail
* Model
* Example Value
ApplicationDetailsResponse {
guid (string, optional),
agencyGuid (string, optional),
jobGuid (string, optional),
candidateGuid (string, optional),
employerGuid (string, optional),
firstName (string, optional),
prefixSurname (string, optional),
surName (string, optional),
email (string, optional),
mobile (string, optional),
skype (string, optional),
dateOfBirth (string, optional),
genderId (integer, optional),
genderName (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
createdDateUtc (string, optional),
lastUpdateDateUtc (string, optional),
educationLevelId (integer, optional),
educationLevelName (string, optional),
educationName (string, optional),
educationMonthFrom (integer, optional),
educationYearFrom (integer, optional),
educationMonthTo (integer, optional),
educationYearTo (integer, optional),
lastJobTitle (string, optional),
lastJobEmployerName (string, optional),
lastJobMonthFrom (integer, optional),
lastJobYearFrom (integer, optional),
lastJobMonthTo (integer, optional),
lastJobYearTo (integer, optional),
lastJobExperienceLevelId (integer, optional),
lastJobExperienceLevelName (string, optional),
acceptPrivacyStatement (boolean, optional),
allowUseDataForOtherJobs (boolean, optional),
source (string, optional),
rating (number, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"jobGuid": "00000000-0000-0000-0000-000000000000",
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"employerGuid": "00000000-0000-0000-0000-000000000000",
"firstName": "string",
"prefixSurname": "string",
"surName": "string",
"email": "string",
"mobile": "string",
"skype": "string",
"dateOfBirth": "2024-06-13T09:50:13.305Z",
"genderId": 0,
"genderName": "string",
"entityStateId": 0,
"entityStateName": "string",
"createdDateUtc": "2024-06-13T09:50:13.305Z",
"lastUpdateDateUtc": "2024-06-13T09:50:13.305Z",
"educationLevelId": 0,
"educationLevelName": "string",
"educationName": "string",
"educationMonthFrom": 0,
"educationYearFrom": 0,
"educationMonthTo": 0,
"educationYearTo": 0,
"lastJobTitle": "string",
"lastJobEmployerName": "string",
"lastJobMonthFrom": 0,
"lastJobYearFrom": 0,
"lastJobMonthTo": 0,
"lastJobYearTo": 0,
"lastJobExperienceLevelId": 0,
"lastJobExperienceLevelName": "string",
"acceptPrivacyStatement": true,
"allowUseDataForOtherJobs": true,
"source": "string",
"rating": 0
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type applicationGuid
Guid of Application
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Application with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /API/APPLICATIONS/{APPLICATIONGUID}
* Applications Update
IMPLEMENTATION NOTES
Updating entity application via JSON Patch standart.
PARAMETERS
Parameter Value Description Parameter Type Data Type applicationGuid
Guid of Application
path string request
Parameter content type: application/json
Integer collection for State of Application. For getting available number
you can find appropriate type at api / domainTypes GET and use it to find
values at api / domainValues GET.You can enter a comma separated list of
values.
body
* Model
* Example Value
JsonPatchDocument[ApplicationUpdateRequest] {
operations (Array[Operation[ApplicationUpdateRequest]], optional, read
only)
}
Operation[ApplicationUpdateRequest] {
value (object, optional):
The new property value
,
path (string, optional):
Property name. Should start with “/”
,
op (string, optional):
The patch operations supported by JSON Patch are “add”, “remove”,
“replace”, “move” and “copy”. The operations are applied in order: if any
of them fail then the whole patch operation should abort.
,
from (string, optional):
Using with Move operation
}
[
{
"value": "new value",
"path": "/EntityStateId",
"op": "replace"
}
]
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Application has been successfully updated
400
BadRequest
401
Unauthorized
404
Application with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CANDIDATES
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /API/CANDIDATES/{CANDIDATEGUID}/ADDRESSES/{ADDRESSTYPEID}
* Delete candidate Address
IMPLEMENTATION NOTES
Deleting address of candidate
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string addressTypeId
Address type of Candidate. For getting available number you should GET
api/candidates/{candidateGuid}/addresses/
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Candidate address has been successfully updated
400
BadRequest
401
Unauthorized
404
Candidate with specified GUID or address type was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CANDIDATES/{CANDIDATEGUID}/ADDRESSES/{ADDRESSTYPEID}
* Candidate Address Detail
IMPLEMENTATION NOTES
Returns address of candidate by guid and address type
RESPONSE CLASS (STATUS 200)
Returns candidate address details
* Model
* Example Value
AddressResponse {
addressTypeId (integer, optional),
addressTypeName (string, optional),
fullAddress (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
postalCode (string, optional),
city (string, optional),
country (string, optional)
}
{
"addressTypeId": 0,
"addressTypeName": "string",
"fullAddress": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string addressTypeId
Address type of Candidate. For getting available number you should GET
api/candidates/{candidateGuid}/addresses/
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Candidate with specified GUID or address type was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CANDIDATES/{CANDIDATEGUID}/ADDRESSES/{ADDRESSTYPEID}
* Create Candidate address
IMPLEMENTATION NOTES
Creation address of candidate
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string addressTypeId
Address type of Candidate. You can find possible values at GET
api/domainTypes/947/domainValues
path integer request
Parameter content type: application/json
body
* Model
* Example Value
UserAddressAddRequest {
street (string):
Max. length : 256
,
number (string):
Max. length : 16
,
unit (string, optional):
Max. length : 32
,
postalCode (string):
Max. length : 16
,
city (string):
Max. length : 256
,
countryId (integer):
Integer for CountryId. For getting available number you can find
appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
}
{
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"countryId": 0
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Created succesfully
Location Url to created or updated entity
400
BadRequest
401
Unauthorized
404
Candidate with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /API/CANDIDATES/{CANDIDATEGUID}/ADDRESSES/{ADDRESSTYPEID}
* Candidate Address Update
IMPLEMENTATION NOTES
Updating address of candidate
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string addressTypeId
Address type of Candidate. For getting available number you should GET
api/candidates/{candidateGuid}/addresses/
path integer request
Parameter content type: application/json
body
* Model
* Example Value
UserAddressUpdateRequest {
street (string):
Max. length : 256
,
number (string):
Max. length : 16
,
unit (string, optional):
Max. length : 32
,
postalCode (string):
Max. length : 16
,
city (string):
Max. length : 256
,
countryId (integer):
Integer for CountryId of Candidate. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
}
{
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"countryId": 0
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Candidate address has been successfully updated
400
BadRequest
401
Unauthorized
404
Candidate with specified GUID or address type was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CANDIDATES/{CANDIDATEGUID}/PENSIONSCHEMES
* List Candidate Pension Schemes
IMPLEMENTATION NOTES
Returns pension schemes of candidate
RESPONSE CLASS (STATUS 200)
Returns list items of candidate pension schemes
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
agencyGuid (string, optional),
agencyName (string, optional),
candidateGuid (string, optional),
candidateFormattedName (string, optional),
year (integer, optional),
week (integer, optional),
pensionSchemeName (string, optional),
pensionSchemeHRXML (string, optional),
numberOfWeeksWorked (integer, optional),
numberOfWeeksBreak (integer, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"candidateFormattedName": "string",
"year": 0,
"week": 0,
"pensionSchemeName": "string",
"pensionSchemeHRXML": "string",
"numberOfWeeksWorked": 0,
"numberOfWeeksBreak": 0
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
GUID of candidate
query string skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Candidate with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CANDIDATES/{CANDIDATEGUID}/PENSIONSCHEMES
* Creation Candidate Pension Scheme
IMPLEMENTATION NOTES
Creation pension scheme of candidate
RESPONSE CLASS (STATUS 201)
Created successfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid path
string request
Parameter content type: application/json
body
* Model
* Example Value
PensionSchemeAddRequest {
agencyGuid (string):
Should be Agency with an active model matrix available
,
year (integer),
week (integer):
Min. value : 1, Max. value : 53
,
pensionSchemeId (integer):
Pension scheme Id (Pension step Id). For getting available ids see at
/docs/index#!/DomainValues/DomainValues_Get_0, with domainValueTypeId =
919 and isActive = true
,
numberOfWeeksWorked (integer, optional):
Min. value : 0, Max. value : 999999999
,
numberOfWeeksBreak (integer, optional):
Min. value : 0, Max. value : 999999999
}
{
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"year": 0,
"week": 0,
"pensionSchemeId": 0,
"numberOfWeeksWorked": 0,
"numberOfWeeksBreak": 0
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Candidate with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /API/CANDIDATES/{CANDIDATEGUID}/PENSIONSCHEMES/{GUID}
* Delete candidate Pension Scheme
IMPLEMENTATION NOTES
Deleting pension scheme of candidate
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string guid
Guid of Candidate
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Candidate pension scheme has been successfully deleted
400
Pension scheme year less than current processing year
401
Unauthorized
404
Candidate or pension scheme with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /API/CANDIDATES/{CANDIDATEGUID}/PENSIONSCHEMES/{GUID}
* Candidate Pension Scheme Update
IMPLEMENTATION NOTES
Updating pension scheme of candidate via JSON Patch standart.
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string guid
Guid of Candidate
path string request
Parameter content type: application/json
Supported operations: add, replace, copy, move, remove
body
* Model
* Example Value
JsonPatchDocument[PensionSchemeUpdateRequest] {
operations (Array[Operation[PensionSchemeUpdateRequest]], optional, read
only)
}
Operation[PensionSchemeUpdateRequest] {
value (object, optional):
The new property value
,
path (string, optional):
Property name. Should start with “/”
,
op (string, optional):
The patch operations supported by JSON Patch are “add”, “remove”,
“replace”, “move” and “copy”. The operations are applied in order: if any
of them fail then the whole patch operation should abort.
,
from (string, optional):
Using with Move operation
}
[
{
"value": "new value",
"path": "/AgencyGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/Year",
"op": "replace"
},
{
"value": "new value",
"path": "/Week",
"op": "replace"
},
{
"value": "new value",
"path": "/PensionSchemeId",
"op": "replace"
},
{
"value": "new value",
"path": "/NumberOfWeeksWorked",
"op": "replace"
},
{
"value": "new value",
"path": "/NumberOfWeeksBreak",
"op": "replace"
}
]
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Pension scheme of candidate has been successfully updated
400
BadRequest
401
Unauthorized
404
Candidate or pension scheme with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CANDIDATES/{CANDIDATEGUID}/BANKACCOUNTS
* List Candidate Bank Accounts
IMPLEMENTATION NOTES
Returns bank accounts of candidate
RESPONSE CLASS (STATUS 200)
Returns list items of candidate bank accounts
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
candidateGuid (string, optional),
bankAccountNumber (string, optional),
accountHolderName (string, optional),
accountHolderCity (string, optional),
biccode (string, optional)
}
[
{
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"bankAccountNumber": "string",
"accountHolderName": "string",
"accountHolderCity": "string",
"biccode": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
GUID of candidate
query string skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CANDIDATES/{CANDIDATEGUID}/BANKACCOUNTS
* Creation Candidate Bank Account
IMPLEMENTATION NOTES
Creation bank account of candidate
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid path
string request
Parameter content type: application/json
body
* Model
* Example Value
BankAccountAddRequest {
bankAccountNumber (string):
Max. length : 35, Should be a valid IBAN :
,
accountHolderName (string):
Max. length : 50
,
accountHolderCity (string):
Max. length : 50
,
biccode (string, optional):
If BankAccountNumber is not NL — Biccode field is required, Max. length :
35, Should be a BIC code :
}
{
"bankAccountNumber": "string",
"accountHolderName": "string",
"accountHolderCity": "string",
"biccode": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
Created succesfully
Location Url to created or updated entity
400
BadRequest
401
Unauthorized
404
Candidate with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CANDIDATES/{CANDIDATEGUID}/BANKACCOUNTS/{BANKACCOUNTNUMBER}
* Candidate Bank Account Detail
IMPLEMENTATION NOTES
Returns bank account of candidate by guid and bank account number
RESPONSE CLASS (STATUS 200)
Returns candidate details
* Model
* Example Value
BankAccountDetailsResponse {
candidateGuid (string, optional),
bankAccountNumber (string, optional),
accountHolderName (string, optional),
accountHolderCity (string, optional),
biccode (string, optional)
}
{
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"bankAccountNumber": "string",
"accountHolderName": "string",
"accountHolderCity": "string",
"biccode": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
GUID of candidate
query string bankAccountNumber
Bank account number of candidate, Max. length : 35, Should be a valid
IBAN :
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Candidate with specified GUID or bank account number was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /API/CANDIDATES/{CANDIDATEGUID}/BANKACCOUNTS/{BANKACCOUNTNUMBER}
* Candidate Bank Accounts Update
IMPLEMENTATION NOTES
Updating bank accounts of candidate
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string bankAccountNumber
Bank account number of Candidate
path string request
Parameter content type: application/json
body
* Model
* Example Value
BankAccountUpdateRequest {
accountHolderName (string):
Max. length : 50
,
accountHolderCity (string):
Max. length : 50
,
biccode (string, optional):
If BankAccountNumber is not NL — Biccode field is required, Max. length :
35, Should be a BIC code :
}
{
"accountHolderName": "string",
"accountHolderCity": "string",
"biccode": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Candidate bank account has been successfully updated
400
BadRequest
401
Unauthorized
404
Candidate with specified GUID or bank account number was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CANDIDATES
* List Candidates
IMPLEMENTATION NOTES
Returns candidates for Customer
RESPONSE CLASS (STATUS 200)
Returns list items of candidates
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
userId (integer, optional),
formattedName (string, optional),
email (string, optional),
agencyGuid (string, optional),
agencyName (string, optional),
contactPersonGuid (string, optional),
contactPersonFormattedName (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
countryId (integer, optional),
countryName (string, optional),
city (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
postalCode (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"userId": 0,
"formattedName": "string",
"email": "string",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"contactPersonFormattedName": "string",
"entityStateId": 0,
"entityStateName": "string",
"countryId": 0,
"countryName": "string",
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type entityStateIds
Integer collection for State of Candidate. For getting available number
you can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET. You can enter a comma separated list of
values.
query Array[integer] agencyGuids
Guid collection for Agencies of Candidate. You can enter a comma
separated list of values.
query Array[string] search
String value for search by candidate name and email., Max. length : 128
query string lastUpdateDateUtcFrom
DateTime value. Get candidates from last updated date.
query date-time lastUpdateDateUtcTo
DateTime value. Get candidates to last updated date.
query date-time tagIds
Integer collection for TagIds of Candidate. You can enter a comma
separated list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CANDIDATES
* Candidate Registration
IMPLEMENTATION NOTES
Register candidates
RESPONSE CLASS (STATUS 201)
Registered succesfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json
body
* Model
* Example Value
CandidateAddRequest {
guid (string, optional):
Guid of new candidate
,
agencyGuid (string):
You can input just active agencies
,
typeId (integer, optional):
Integer for TypeId of Candidate. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
,
contactPersonGuid (string, optional),
statusId (integer, optional):
Integer for status of Candidate. You can enter a value: To be activated
- 1, Activating - 2, Registering - 3 DEPRECATED. Registering status is
not used anymore.
,
firstName (string):
Max. length : 64
,
preferredFirstName (string, optional):
Max. length : 64
,
lastName (string):
Max. length : 64
,
middleName (string, optional):
Max. length : 32
,
birthName (string, optional):
Max. length : 64
,
initials (string, optional):
Max. length : 32
,
title (string, optional):
Max. length : 32
,
salutation (string, optional):
Max. length : 32
,
nationalityId (integer, optional):
Integer for NationalityId of Candidate. For getting available number you
can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET
,
genderId (integer, optional):
Integer for GenderId of Candidate. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET . You can enter a value: Male - 1, Female - 2,
NotSpecified - 3
,
birthDate (string, optional),
maritalStateId (integer, optional):
Integer for MaritalStateId of Candidate. For getting available number you
can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET
,
email (string):
Should be a valid email : , Max. length : 128
,
phone (string, optional):
Max. length : 32
,
mobile (string, optional):
Max. length : 32
,
skype (string, optional):
Max. length : 128
,
bankAccountNumber (string, optional):
DEPRECATED. You have to use 'api/candidates/{candidateGuid}/bankaccounts'
instead, Should be a valid IBAN : , Max. length : 64
,
bankAccountName (string, optional):
DEPRECATED. You have to use 'api/candidates/{candidateGuid}/bankaccounts'
instead, Max. length : 64
,
documentTypeId (integer, optional):
Integer for DocumentTypeId of Candidate. For getting available number you
can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET
,
documentNumber (string, optional):
Max. length : 32
,
documentEndDate (string, optional),
documentIssuingCountryId (integer, optional):
Integer for CountryId of Candidate. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
,
ssn (string, optional),
taxReduction (boolean, optional):
Boolean for TaxReduction of Candidate. You can enter a value: true or
false
,
singleElderlyPersonsTaxCreditApplied (boolean, optional):
Boolean for SingleElderlyPersonsTaxCreditApplied of Candidate. You can
enter a value: true or false. This value cannot be true when
'TaxReduction' is not true
,
taxReductionStartDate (string, optional),
taxReductionStatementDate (string, optional),
candidatePaymentFrequencyId (integer, optional):
Integer for PaymentFrequencyId of Candidate. For getting available number
you can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET
,
countryId (integer, optional):
Integer for CountryId of Candidate. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
,
city (string, optional):
Max. length : 256
,
street (string, optional):
Max. length : 256
,
number (string, optional):
Max. length : 16
,
unit (string, optional):
Max. length : 32
,
postalCode (string, optional):
Max. length : 16
,
registrationDate (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"typeId": 0,
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"statusId": 0,
"firstName": "string",
"preferredFirstName": "string",
"lastName": "string",
"middleName": "string",
"birthName": "string",
"initials": "string",
"title": "string",
"salutation": "string",
"nationalityId": 0,
"genderId": 0,
"birthDate": "2024-06-13T09:50:13.348Z",
"maritalStateId": 0,
"email": "string",
"phone": "string",
"mobile": "string",
"skype": "string",
"bankAccountNumber": "string",
"bankAccountName": "string",
"documentTypeId": 0,
"documentNumber": "string",
"documentEndDate": "2024-06-13T09:50:13.348Z",
"documentIssuingCountryId": 0,
"ssn": "string",
"taxReduction": true,
"singleElderlyPersonsTaxCreditApplied": true,
"taxReductionStartDate": "2024-06-13T09:50:13.348Z",
"taxReductionStatementDate": "2024-06-13T09:50:13.348Z",
"candidatePaymentFrequencyId": 0,
"countryId": 0,
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"registrationDate": "2024-06-13T09:50:13.348Z"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CANDIDATES/{CANDIDATEGUID}
* Candidate Detail
IMPLEMENTATION NOTES
Returns candidate for Customer by guid
RESPONSE CLASS (STATUS 200)
Returns candidate details
* Model
* Example Value
CandidateDetailsResponse {
candidateGuid (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
agencyGuid (string, optional),
agencyName (string, optional),
userId (integer, optional),
firstName (string, optional),
preferredFirstName (string, optional),
lastName (string, optional),
middleName (string, optional),
birthName (string, optional),
initials (string, optional),
title (string, optional),
formattedName (string, optional),
salutation (string, optional),
nationalityId (integer, optional),
nationalityName (string, optional),
genderId (integer, optional),
genderName (string, optional),
birthDate (string, optional),
maritalStateId (integer, optional),
maritalStateName (string, optional),
phone (string, optional),
mobile (string, optional),
bankAccountNumber (string, optional),
bankAccountName (string, optional),
bankAccountMunicipality (string, optional),
documentTypeId (integer, optional),
documentTypeName (string, optional),
documentNumber (string, optional),
documentEndDate (string, optional),
documentIssuingCountryId (integer, optional),
documentIssuingCountryName (string, optional),
registrationDate (string, optional),
documentGuid (string, optional),
hasPhoto (boolean, optional),
taxReduction (boolean, optional),
singleElderlyPersonsTaxCreditApplied (boolean, optional),
taxReductionStartDate (string, optional),
taxReductionStatementDate (string, optional),
candidatePaymentFrequencyId (integer, optional),
candidatePaymentFrequencyName (string, optional),
externalStatusName (string, optional),
email (string, optional),
countryId (integer, optional),
countryName (string, optional),
city (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
postalCode (string, optional),
typeId (integer, optional),
typeName (string, optional),
candidateTypeId (integer, optional),
candidateTypeName (string, optional),
contactPersonGuid (string, optional),
contactPersonFormattedName (string, optional),
lastUpdateDateUtc (string, optional),
lastWorked (string, optional),
candidateNumber (string, optional),
hasActiveIllness (boolean, optional)
}
{
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"entityStateName": "string",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"userId": 0,
"firstName": "string",
"preferredFirstName": "string",
"lastName": "string",
"middleName": "string",
"birthName": "string",
"initials": "string",
"title": "string",
"formattedName": "string",
"salutation": "string",
"nationalityId": 0,
"nationalityName": "string",
"genderId": 0,
"genderName": "string",
"birthDate": "2024-06-13T09:50:13.351Z",
"maritalStateId": 0,
"maritalStateName": "string",
"phone": "string",
"mobile": "string",
"bankAccountNumber": "string",
"bankAccountName": "string",
"bankAccountMunicipality": "string",
"documentTypeId": 0,
"documentTypeName": "string",
"documentNumber": "string",
"documentEndDate": "2024-06-13T09:50:13.351Z",
"documentIssuingCountryId": 0,
"documentIssuingCountryName": "string",
"registrationDate": "2024-06-13T09:50:13.351Z",
"documentGuid": "00000000-0000-0000-0000-000000000000",
"hasPhoto": true,
"taxReduction": true,
"singleElderlyPersonsTaxCreditApplied": true,
"taxReductionStartDate": "2024-06-13T09:50:13.351Z",
"taxReductionStatementDate": "2024-06-13T09:50:13.351Z",
"candidatePaymentFrequencyId": 0,
"candidatePaymentFrequencyName": "string",
"externalStatusName": "string",
"email": "string",
"countryId": 0,
"countryName": "string",
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"typeId": 0,
"typeName": "string",
"candidateTypeId": 0,
"candidateTypeName": "string",
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"contactPersonFormattedName": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.351Z",
"lastWorked": "2024-06-13T09:50:13.351Z",
"candidateNumber": "string",
"hasActiveIllness": true
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Candidate with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /API/CANDIDATES/{CANDIDATEGUID}
* Candidates Update
IMPLEMENTATION NOTES
For Updating Entity Candidates HTTP header for the message should always
contain parameters 'op' and 'path' and optionally 'value' and 'from'.
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
Guid of Candidate
path string request
Parameter content type: application/json
Supported operations: add, replace, copy, move, remove
body
* Model
* Example Value
JsonPatchDocument[CandidateUpdateRequest] {
operations (Array[Operation[CandidateUpdateRequest]], optional, read
only)
}
Operation[CandidateUpdateRequest] {
value (object, optional):
The new property value
,
path (string, optional):
Property name. Should start with “/”
,
op (string, optional):
The patch operations supported by JSON Patch are “add”, “remove”,
“replace”, “move” and “copy”. The operations are applied in order: if any
of them fail then the whole patch operation should abort.
,
from (string, optional):
Using with Move operation
}
[
{
"value": "new value",
"path": "/TypeId",
"op": "replace"
},
{
"value": "new value",
"path": "/FirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/PreferredFirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/LastName",
"op": "replace"
},
{
"value": "new value",
"path": "/MiddleName",
"op": "replace"
},
{
"value": "new value",
"path": "/BirthName",
"op": "replace"
},
{
"value": "new value",
"path": "/Initials",
"op": "replace"
},
{
"value": "new value",
"path": "/Title",
"op": "replace"
},
{
"value": "new value",
"path": "/Salutation",
"op": "replace"
},
{
"value": "new value",
"path": "/NationalityId",
"op": "replace"
},
{
"value": "new value",
"path": "/GenderId",
"op": "replace"
},
{
"value": "new value",
"path": "/BirthDate",
"op": "replace"
},
{
"value": "new value",
"path": "/MaritalStateId",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/Mobile",
"op": "replace"
},
{
"value": "new value",
"path": "/Skype",
"op": "replace"
},
{
"value": "new value",
"path": "/BankAccountNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/BankAccountName",
"op": "replace"
},
{
"value": "new value",
"path": "/DocumentTypeId",
"op": "replace"
},
{
"value": "new value",
"path": "/DocumentNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/DocumentEndDate",
"op": "replace"
},
{
"value": "new value",
"path": "/DocumentIssuingCountryId",
"op": "replace"
},
{
"value": "new value",
"path": "/Ssn",
"op": "replace"
},
{
"value": "new value",
"path": "/TaxReduction",
"op": "replace"
},
{
"value": "new value",
"path": "/SingleElderlyPersonsTaxCreditApplied",
"op": "replace"
},
{
"value": "new value",
"path": "/TaxReductionStartDate",
"op": "replace"
},
{
"value": "new value",
"path": "/TaxReductionStatementDate",
"op": "replace"
},
{
"value": "new value",
"path": "/CandidatePaymentFrequencyId",
"op": "replace"
},
{
"value": "new value",
"path": "/CountryId",
"op": "replace"
},
{
"value": "new value",
"path": "/City",
"op": "replace"
},
{
"value": "new value",
"path": "/Street",
"op": "replace"
},
{
"value": "new value",
"path": "/Number",
"op": "replace"
},
{
"value": "new value",
"path": "/Unit",
"op": "replace"
},
{
"value": "new value",
"path": "/PostalCode",
"op": "replace"
},
{
"value": "new value",
"path": "/ContactPersonGuid",
"op": "replace"
}
]
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Candidate has been successfully updated
400
BadRequest
401
Unauthorized
404
Candidate with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CANDIDATES/{CANDIDATEGUID}/ADDRESSES
* List Candidate Addresses
IMPLEMENTATION NOTES
Returns addresses of candidate
RESPONSE CLASS (STATUS 200)
Returns list items of candidate addresses
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
addressTypeId (integer, optional),
addressTypeName (string, optional),
fullAddress (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
postalCode (string, optional),
city (string, optional),
country (string, optional)
}
[
{
"addressTypeId": 0,
"addressTypeName": "string",
"fullAddress": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type candidateGuid
GUID of candidate
query string skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CAOINSTANCES
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/CAOINSTANCES/{ID}
* CAOInstance Detail
IMPLEMENTATION NOTES
Returns CAOInstance detail by id
RESPONSE CLASS (STATUS 200)
Returns CAOInstance detail
* Model
* Example Value
CaoInstanceDetailsResponse {
id (integer, optional),
caoId (integer, optional),
caoName (string, optional),
caoFormalName (string, optional),
payrollCode (integer, optional),
payrollName (string, optional),
sbiCode (string, optional),
sbiName (string, optional),
caoType (string, optional),
effectiveDate (string, optional),
expirationDate (string, optional),
avvEffectiveDate (string, optional),
avvExpirationDate (string, optional),
workWeekHours (number, optional),
advPercent (number, optional),
advDays (number, optional),
news (Array[CaoInstanceDetailsResponseNews], optional),
wageChanges (Array[CaoInstanceDetailsResponseWageChange], optional),
caoDocuments (Array[CaoInstanceDetailsResponseDocument], optional),
avvDocuments (Array[CaoInstanceDetailsResponseDocument], optional)
}
CaoInstanceDetailsResponseNews {
id (integer, optional),
publishedTime (string, optional),
title (string, optional),
caos (Array[CaoNewsRefItem], optional)
}
CaoInstanceDetailsResponseWageChange {
id (integer, optional),
effectiveDate (string, optional),
category (string, optional),
increasePercent (number, optional),
increaseAmount (number, optional),
sourceName (string, optional),
sourceUrl (string, optional)
}
CaoInstanceDetailsResponseDocument {
id (integer, optional),
name (string, optional),
downloadUrl (string, optional)
}
CaoNewsRefItem {
id (integer, optional),
name (string, optional),
payrollCode (integer, optional),
payrollName (string, optional)
}
{
"id": 0,
"caoId": 0,
"caoName": "string",
"caoFormalName": "string",
"payrollCode": 0,
"payrollName": "string",
"sbiCode": "string",
"sbiName": "string",
"caoType": "string",
"effectiveDate": "2024-06-13T09:50:13.360Z",
"expirationDate": "2024-06-13T09:50:13.360Z",
"avvEffectiveDate": "2024-06-13T09:50:13.360Z",
"avvExpirationDate": "2024-06-13T09:50:13.360Z",
"workWeekHours": 0,
"advPercent": 0,
"advDays": 0,
"news": [
{
"id": 0,
"publishedTime": "2024-06-13T09:50:13.360Z",
"title": "string",
"caos": [
{
"id": 0,
"name": "string",
"payrollCode": 0,
"payrollName": "string"
}
]
}
],
"wageChanges": [
{
"id": 0,
"effectiveDate": "2024-06-13T09:50:13.360Z",
"category": "string",
"increasePercent": 0,
"increaseAmount": 0,
"sourceName": "string",
"sourceUrl": "string"
}
],
"caoDocuments": [
{
"id": 0,
"name": "string",
"downloadUrl": "string"
}
],
"avvDocuments": [
{
"id": 0,
"name": "string",
"downloadUrl": "string"
}
]
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
Id of CAOInstance
path integer isNewsIncluded true false
Boolean value which determines to include news to CAOInstance detail
response. The default is false.
query boolean isWageChangesIncluded true false
Boolean value which determines to include wage changes to CAOInstance
detail response. The default is false.
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
CAOInstance was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CAOINSTANCES
* List CAOInstances
IMPLEMENTATION NOTES
Returns CAOInstances
RESPONSE CLASS (STATUS 200)
Returns list items of CAOInstances
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
caoId (integer, optional),
caoName (string, optional),
payrollCode (integer, optional),
payrollName (string, optional),
effectiveDate (string, optional),
expirationDate (string, optional),
sbiCode (string, optional),
sbiCodeName (string, optional)
}
[
{
"id": 0,
"caoId": 0,
"caoName": "string",
"payrollCode": 0,
"payrollName": "string",
"effectiveDate": "2024-06-13T09:50:13.363Z",
"expirationDate": "2024-06-13T09:50:13.363Z",
"sbiCode": "string",
"sbiCodeName": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type caoFirstLetter
First leter of CAO name. You can enter a single char.
query string sbiCode
SBI Code of CAO. You can enter string value.
query string isActualOnly true false
Boolean value which determines only actual CAOInstances. The default is
false.
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CAONEWS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/CAONEWS/{ID}
* CAONews Detail
IMPLEMENTATION NOTES
Returns CAONews by id
RESPONSE CLASS (STATUS 200)
Returns CAONews detail
* Model
* Example Value
CaoNewsDetailsResponse {
id (integer, optional),
publishedTime (string, optional),
title (string, optional),
sourceName (string, optional),
sourceUrl (string, optional),
caos (Array[CaoNewsDetailsResponseItem], optional),
documents (Array[CaoInstanceDetailsResponseDocument], optional),
text (string, optional)
}
CaoNewsDetailsResponseItem {
id (integer, optional),
name (string, optional),
relatedCaoInstanceId (integer, optional),
payrollCode (integer, optional),
payrollName (string, optional)
}
CaoInstanceDetailsResponseDocument {
id (integer, optional),
name (string, optional),
downloadUrl (string, optional)
}
{
"id": 0,
"publishedTime": "2024-06-13T09:50:13.366Z",
"title": "string",
"sourceName": "string",
"sourceUrl": "string",
"caos": [
{
"id": 0,
"name": "string",
"relatedCaoInstanceId": 0,
"payrollCode": 0,
"payrollName": "string"
}
],
"documents": [
{
"id": 0,
"name": "string",
"downloadUrl": "string"
}
],
"text": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
Id of CAONews
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
CAONews was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CAONEWS
* List CAONews
IMPLEMENTATION NOTES
Returns CAONews
RESPONSE CLASS (STATUS 200)
Returns list items of CAONews
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
publishedTime (string, optional),
title (string, optional),
caos (Array[CaoNewsRefItem], optional)
}
CaoNewsRefItem {
id (integer, optional),
name (string, optional),
payrollCode (integer, optional),
payrollName (string, optional)
}
[
{
"id": 0,
"publishedTime": "2024-06-13T09:50:13.369Z",
"title": "string",
"caos": [
{
"id": 0,
"name": "string",
"payrollCode": 0,
"payrollName": "string"
}
]
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type skip
Quantity items to skip, Min. value : 0
query integer take
Quantity items to take on the page, Min. value : 1
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CAOWAGES
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/CAOWAGES
* List CAOWages
IMPLEMENTATION NOTES
Returns CAOWages
RESPONSE CLASS (STATUS 200)
Returns list items of CAOWages
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
caoInstanceId (integer, optional),
caoName (string, optional),
payrollCode (integer, optional),
payrollName (string, optional),
effectiveDate (string, optional),
category (string, optional),
increasePercent (number, optional),
increaseAmount (number, optional),
source (string, optional),
sourceUrl (string, optional),
explanation (string, optional)
}
[
{
"id": 0,
"caoInstanceId": 0,
"caoName": "string",
"payrollCode": 0,
"payrollName": "string",
"effectiveDate": "2024-06-13T09:50:13.374Z",
"category": "string",
"increasePercent": 0,
"increaseAmount": 0,
"source": "string",
"sourceUrl": "string",
"explanation": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type year
Year of effective date of CAOWages. You can enter single integer value. ,
Min. value : 0
query integer monthNumber
Month number of effective date of CAOWages. You can enter single integer
value. , Min. value : 0, Max. value : 11
query integer skip
Quantity items to skip, Min. value : 0
query integer take
Quantity items to take on the page, Min. value : 1
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CONTRACTS
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /API/CONTRACTS/{CONTRACTGUID}
* Delete contract
IMPLEMENTATION NOTES
Delete draft contract
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type contractGuid
Guid of Contract
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Deleted successfully
400
BadRequest
401
Unauthorized
404
Contract with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CONTRACTS/{CONTRACTGUID}
* Contract Detail
IMPLEMENTATION NOTES
Returns contract details by Guid
RESPONSE CLASS (STATUS 200)
Returns contract details
* Model
* Example Value
ContractDetailResponse {
guid (string, optional),
number (string, optional),
jobTitle (string, optional),
caoId (integer, optional),
caoName (string, optional),
caoFunctionId (integer, optional),
caoFunctionName (string, optional),
caoFunctionGroupId (integer, optional),
caoFunctionGroupName (string, optional),
manuallyAddedCaoFunctionName (string, optional),
manuallyAddedCaoFunctionGroupName (string, optional),
createdDateUtc (string, optional),
agencyGuid (string, optional),
agencyName (string, optional),
agencyContactPersonGuid (string, optional),
agencyContactPersonName (string, optional),
employerGuid (string, optional),
employerName (string, optional),
employerContactPersonGuid (string, optional),
employerContactPersonName (string, optional),
candidateGuid (string, optional),
candidateFormattedName (string, optional),
costCenterGuid (string, optional),
costCenterName (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
contractTypeId (integer, optional),
contractTypeName (string, optional),
purchaseOrderNumber (string, optional),
targetHours (number, optional),
startDate (string, optional),
endDate (string, optional),
lastUpdateDateUtc (string, optional),
signedDateUtc (string, optional),
workAddress (WorkAddressResponse, optional),
rateClasses (Array[ContractRateClassResponse], optional)
}
WorkAddressResponse {
countryId (integer, optional),
country (string, optional),
city (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
postalCode (string, optional),
fullAddress (string, optional)
}
ContractRateClassResponse {
rateClassId (integer, optional),
rateClassName (string, optional),
rateClassTypeId (integer, optional),
rateClassTypeName (string, optional),
billAmount (number, optional),
billMultiplier (number, optional),
billBaseFactor (number, optional),
billMeasureTypeId (integer, optional),
billMeasureTypeName (string, optional),
payAmount (number, optional),
payMultiplier (number, optional),
costPriceBaseFactor (number, optional),
costPriceFactor (number, optional),
costPriceAmount (number, optional),
marginMultiplier (number, optional),
marginAmount (number, optional),
remarks (string, optional),
sourceId (integer, optional),
sourceName (string, optional),
sourceDescription (string, optional),
isAddedManualy (boolean, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"number": "string",
"jobTitle": "string",
"caoId": 0,
"caoName": "string",
"caoFunctionId": 0,
"caoFunctionName": "string",
"caoFunctionGroupId": 0,
"caoFunctionGroupName": "string",
"manuallyAddedCaoFunctionName": "string",
"manuallyAddedCaoFunctionGroupName": "string",
"createdDateUtc": "2024-06-13T09:50:13.381Z",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"agencyContactPersonName": "string",
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerName": "string",
"employerContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"employerContactPersonName": "string",
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"candidateFormattedName": "string",
"costCenterGuid": "00000000-0000-0000-0000-000000000000",
"costCenterName": "string",
"entityStateId": 0,
"entityStateName": "string",
"contractTypeId": 0,
"contractTypeName": "string",
"purchaseOrderNumber": "string",
"targetHours": 0,
"startDate": "2024-06-13T09:50:13.381Z",
"endDate": "2024-06-13T09:50:13.381Z",
"lastUpdateDateUtc": "2024-06-13T09:50:13.381Z",
"signedDateUtc": "2024-06-13T09:50:13.381Z",
"workAddress": {
"countryId": 0,
"country": "string",
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"fullAddress": "string"
},
"rateClasses": [
{
"rateClassId": 0,
"rateClassName": "string",
"rateClassTypeId": 0,
"rateClassTypeName": "string",
"billAmount": 0,
"billMultiplier": 0,
"billBaseFactor": 0,
"billMeasureTypeId": 0,
"billMeasureTypeName": "string",
"payAmount": 0,
"payMultiplier": 0,
"costPriceBaseFactor": 0,
"costPriceFactor": 0,
"costPriceAmount": 0,
"marginMultiplier": 0,
"marginAmount": 0,
"remarks": "string",
"sourceId": 0,
"sourceName": "string",
"sourceDescription": "string",
"isAddedManualy": true
}
]
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type contractGuid
Guid of Contract
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Contract with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /API/CONTRACTS/{CONTRACTGUID}
* Update contract
IMPLEMENTATION NOTES
Update draft contract
PARAMETERS
Parameter Value Description Parameter Type Data Type contractGuid
Guid of Contract
path string request
Parameter content type: application/json
Supported operations: add, replace, copy, move, remove
body
* Model
* Example Value
JsonPatchDocument[ContractUpdateRequest] {
operations (Array[Operation[ContractUpdateRequest]], optional, read only)
}
Operation[ContractUpdateRequest] {
value (object, optional):
The new property value
,
path (string, optional):
Property name. Should start with “/”
,
op (string, optional):
The patch operations supported by JSON Patch are “add”, “remove”,
“replace”, “move” and “copy”. The operations are applied in order: if any
of them fail then the whole patch operation should abort.
,
from (string, optional):
Using with Move operation
}
[
{
"value": "new value",
"path": "/BureauOrganizationGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/BureauContactPersonGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/EmployerContactPersonGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/StartDate",
"op": "replace"
},
{
"value": "new value",
"path": "/EndDate",
"op": "replace"
},
{
"value": "new value",
"path": "/CaoId",
"op": "replace"
},
{
"value": "new value",
"path": "/CaoFunctionId",
"op": "replace"
},
{
"value": "new value",
"path": "/CaoFunctionGroupId",
"op": "replace"
},
{
"value": "new value",
"path": "/JobTitle",
"op": "replace"
},
{
"value": "new value",
"path": "/CostCenterGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/PurchaseOrderNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/TargetHours",
"op": "replace"
},
{
"value": "new value",
"path": "/PayAmountRegularHours",
"op": "replace"
},
{
"value": "new value",
"path": "/BillAmountRegularHours",
"op": "replace"
},
{
"value": "new value",
"path": "/WorkAddress",
"op": "replace"
}
]
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Updated successfully
400
BadRequest
401
Unauthorized
404
Contract with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/CONTRACTS
* List Contracts
IMPLEMENTATION NOTES
Returns contracts for customer
RESPONSE CLASS (STATUS 200)
Returns list items of contracts
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
number (string, optional),
jobTitle (string, optional),
caoId (integer, optional),
caoFunctionId (integer, optional),
caoFunctionGroupId (integer, optional),
createdDateUtc (string, optional),
agencyGuid (string, optional),
agencyName (string, optional),
agencyContactPersonGuid (string, optional),
agencyContactPersonName (string, optional),
employerGuid (string, optional),
employerName (string, optional),
employerContactPersonGuid (string, optional),
employerContactPersonName (string, optional),
candidateGuid (string, optional),
candidateFormattedName (string, optional),
costCenterGuid (string, optional),
costCenterName (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
contractTypeId (integer, optional),
contractTypeName (string, optional),
purchaseOrderNumber (string, optional),
targetHours (number, optional),
startDate (string, optional),
endDate (string, optional),
lastUpdateDateUtc (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"number": "string",
"jobTitle": "string",
"caoId": 0,
"caoFunctionId": 0,
"caoFunctionGroupId": 0,
"createdDateUtc": "2024-06-13T09:50:13.391Z",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"agencyContactPersonName": "string",
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerName": "string",
"employerContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"employerContactPersonName": "string",
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"candidateFormattedName": "string",
"costCenterGuid": "00000000-0000-0000-0000-000000000000",
"costCenterName": "string",
"entityStateId": 0,
"entityStateName": "string",
"contractTypeId": 0,
"contractTypeName": "string",
"purchaseOrderNumber": "string",
"targetHours": 0,
"startDate": "2024-06-13T09:50:13.391Z",
"endDate": "2024-06-13T09:50:13.391Z",
"lastUpdateDateUtc": "2024-06-13T09:50:13.391Z"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type entityStateIds
Integer collection for State of Contract.You can enter a comma separated
list of values. ToBeSignedAgency - 110, RejectedAgency - 111,
ToBeSignedEmployer - 112, RejectedEmployer - 113, ToBeSignedCandidate -
114, RejectedCandidate - 115, Active - 167, Signed - 116, Ended - 118,
Historical - 119, Deleted - 117, Created - 220, Draft - 232, ToBeSigned -
264, ToBeSent - 380
query Array[integer] contractTypeIds
Integer collection for Type of Contract. For getting available number you
can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET. You can enter a comma separated list of
values.
query Array[integer] candidateGuids
Guid collection of Candidates. You can enter a comma separated list of
values.
query Array[string] employerGuids
Guid collection of Employers. You can enter a comma separated list of
values.
query Array[string] agencyGuids
Guid collection of Agencies. You can enter a comma separated list of
values.
query Array[string] search
String value for search by JobTitle., Max. length : 256
query string lastUpdateDateUtcFrom
DateTime value. Get contracts from last updated date.
query date-time lastUpdateDateUtcTo
DateTime value. Get contracts to last updated date.
query date-time startDateUtcFrom
DateTime value. Get contracts from start date.
query date-time startDateUtcTo
DateTime value. Get contracts to start date.
query date-time endDateUtcFrom
DateTime value. Get contracts from end date.
query date-time endDateUtcTo
DateTime value. Get contracts to end date.
query date-time includeArchived true false
Boolean value which determines archived Contract. The default is false.
query boolean includeAllVersions true false
Boolean value which determines all version of Contract. The default is
false.
query boolean skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/CONTRACTS
* Add contract
IMPLEMENTATION NOTES
Create contract
RESPONSE CLASS (STATUS 201)
Added succesfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json
body
* Model
* Example Value
ContractAddRequest {
employerGuid (string):
GUID of employer in draft or active status
,
employerContactPersonGuid (string, optional):
GUID of Employer Contact Person
,
bureauOrganizationGuid (string):
Bureau GUID
,
bureauContactPersonGuid (string, optional):
Bureau User GUID. Active and Draft entity states allowed
,
candidateGuid (string):
GUID of candidate who has active, draft, passive, registering,
registered, approved or applicant status
,
startDate (string):
Contract start date
,
endDate (string, optional):
Contract end date
,
contractTypeId (integer):
Contract Type id. For getting available ids see at
/docs/index#!/DomainValues/DomainValues_Get_0, with domainValueTypeId =
438 and isActive = true and hrXmlCode = 'P'
,
caoId (integer, optional):
Contract CAO id. For getting available number see at
/docs/index#!/WageSearch/WageSearch_GetCaos
,
caoFunctionId (integer, optional):
Contract CAO function id. For getting available number see at
/docs/index#!/WageSearch/WageSearch_GetCaoFunctions
,
caoFunctionGroupId (integer, optional):
Contract CAO function group id. For getting available number see at
/docs/index#!/WageSearch/WageSearch_GetCaoFunctionGroups
,
jobTitle (string):
Contract job title, Max. length : 256
,
costCenterGuid (string, optional):
GUID of employer cost center. For getting available number see at
/docs/index#!/Employers/{employerGuid}/CostCenters
,
purchaseOrderNumber (string, optional):
Contract purchase order number, Max. length : 128
,
targetHours (number, optional):
Contract target hours per week, Min. value : 0, Max. value : 168
,
payAmountRegularHours (number, optional):
Contract regular hours rate class Pay value, Min. value : 0, Max.
accuracy : 2 decimals
,
billAmountRegularHours (number, optional):
Contract regular hours rate class Bill value, Min. value : 0, Max.
accuracy : 2 decimals
,
workAddress (WorkAddressRequest, optional):
Work address
}
WorkAddressRequest {
countryId (integer, optional):
Integer for CountryId of Candidate. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
,
city (string, optional):
Work address city, Max. length : 256
,
street (string, optional):
Work address street, Max. length : 256
,
number (string, optional):
Work address number, Max. length : 16
,
unit (string, optional):
Work address unit, Max. length : 32
,
postalCode (string, optional):
Work address post code, Max. length : 16
}
{
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"bureauOrganizationGuid": "00000000-0000-0000-0000-000000000000",
"bureauContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"startDate": "2024-06-13T09:50:13.402Z",
"endDate": "2024-06-13T09:50:13.402Z",
"contractTypeId": 0,
"caoId": 0,
"caoFunctionId": 0,
"caoFunctionGroupId": 0,
"jobTitle": "string",
"costCenterGuid": "00000000-0000-0000-0000-000000000000",
"purchaseOrderNumber": "string",
"targetHours": 0,
"payAmountRegularHours": 0,
"billAmountRegularHours": 0,
"workAddress": {
"countryId": 0,
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DOCUMENTS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/DOCUMENTS
* List Documents
IMPLEMENTATION NOTES
Returns documents for Customer
RESPONSE CLASS (STATUS 200)
Returns list items of documents
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
title (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
documentTypeId (integer, optional),
documentTypeName (string, optional),
documentOwners (Array[DocumentOwnerResponseItem], optional),
createdDateTimeUtc (string, optional),
lastUpdatedDateTimeUtc (string, optional)
}
DocumentOwnerResponseItem {
ownerEntityTypeId (integer, optional),
ownerEntityTypeName (string, optional),
ownerGuid (string, optional),
agencyGuid (string, optional),
agencyName (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"entityStateId": 0,
"entityStateName": "string",
"documentTypeId": 0,
"documentTypeName": "string",
"documentOwners": [
{
"ownerEntityTypeId": 0,
"ownerEntityTypeName": "string",
"ownerGuid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string"
}
],
"createdDateTimeUtc": "2024-06-13T09:50:13.405Z",
"lastUpdatedDateTimeUtc": "2024-06-13T09:50:13.405Z"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type search
String value for search by document name, number, subject, contract
number(version)., Max. length : 128
query string entityTypeIds
Integer collection for EntityType of Document. You can enter a comma
separated list of values. Employer - 18, Candidate - 95.
query Array[integer] entityStateIds
Integer collection for State of Document. You can enter a comma separated
list of values. ToBeApproved - 120, Approved - 121, Rejected - 122,
Deleted - 123, ApprovedByAgency - 135, RejectedByAgency - 136, Published
- 178, ToBePublished - 14, ToBeSent - 381, Historical - 382
query Array[integer] documentTypeIds
Integer collection for Type of Document. For getting available id you can
find values at api/domainTypes/859/domainValues GET. You can enter a
comma separated list of values.
query Array[integer] ownerGuids
Guid collection for Employers or Candidates of Document.
query Array[string] skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/DOCUMENTS
* Add document
IMPLEMENTATION NOTES
Create new document
RESPONSE CLASS (STATUS 201)
Added succesfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json
body
* Model
* Example Value
DocumentAddRequest {
ownerOrganizationGuid (string):
Employer or Candidate GUID
,
entityStateId (integer):
Inital status for document. 14 - ToBePublished, 178 - Published, 120 -
ToBeApproved/Signed
,
categoryId (integer, optional):
Category for signing process. Required if EntityStateId is 120. Possible
values: 1, 2, 3
,
documentName (string):
Document name, Max. length : 256
,
documentTypeId (integer):
Type of document. For getting available id see at
/docs/index#!/Documents/Settings
,
documentSubTypeId (integer, optional):
Document attribute - DomainSubTypeId. Required only for specific
DocumentTypeId. For mode details see at
/docs/index#!/Documents/Settings/{documentTypeId}
,
documentNumber (string, optional):
Document attribute - Number, Max. length : 128
,
documentStartDate (string, optional):
Document attribute - DateFrom
,
documentEndDate (string, optional):
Document attribute - DateTo
,
documentIssuingCountryId (integer, optional):
Document attribute - Country
,
documentIssuingCountryCode (string, optional):
Document attribute - CountryCode, Max. length : 2
,
documents (Array[DocumentFile]):
Single document or collection with 5 documents that will be merged into
one pdf file
}
DocumentFile {
fileName (string):
File name with extension, Max. length : 256
,
base64Data (string):
File. Base 64 encoded file
}
{
"ownerOrganizationGuid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"categoryId": 0,
"documentName": "string",
"documentTypeId": 0,
"documentSubTypeId": 0,
"documentNumber": "string",
"documentStartDate": "2024-06-13T09:50:13.409Z",
"documentEndDate": "2024-06-13T09:50:13.409Z",
"documentIssuingCountryId": 0,
"documentIssuingCountryCode": "string",
"documents": [
{
"fileName": "string",
"base64Data": "string"
}
]
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/DOCUMENTS/{DOCUMENTGUID}
* Document Detail
IMPLEMENTATION NOTES
Returns document for Customer by guid
RESPONSE CLASS (STATUS 200)
Returns document details
* Model
* Example Value
DocumentDetailsResponse {
guid (string, optional),
title (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
signLevelId (integer, optional),
signDate (string, optional),
documentTypeId (integer, optional),
documentTypeName (string, optional),
documentSubTypeId (integer, optional),
documentSubTypeName (string, optional),
number (string, optional),
startDate (string, optional),
endDate (string, optional),
countryId (integer, optional),
countryName (string, optional),
documentOwners (Array[DocumentOwnerResponseItem], optional),
createdDateUtc (string, optional),
lastUpdatedDateUtc (string, optional),
document (DocumentFile, optional)
}
DocumentOwnerResponseItem {
ownerEntityTypeId (integer, optional),
ownerEntityTypeName (string, optional),
ownerGuid (string, optional),
agencyGuid (string, optional),
agencyName (string, optional)
}
DocumentFile {
fileName (string):
File name with extension, Max. length : 256
,
base64Data (string):
File. Base 64 encoded file
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"entityStateId": 0,
"entityStateName": "string",
"signLevelId": 0,
"signDate": "2024-06-13T09:50:13.411Z",
"documentTypeId": 0,
"documentTypeName": "string",
"documentSubTypeId": 0,
"documentSubTypeName": "string",
"number": "string",
"startDate": "2024-06-13T09:50:13.411Z",
"endDate": "2024-06-13T09:50:13.411Z",
"countryId": 0,
"countryName": "string",
"documentOwners": [
{
"ownerEntityTypeId": 0,
"ownerEntityTypeName": "string",
"ownerGuid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string"
}
],
"createdDateUtc": "2024-06-13T09:50:13.411Z",
"lastUpdatedDateUtc": "2024-06-13T09:50:13.411Z",
"document": {
"fileName": "string",
"base64Data": "string"
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentGuid
Guid of Document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Document with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/DOCUMENTS/SETTINGS
* List Document Settings
IMPLEMENTATION NOTES
Returns list of settings for document types
RESPONSE CLASS (STATUS 200)
Returns list items of document type settings
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
documentTypeId (integer, optional),
documentTypeName (string, optional),
postAllowed (boolean, optional),
documentTypeSort (string, optional),
childDocumentTypeIds (Array[integer], optional)
}
[
{
"documentTypeId": 0,
"documentTypeName": "string",
"postAllowed": true,
"documentTypeSort": "string",
"childDocumentTypeIds": [
0
]
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/DOCUMENTS/SETTINGS/{DOCUMENTTYPEID}
* Document Settings Details
IMPLEMENTATION NOTES
Returns document setting details for document type id
RESPONSE CLASS (STATUS 200)
Returns document setting details
* Model
* Example Value
DocumentSettingApiDetailResponse {
documentTypeId (integer, optional),
documentTypeName (string, optional),
documentTypeStatus (string, optional),
category (DocumentSettingApiCategory, optional),
isRequired (boolean, optional),
documentExtensionsAllowed (string, optional),
mergeMultipleDocuments (boolean, optional),
initialStatus (DocumentSettingApiAttribute, optional),
number (DocumentSettingApiAttribute, optional),
country (DocumentSettingApiAttribute, optional),
dateFrom (DocumentSettingApiAttribute, optional),
dateTo (DocumentSettingApiAttribute, optional),
documentTypeSort (string, optional)
}
DocumentSettingApiCategory {
isSignLevelFixed (boolean, optional),
categoryIds (Array[integer], optional)
}
DocumentSettingApiAttribute {
enabled (boolean, optional),
value (DocumentSettingApiAttributeRoleValue, optional)
}
DocumentSettingApiAttributeRoleValue {
bureau (DocumentSettingApiAttributeValue, optional),
employer (DocumentSettingApiAttributeValue, optional),
candidate (DocumentSettingApiAttributeValue, optional)
}
DocumentSettingApiAttributeValue {
id (integer, optional),
name (string, optional)
}
{
"documentTypeId": 0,
"documentTypeName": "string",
"documentTypeStatus": "string",
"category": {
"isSignLevelFixed": true,
"categoryIds": [
0
]
},
"isRequired": true,
"documentExtensionsAllowed": "string",
"mergeMultipleDocuments": true,
"initialStatus": {
"enabled": true,
"value": {
"bureau": {
"id": 0,
"name": "string"
},
"employer": {
"id": 0,
"name": "string"
},
"candidate": {
"id": 0,
"name": "string"
}
}
},
"number": {
"enabled": true,
"value": {
"bureau": {
"id": 0,
"name": "string"
},
"employer": {
"id": 0,
"name": "string"
},
"candidate": {
"id": 0,
"name": "string"
}
}
},
"country": {
"enabled": true,
"value": {
"bureau": {
"id": 0,
"name": "string"
},
"employer": {
"id": 0,
"name": "string"
},
"candidate": {
"id": 0,
"name": "string"
}
}
},
"dateFrom": {
"enabled": true,
"value": {
"bureau": {
"id": 0,
"name": "string"
},
"employer": {
"id": 0,
"name": "string"
},
"candidate": {
"id": 0,
"name": "string"
}
}
},
"dateTo": {
"enabled": true,
"value": {
"bureau": {
"id": 0,
"name": "string"
},
"employer": {
"id": 0,
"name": "string"
},
"candidate": {
"id": 0,
"name": "string"
}
}
},
"documentTypeSort": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentTypeId
Id of document type from domain value
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
403
Settings with specified documentTypeId was not accessible for current
customer
404
Settings with specified documentTypeId was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DOMAINVALUES
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/DOMAINTYPES
* List Domain Types
IMPLEMENTATION NOTES
Returns domain types for Customer
RESPONSE CLASS (STATUS 200)
Returns list items of domain types
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
name (string, optional)
}
[
{
"id": 0,
"name": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/DOMAINVALUES/COUNTRYCODES
* Country Code Values
IMPLEMENTATION NOTES
Returns country codes
RESPONSE CLASS (STATUS 200)
Returns country codes
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
code (string, optional)
}
[
{
"id": 0,
"code": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/DOMAINTYPES/{DOMAINVALUETYPEID}/DOMAINVALUES
* List Domain Values
IMPLEMENTATION NOTES
Returns domain values for Customer by Domain Type
RESPONSE CLASS (STATUS 200)
Returns list items of domain values
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
name (string, optional)
}
[
{
"id": 0,
"name": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type domainValueTypeId
Domain value type id. Please see Domain Type API for the list of ids
query string isActive true false
Boolean value for search by IsActive property of domain value
query boolean hrXmlCode
String value for search by HrXmlCode property of domain value, Max.
length : 256
query string skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* EMPLOYERS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/EMPLOYERS/{EMPLOYERGUID}/CONTACTPERSONS
* List Employer Contact Persons
IMPLEMENTATION NOTES
Returns contact persons for employer
RESPONSE CLASS (STATUS 200)
Returns list items of employer contact persons
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
formattedName (string, optional),
email (string, optional),
lastUpdateDateUtc (string, optional),
isOwner (boolean, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"entityStateName": "string",
"formattedName": "string",
"email": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.424Z",
"isOwner": true
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type employerGuid
GUID of employer
path string search
Search filed. You can search by contact person name/email
query string entityStateIds
Integer collection for State of Employer Contact Person. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] lastUpdateDateUtcFrom
DateTime UTC value. Get user from last updated date.
query date-time lastUpdateDateUtcTo
DateTime UTC value. Get user to last updated date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Employer with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/EMPLOYERS/{EMPLOYERGUID}/CONTACTPERSONS
* Creation Contact Person
IMPLEMENTATION NOTES
Creation contact person for employer
RESPONSE CLASS (STATUS 201)
Registered succesfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type employerGuid path
string request
Parameter content type: application/json
body
* Model
* Example Value
EmployerContactPersonAddRequest {
firstName (string, optional):
Max. length : 64
,
preferredFirstName (string, optional):
Max. length : 64
,
middleName (string, optional):
Max. length : 64
,
lastName (string):
Max. length : 64
,
email (string, optional):
Should be a valid email : , Max. length : 128
,
mobile (string, optional):
Max. length : 32
,
phone (string, optional):
Max. length : 32
,
genderId (integer, optional):
Integer for GenderId of contact person. For getting available number you
can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET .Male - 1, Female - 2, NotSpecified - 3
,
salutation (string, optional):
String for Salutation., Max. length : 32
,
agencyContactPersonGuid (string, optional):
Guid for AgencyContactPersonGuid of Bureau.
}
{
"firstName": "string",
"preferredFirstName": "string",
"middleName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"phone": "string",
"genderId": 0,
"salutation": "string",
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Employer with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/EMPLOYERS
* List Employers
IMPLEMENTATION NOTES
Returns employers for Customer
RESPONSE CLASS (STATUS 200)
Returns list items of employers
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
parentGuid (string, optional),
agencyGuid (string, optional),
name (string, optional),
shortName (string, optional),
legalName (string, optional),
countryCode (string, optional),
postalCode (string, optional),
city (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
organizationTypeId (integer, optional),
entityStateId (integer, optional),
email (string, optional),
phone (string, optional),
totalHoursPerWeek (number, optional),
debtorNumber (string, optional),
contactPersonGuid (string, optional),
contactPersonName (string, optional),
lastUpdateDateUtc (string, optional),
invoiceEmail (string, optional),
toAttention (string, optional),
kvkMainNumber (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"parentGuid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"shortName": "string",
"legalName": "string",
"countryCode": "string",
"postalCode": "string",
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"organizationTypeId": 0,
"entityStateId": 0,
"email": "string",
"phone": "string",
"totalHoursPerWeek": 0,
"debtorNumber": "string",
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"contactPersonName": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.430Z",
"invoiceEmail": "string",
"toAttention": "string",
"kvkMainNumber": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type entityStateIds
Integer collection for State of Employer. For getting available number
you can find appropriate type at api/domainTypes GET and use it to find
values at api/domainValues GET. You can enter a comma separated list of
values.
query Array[integer] agencyGuids
Guid collection for parents Agencies. You can enter a comma separated
list of values.
query Array[string] organizationTypeIds
Integer collection for OrganizationTypes of Employer. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET . You can enter a comma
separated list of values.
query Array[integer] tagIds
Integer collection for TagIds of Employer. You can enter a comma
separated list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] search
String value for search by employer name., Max. length : 128
query string lastUpdateDateUtcFrom
DateTime UTC value. Get employer organizations from last updated date.
query date-time lastUpdateDateUtcTo
DateTime value. Get employer organizations to last updated date.
query date-time kvkMainNumber
String value for search by KVK number., Max. length : 128
query string skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/EMPLOYERS
* Employer Registration
IMPLEMENTATION NOTES
Register employers
RESPONSE CLASS (STATUS 201)
Registered succesfully
* Model
* Example Value
AddResponse {
guid (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000"
}
Response Content Type application/json text/json
HEADERS
Header Description Type Other Location Url to created or updated entity
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json
body
* Model
* Example Value
EmployerAddRequest {
name (string):
Max. length : 256
,
shortName (string, optional):
Max. length : 50
,
legalName (string, optional):
Max. length : 256
,
phone (string, optional):
Max. length : 32
,
email (string, optional):
Should be a valid email : , Max. length : 128
,
totalHoursPerWeek (number, optional):
Min. value : 0, Max. value : 84
,
agencyGuid (string, optional):
GUID of active agency
,
parentGuid (string, optional):
GUID of active agency or employer
,
isDepartment (boolean, optional):
Boolean value which determines if organization is Department
,
kvkMainNumber (string, optional):
Max. length : 8
,
kvkSubNumber (string, optional):
Max. length : 12
,
contactUserGuid (string, optional):
It is optional if setting [default contactperson] for that bureau is
filled on HelloFlex settings. Otherwise, this attribute is required, and
we return 'Value is invalid' error
,
entityStateId (integer, optional):
Integer for EntityStateId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
website (string, optional):
Max. length : 256, Should be a valid url :
,
debtorNumber (string, optional):
Max. length : 64
,
debtorStatusId (integer, optional):
Integer for DebtorStatusId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
debtorStatusDate (string, optional),
debtorStatusDescription (string, optional):
Max. length : 512
,
paymentTermsId (integer, optional):
Integer for PaymentTermsId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
vatNumber (string, optional):
Max. length : 64
,
vatConditionId (integer, optional):
Integer for VATConditionId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
vatRateId (integer, optional):
Integer for VATRateId. TO BE DEPRECATED IN FUTURE. Use VATGroupRateId
instead. For getting available number you can find appropriate type at
/docs/index#!/DomainValues/DomainValues_Get and use it to find values at
/docs/index#!/DomainValues/DomainValues_Get_0
,
vatGroupRateId (integer, optional):
Integer for VATGroupRateId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
gAccountUsage (boolean, optional),
gAccountAmount (number, optional):
Min. value : 0,01, Max. value : 100, Max. accuracy : 2 decimals
,
gAccountInclusiveTAX (boolean, optional),
bankAccountNumber (string, optional):
Should be a valid IBAN : , Max. length : 64
,
bicCode (string, optional):
Should be a BIC code :
,
invoiceMethodId (integer, optional):
Integer for InvoiceMethodId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
invoiceScheduleId (integer, optional):
Integer for InvoiceScheduleId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
invoiceEmail (string, optional):
Should be a valid email : , Max. length : 128
,
invoiceEmailSecondary (string, optional):
Should be a valid email : , Max. length : 128
,
creditStatusId (integer, optional):
Integer for CreditStatusId. For getting available number you can find
appropriate type at /docs/index#!/DomainValues/DomainValues_Get and use
it to find values at /docs/index#!/DomainValues/DomainValues_Get_0
,
creditStatusDate (string, optional),
creditStatusDescription (string, optional):
Max. length : 512
,
creditLimitAmount (number, optional):
Max. value : 10000000, Min. value : 0
,
creditLimitEndDate (string, optional),
creditRemark (string, optional):
Max. length : 512
,
regelingId (integer, optional):
For getting available number see at DomainValues - Regeling Domain Type
,
caoId (integer, optional):
For getting available number see at
/docs/index#!/WageSearch/WageSearch_GetCaos. Obsolete. Please use
RegelingId
,
marginWarning (number, optional):
Max. value : 1000000, Min. value : -1000000, Max. accuracy : 2 decimals
,
marginBlocking (number, optional):
Max. value : 1000000, Min. value : -1000000, Max. accuracy : 2 decimals
,
deliveryDate (string, optional),
toAttention (string, optional):
Max. length : 50
,
emailForReminders (string, optional):
Should be a valid email. Allows multiple values separated by semicolon :
, Max. length : 50
,
addresses (Array[AddressAddRequest], optional)
}
AddressAddRequest {
addressTypeId (integer):
Integer for AddressTypeId. For getting available number you can find
appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
,
street (string, optional):
Max. length : 256
,
number (string, optional):
Max. length : 16
,
unit (string, optional):
Max. length : 32
,
postalCode (string, optional):
Max. length : 16
,
city (string, optional):
Max. length : 256
,
countryId (integer, optional):
Integer for CountryId. For getting available number you can find
appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET
}
{
"name": "string",
"shortName": "string",
"legalName": "string",
"phone": "string",
"email": "string",
"totalHoursPerWeek": 0,
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"parentGuid": "00000000-0000-0000-0000-000000000000",
"isDepartment": true,
"kvkMainNumber": "string",
"kvkSubNumber": "string",
"contactUserGuid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"website": "string",
"debtorNumber": "string",
"debtorStatusId": 0,
"debtorStatusDate": "2024-06-13T09:50:13.434Z",
"debtorStatusDescription": "string",
"paymentTermsId": 0,
"vatNumber": "string",
"vatConditionId": 0,
"vatRateId": 0,
"vatGroupRateId": 0,
"gAccountUsage": true,
"gAccountAmount": 0,
"gAccountInclusiveTAX": true,
"bankAccountNumber": "string",
"bicCode": "string",
"invoiceMethodId": 0,
"invoiceScheduleId": 0,
"invoiceEmail": "string",
"invoiceEmailSecondary": "string",
"creditStatusId": 0,
"creditStatusDate": "2024-06-13T09:50:13.434Z",
"creditStatusDescription": "string",
"creditLimitAmount": 0,
"creditLimitEndDate": "2024-06-13T09:50:13.434Z",
"creditRemark": "string",
"regelingId": 0,
"caoId": 0,
"marginWarning": 0,
"marginBlocking": 0,
"deliveryDate": "2024-06-13T09:50:13.434Z",
"toAttention": "string",
"emailForReminders": "string",
"addresses": [
{
"addressTypeId": 0,
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"countryId": 0
}
]
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/EMPLOYERS/CONTACTPERSONS
* List of Employers Contact Persons
IMPLEMENTATION NOTES
Returns contact persons for employers
RESPONSE CLASS (STATUS 200)
Returns list items of contact persons
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
formattedName (string, optional),
email (string, optional),
lastUpdateDateUtc (string, optional),
employerName (string, optional),
employerGuid (string, optional),
isOwner (boolean, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"entityStateName": "string",
"formattedName": "string",
"email": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.438Z",
"employerName": "string",
"employerGuid": "00000000-0000-0000-0000-000000000000",
"isOwner": true
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type search
Search filed. You can search by contact person name/email
query string entityStateIds
Integer collection for State of Employer Contact Person. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] lastUpdateDateUtcFrom
DateTime UTC value. Get user from last updated date.
query date-time lastUpdateDateUtcTo
DateTime UTC value. Get user to last updated date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/EMPLOYERS/{EMPLOYERGUID}/CONTACTPERSONS/{CONTACTPERSONGUID}
* Employer Contact Person Detail
IMPLEMENTATION NOTES
Returns contact person for employer by GUID
RESPONSE CLASS (STATUS 200)
Returns contact person details
* Model
* Example Value
EmployerContactPersonDetailsResponse {
guid (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
lastName (string, optional),
surname (string, optional):
Should be deprecated. Please use "LastName" instead
,
middleName (string, optional),
prefixSurname (string, optional):
Should be deprecated. Please use "MiddleName" instead
,
firstName (string, optional),
preferredFirstName (string, optional),
salutation (string, optional),
genderId (integer, optional),
genderName (string, optional),
email (string, optional),
mobile (string, optional),
phone (string, optional),
lastUpdateDateUtc (string, optional),
agencyContactPersonGuid (string, optional),
isOwner (boolean, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"entityStateId": 0,
"entityStateName": "string",
"lastName": "string",
"surname": "string",
"middleName": "string",
"prefixSurname": "string",
"firstName": "string",
"preferredFirstName": "string",
"salutation": "string",
"genderId": 0,
"genderName": "string",
"email": "string",
"mobile": "string",
"phone": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.443Z",
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"isOwner": true
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employerGuid
GUID of employer
query string contactPersonGuid
GUID of employer contact person
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Employer or Contact person with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /API/EMPLOYERS/{EMPLOYERGUID}/CONTACTPERSONS/{CONTACTPERSONGUID}
* Employer Contact Persons Update
IMPLEMENTATION NOTES
Updating contact persons for employer via JSON Patch standart.
PARAMETERS
Parameter Value Description Parameter Type Data Type employerGuid
Guid of Employer
path string contactPersonGuid
Guid of Contact Person
path string request
Parameter content type: application/json
Supported operations: add, replace, copy, move, remove
body
* Model
* Example Value
JsonPatchDocument[EmployerContactPersonUpdateRequest] {
operations (Array[Operation[EmployerContactPersonUpdateRequest]],
optional, read only)
}
Operation[EmployerContactPersonUpdateRequest] {
value (object, optional):
The new property value
,
path (string, optional):
Property name. Should start with “/”
,
op (string, optional):
The patch operations supported by JSON Patch are “add”, “remove”,
“replace”, “move” and “copy”. The operations are applied in order: if any
of them fail then the whole patch operation should abort.
,
from (string, optional):
Using with Move operation
}
[
{
"value": "new value",
"path": "/FirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/PreferredFirstName",
"op": "replace"
},
{
"value": "new value",
"path": "/MiddleName",
"op": "replace"
},
{
"value": "new value",
"path": "/PrefixSurname",
"op": "replace"
},
{
"value": "new value",
"path": "/Surname",
"op": "replace"
},
{
"value": "new value",
"path": "/LastName",
"op": "replace"
},
{
"value": "new value",
"path": "/Salutation",
"op": "replace"
},
{
"value": "new value",
"path": "/GenderId",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/Mobile",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/AgencyContactPersonGuid",
"op": "replace"
}
]
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Contact persons for employer has been successfully updated
400
BadRequest
401
Unauthorized
404
Employer or contact person with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/EMPLOYERS/{EMPLOYERGUID}
* Employer Detail
IMPLEMENTATION NOTES
Returns employer detail by Id
RESPONSE CLASS (STATUS 200)
Returns employer detail
* Model
* Example Value
EmployerDetailsResponse {
entityStateId (integer, optional),
entityStateName (string, optional),
externalStatusName (string, optional),
guid (string, optional),
parentGuid (string, optional),
agencyGuid (string, optional),
customerNumber (string, optional),
debtorNumber (string, optional),
totalHoursPerWeek (number, optional),
debtorStatusId (integer, optional),
debtorStatusName (string, optional),
debtorStatusDate (string, optional),
debtorStatusDescription (string, optional),
paymentTermsId (integer, optional),
paymentTermsName (string, optional),
vatNumber (string, optional),
vatConditionId (integer, optional),
vatConditionName (string, optional),
vatRateId (integer, optional),
vatRateName (string, optional),
vatGroupRateId (integer, optional),
vatGroupRateName (string, optional),
bankAccountNumber (string, optional),
bicCode (string, optional),
invoiceMethodId (integer, optional),
invoiceMethodName (string, optional),
invoiceScheduleId (integer, optional),
invoiceScheduleName (string, optional),
invoiceEmail (string, optional),
invoiceEmailSecondary (string, optional),
creditStatusId (integer, optional),
creditStatusName (string, optional),
creditStatusDate (string, optional),
creditStatusDescription (string, optional),
creditLimitAmount (number, optional),
creditLimitEndDate (string, optional),
creditRemark (string, optional),
caoId (integer, optional),
caoName (string, optional),
regelingId (integer, optional),
regelingName (string, optional),
marginWarning (number, optional),
marginBlocking (number, optional),
deliveryDate (string, optional),
website (string, optional),
name (string, optional),
shortName (string, optional),
legalName (string, optional),
kvkMainNumber (string, optional),
kvkSubNumber (string, optional),
email (string, optional),
phone (string, optional),
contactPersonGuid (string, optional),
contactPersonName (string, optional),
contactUserFormattedName (string, optional):
Obsolete. Please use contactPersonName property instead.
contactUserFormattedName will be deprecated in the next API version.
,
organizationTypeId (integer, optional),
organizationTypeName (string, optional),
lastUpdateDateUtc (string, optional),
gAccountUsage (boolean, optional),
gAccountAmount (number, optional),
gAccountInclusiveTAX (boolean, optional),
toAttention (string, optional),
emailForReminders (string, optional),
addresses (Array[AddressResponse], optional)
}
AddressResponse {
addressTypeId (integer, optional),
addressTypeName (string, optional),
fullAddress (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
postalCode (string, optional),
city (string, optional),
country (string, optional)
}
{
"entityStateId": 0,
"entityStateName": "string",
"externalStatusName": "string",
"guid": "00000000-0000-0000-0000-000000000000",
"parentGuid": "00000000-0000-0000-0000-000000000000",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"customerNumber": "string",
"debtorNumber": "string",
"totalHoursPerWeek": 0,
"debtorStatusId": 0,
"debtorStatusName": "string",
"debtorStatusDate": "2024-06-13T09:50:13.453Z",
"debtorStatusDescription": "string",
"paymentTermsId": 0,
"paymentTermsName": "string",
"vatNumber": "string",
"vatConditionId": 0,
"vatConditionName": "string",
"vatRateId": 0,
"vatRateName": "string",
"vatGroupRateId": 0,
"vatGroupRateName": "string",
"bankAccountNumber": "string",
"bicCode": "string",
"invoiceMethodId": 0,
"invoiceMethodName": "string",
"invoiceScheduleId": 0,
"invoiceScheduleName": "string",
"invoiceEmail": "string",
"invoiceEmailSecondary": "string",
"creditStatusId": 0,
"creditStatusName": "string",
"creditStatusDate": "2024-06-13T09:50:13.453Z",
"creditStatusDescription": "string",
"creditLimitAmount": 0,
"creditLimitEndDate": "2024-06-13T09:50:13.453Z",
"creditRemark": "string",
"caoId": 0,
"caoName": "string",
"regelingId": 0,
"regelingName": "string",
"marginWarning": 0,
"marginBlocking": 0,
"deliveryDate": "2024-06-13T09:50:13.453Z",
"website": "string",
"name": "string",
"shortName": "string",
"legalName": "string",
"kvkMainNumber": "string",
"kvkSubNumber": "string",
"email": "string",
"phone": "string",
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"contactPersonName": "string",
"contactUserFormattedName": "string",
"organizationTypeId": 0,
"organizationTypeName": "string",
"lastUpdateDateUtc": "2024-06-13T09:50:13.453Z",
"gAccountUsage": true,
"gAccountAmount": 0,
"gAccountInclusiveTAX": true,
"toAttention": "string",
"emailForReminders": "string",
"addresses": [
{
"addressTypeId": 0,
"addressTypeName": "string",
"fullAddress": "string",
"street": "string",
"number": "string",
"unit": "string",
"postalCode": "string",
"city": "string",
"country": "string"
}
]
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employerGuid
Guid of Employer
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Employer with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PATCH /API/EMPLOYERS/{EMPLOYERGUID}
* Employers Update
IMPLEMENTATION NOTES
Updating entity employer via JSON Patch standart.
PARAMETERS
Parameter Value Description Parameter Type Data Type employerGuid
Guid of Employer
path string request
Parameter content type: application/json
Supported operations: add, replace, copy, move, remove
body
* Model
* Example Value
JsonPatchDocument[EmployerUpdateRequest] {
operations (Array[Operation[EmployerUpdateRequest]], optional, read only)
}
Operation[EmployerUpdateRequest] {
value (object, optional):
The new property value
,
path (string, optional):
Property name. Should start with “/”
,
op (string, optional):
The patch operations supported by JSON Patch are “add”, “remove”,
“replace”, “move” and “copy”. The operations are applied in order: if any
of them fail then the whole patch operation should abort.
,
from (string, optional):
Using with Move operation
}
[
{
"value": "new value",
"path": "/TotalHoursPerWeek",
"op": "replace"
},
{
"value": "new value",
"path": "/Name",
"op": "replace"
},
{
"value": "new value",
"path": "/ShortName",
"op": "replace"
},
{
"value": "new value",
"path": "/LegalName",
"op": "replace"
},
{
"value": "new value",
"path": "/Description",
"op": "replace"
},
{
"value": "new value",
"path": "/Email",
"op": "replace"
},
{
"value": "new value",
"path": "/Phone",
"op": "replace"
},
{
"value": "new value",
"path": "/KvkMainNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/KvkSubNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/ContactUserGuid",
"op": "replace"
},
{
"value": "new value",
"path": "/EntityStateId",
"op": "replace"
},
{
"value": "new value",
"path": "/Website",
"op": "replace"
},
{
"value": "new value",
"path": "/PaymentTermsId",
"op": "replace"
},
{
"value": "new value",
"path": "/VATNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/VATConditionId",
"op": "replace"
},
{
"value": "new value",
"path": "/VATRateId",
"op": "replace"
},
{
"value": "new value",
"path": "/VATGroupRateId",
"op": "replace"
},
{
"value": "new value",
"path": "/BankAccountNumber",
"op": "replace"
},
{
"value": "new value",
"path": "/BICCode",
"op": "replace"
},
{
"value": "new value",
"path": "/InvoiceMethodId",
"op": "replace"
},
{
"value": "new value",
"path": "/InvoiceScheduleId",
"op": "replace"
},
{
"value": "new value",
"path": "/InvoiceEmail",
"op": "replace"
},
{
"value": "new value",
"path": "/InvoiceEmailSecondary",
"op": "replace"
},
{
"value": "new value",
"path": "/CaoId",
"op": "replace"
},
{
"value": "new value",
"path": "/RegelingId",
"op": "replace"
},
{
"value": "new value",
"path": "/MarginWarning",
"op": "replace"
},
{
"value": "new value",
"path": "/MarginBlocking",
"op": "replace"
},
{
"value": "new value",
"path": "/DeliveryDate",
"op": "replace"
},
{
"value": "new value",
"path": "/GAccountUsage",
"op": "replace"
},
{
"value": "new value",
"path": "/GAccountAmount",
"op": "replace"
},
{
"value": "new value",
"path": "/GAccountInclusiveTAX",
"op": "replace"
},
{
"value": "new value",
"path": "/ToAttention",
"op": "replace"
},
{
"value": "new value",
"path": "/Addresses",
"op": "replace"
},
{
"value": "new value",
"path": "/CreditStatusId",
"op": "replace"
},
{
"value": "new value",
"path": "/CreditLimitAmount",
"op": "replace"
},
{
"value": "new value",
"path": "/CreditLimitEndDate",
"op": "replace"
},
{
"value": "new value",
"path": "/CreditRemark",
"op": "replace"
},
{
"value": "new value",
"path": "/EmailForReminders",
"op": "replace"
}
]
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
Employer has been successfully updated
400
BadRequest
401
Unauthorized
404
Employer with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/EMPLOYERS/{EMPLOYERGUID}/COSTCENTERS/{COSTCENTERGUID}
* Employer Cost Center Detail
IMPLEMENTATION NOTES
Returns cost center for employer by GUID
RESPONSE CLASS (STATUS 200)
Returns cost center details
* Model
* Example Value
EmployerCostCenterDetailsResponse {
number (integer, optional),
guid (string, optional),
code (string, optional),
name (string, optional),
employerName (string, optional),
contactUserGuid (string, optional),
description (string, optional),
isActive (boolean, optional),
lastUpdateDateUtc (string, optional),
mainAddress (CostCenterMainAddressResponse, optional),
invoiceAddress (CostCenterInvoiceAddressResponse, optional)
}
CostCenterMainAddressResponse {
fullAddress (string, optional),
street (string, optional),
number (string, optional),
city (string, optional),
postalCode (string, optional),
unit (string, optional),
postBus (string, optional),
country (string, optional)
}
CostCenterInvoiceAddressResponse {
fullAddress (string, optional),
street (string, optional),
number (string, optional),
city (string, optional),
postalCode (string, optional),
unit (string, optional),
postBus (string, optional),
toAttention (string, optional),
invoiceEmail (string, optional),
country (string, optional)
}
{
"number": 0,
"guid": "00000000-0000-0000-0000-000000000000",
"code": "string",
"name": "string",
"employerName": "string",
"contactUserGuid": "00000000-0000-0000-0000-000000000000",
"description": "string",
"isActive": true,
"lastUpdateDateUtc": "2024-06-13T09:50:13.459Z",
"mainAddress": {
"fullAddress": "string",
"street": "string",
"number": "string",
"city": "string",
"postalCode": "string",
"unit": "string",
"postBus": "string",
"country": "string"
},
"invoiceAddress": {
"fullAddress": "string",
"street": "string",
"number": "string",
"city": "string",
"postalCode": "string",
"unit": "string",
"postBus": "string",
"toAttention": "string",
"invoiceEmail": "string",
"country": "string"
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employerGuid
GUID of employer
query string costCenterGuid
GUID of employer cost center
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Employer or cost center with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/EMPLOYERS/{EMPLOYERGUID}/COSTCENTERS
* List Employer Cost Centers
IMPLEMENTATION NOTES
Returns cost centers for employer
RESPONSE CLASS (STATUS 200)
Returns list items of employer cost centers
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
employerGuid (string, optional),
costCenterGuid (string, optional),
name (string, optional),
code (string, optional),
isActive (boolean, optional),
lastUpdateDateUtc (string, optional)
}
[
{
"employerGuid": "00000000-0000-0000-0000-000000000000",
"costCenterGuid": "00000000-0000-0000-0000-000000000000",
"name": "string",
"code": "string",
"isActive": true,
"lastUpdateDateUtc": "2024-06-13T09:50:13.462Z"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type employerGuid
GUID of employer
query string search
Search filed. You can search by cost center name or code
query string lastUpdateDateUtcFrom
DateTime UTC value. Get cost center from last updated date.
query date-time lastUpdateDateUtcTo
DateTime UTC value. Get cost center to last updated date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Employer with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* JOBS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/JOBS
* List Jobs
IMPLEMENTATION NOTES
Returns jobs for Agency
RESPONSE CLASS (STATUS 200)
Returns list items of jobs
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
title (string, optional),
shortDescription (string, optional),
createdDateTimeUtc (string, optional),
lastUpdatedDateTimeUtc (string, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
employmentTypeId (integer, optional),
employmentTypeName (string, optional),
jobTypeId (integer, optional),
jobTypeName (string, optional),
jobCategoryId (integer, optional),
jobCategoryName (string, optional),
industryId (integer, optional),
industryName (string, optional),
jobEducationLevelId (integer, optional),
jobEducationLevelName (string, optional),
experienceLevelId (integer, optional),
experienceLevelName (string, optional),
salaryTypeId (integer, optional),
salaryTypeName (string, optional),
minSalary (number, optional),
maxSalary (number, optional),
minWorkingHoursPerWeek (integer, optional),
maxWorkingHoursPerWeek (integer, optional),
isPublished (boolean, optional),
countryId (integer, optional),
countryName (string, optional),
city (string, optional),
latitude (number, optional),
longitude (number, optional),
employerGuid (string, optional),
employerName (string, optional),
isTop (boolean, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"shortDescription": "string",
"createdDateTimeUtc": "2024-06-13T09:50:13.466Z",
"lastUpdatedDateTimeUtc": "2024-06-13T09:50:13.466Z",
"entityStateId": 0,
"entityStateName": "string",
"employmentTypeId": 0,
"employmentTypeName": "string",
"jobTypeId": 0,
"jobTypeName": "string",
"jobCategoryId": 0,
"jobCategoryName": "string",
"industryId": 0,
"industryName": "string",
"jobEducationLevelId": 0,
"jobEducationLevelName": "string",
"experienceLevelId": 0,
"experienceLevelName": "string",
"salaryTypeId": 0,
"salaryTypeName": "string",
"minSalary": 0,
"maxSalary": 0,
"minWorkingHoursPerWeek": 0,
"maxWorkingHoursPerWeek": 0,
"isPublished": true,
"countryId": 0,
"countryName": "string",
"city": "string",
"latitude": 0,
"longitude": 0,
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerName": "string",
"isTop": true
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type whatSearch
Job title or description. You can enter a string with max length 128
chars , Max. length : 128
query string whereSearch
Job city, country. You can enter a string with max length 128 chars ,
Max. length : 128
query string locationAreaRadius
Location area radius of search. You can enter single integer value. ,
Min. value : 0, Max. value : 80
query integer entityStateIds
Integer collection for State of Job. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET. You can enter a comma separated list of values.
query Array[integer] employerGuids
Guid collection for Employers of Job. You can enter a comma separated
list of values.
query Array[string] assigneeGuids
Guid collection for Agency Users of Job. You can enter a comma separated
list of values.
query Array[string] ownerGuids
Guid collection for Agencies of Job. You can enter a comma separated list
of values.
query Array[string] jobCategoryIds
Integer collection for Domain Values Job Category of Job. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] industryIds
Integer collection for Domain Values Industries of Job. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] iscoJobFunctionIds
Integer collection for Domain Values ISCO Job Function of Job. For
getting available number you can find appropriate type at api/domainTypes
GET and use it to find values at api/domainValues GET. You can enter a
comma separated list of values.
query Array[integer] tagIds
Integer collection for TagIds of Job. You can enter a comma separated
list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] skillIds
Integer collection for SkillIds of Job. You can enter a comma separated
list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] workingHoursMin
Min value for interval of working hours per week. You can enter single
integer value. , Min. value : 0, Max. value : 168
query integer workingHoursMax
Max value for interval of working hours per week. You can enter single
integer value. , Min. value : 0, Max. value : 168
query integer employmentTypeIds
Integer collection for Domain Values Job Type and Employment Type of Job.
For getting available number you can find appropriate type at
api/domainTypes GET and use it to find values at api/domainValues GET .
You can enter a comma separated list of values.
query Array[integer] lastUpdatedFrom
DateTime value. Get job from last updated date.
query date-time lastUpdatedTo
DateTime value. Get job to last updated date.
query date-time salaryMin
Min salary per month value. You can enter single integer value. , Min.
value : 0
query integer salaryMax
Max salary per month value. You can enter single integer value. , Min.
value : 0
query integer createdByEmployerOnly true false
Boolean value which determines whether to show or not to show jobs
created by the employer only.
query boolean includeArchived true false
Boolean value which determines if include archived jobs. The default is
false.
query boolean isTopOnly true false
Boolean value which determines whether to show top jobs only. The default
is false.
query boolean isPublishedOnly true false
Boolean value which determines whether to show published jobs only. The
default is false.
query boolean skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/JOBS/{JOBGUID}
* Job Detail
IMPLEMENTATION NOTES
Returns job for Agency by Guid
RESPONSE CLASS (STATUS 200)
Returns job details
* Model
* Example Value
JobDetailsResponse {
guid (string, optional),
title (string, optional),
createdDateTimeUtc (string, optional),
lastUpdatedDateTimeUtc (string, optional),
jobCategoryId (integer, optional),
jobCategoryName (string, optional),
industryId (integer, optional),
industryName (string, optional),
iscoJobFunctionId (integer, optional),
iscoJobFunctionName (string, optional),
countryId (integer, optional),
countryName (string, optional),
postalCode (string, optional),
city (string, optional),
street (string, optional),
number (string, optional),
unit (string, optional),
latitude (number, optional),
longitude (number, optional),
entityStateId (integer, optional),
entityStateName (string, optional),
agencyGuid (string, optional),
agencyName (string, optional),
contactPersonGuid (string, optional),
contactPersonName (string, optional),
contactPersonEmail (string, optional),
employerGuid (string, optional),
employerName (string, optional),
isPublished (boolean, optional),
publishedDateTimeUtc (string, optional),
employmentTypeId (integer, optional),
employmentTypeName (string, optional),
jobTypeId (integer, optional),
jobTypeName (string, optional),
jobEducationLevelId (integer, optional),
jobEducationLevelName (string, optional),
experienceLevelId (integer, optional),
experienceLevelName (string, optional),
experienceYears (integer, optional),
salaryTypeId (integer, optional),
salaryTypeName (string, optional),
minSalary (number, optional),
maxSalary (number, optional),
minWorkingHoursPerWeek (integer, optional),
maxWorkingHoursPerWeek (integer, optional),
startDate (string, optional),
endDate (string, optional),
tags (Array[TagResponse], optional),
skills (Array[TagResponse], optional),
jobContact (JobContactDetailsResponse, optional),
description (string, optional),
isTop (boolean, optional),
applyUrl (string, optional)
}
TagResponse {
id (integer, optional),
name (string, optional)
}
JobContactDetailsResponse {
contactTypeId (integer, optional),
contactType (string, optional),
showContactDetails (boolean, optional),
name (string, optional),
showName (boolean, optional),
phone (string, optional),
showPhone (boolean, optional),
email (string, optional),
showEmail (boolean, optional),
linkedIn (string, optional),
showLinkedIn (boolean, optional),
hasPhoto (boolean, optional),
showPhoto (boolean, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"createdDateTimeUtc": "2024-06-13T09:50:13.476Z",
"lastUpdatedDateTimeUtc": "2024-06-13T09:50:13.476Z",
"jobCategoryId": 0,
"jobCategoryName": "string",
"industryId": 0,
"industryName": "string",
"iscoJobFunctionId": 0,
"iscoJobFunctionName": "string",
"countryId": 0,
"countryName": "string",
"postalCode": "string",
"city": "string",
"street": "string",
"number": "string",
"unit": "string",
"latitude": 0,
"longitude": 0,
"entityStateId": 0,
"entityStateName": "string",
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"contactPersonGuid": "00000000-0000-0000-0000-000000000000",
"contactPersonName": "string",
"contactPersonEmail": "string",
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerName": "string",
"isPublished": true,
"publishedDateTimeUtc": "2024-06-13T09:50:13.476Z",
"employmentTypeId": 0,
"employmentTypeName": "string",
"jobTypeId": 0,
"jobTypeName": "string",
"jobEducationLevelId": 0,
"jobEducationLevelName": "string",
"experienceLevelId": 0,
"experienceLevelName": "string",
"experienceYears": 0,
"salaryTypeId": 0,
"salaryTypeName": "string",
"minSalary": 0,
"maxSalary": 0,
"minWorkingHoursPerWeek": 0,
"maxWorkingHoursPerWeek": 0,
"startDate": "2024-06-13T09:50:13.476Z",
"endDate": "2024-06-13T09:50:13.476Z",
"tags": [
{
"id": 0,
"name": "string"
}
],
"skills": [
{
"id": 0,
"name": "string"
}
],
"jobContact": {
"contactTypeId": 0,
"contactType": "string",
"showContactDetails": true,
"name": "string",
"showName": true,
"phone": "string",
"showPhone": true,
"email": "string",
"showEmail": true,
"linkedIn": "string",
"showLinkedIn": true,
"hasPhoto": true,
"showPhoto": true
},
"description": "string",
"isTop": true,
"applyUrl": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type jobGuid
Guid of Job
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Job with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/JOBS/KEYINDICATORS/{TYPE}
* Job Key Indicator
IMPLEMENTATION NOTES
Key indicator for domain values
RESPONSE CLASS (STATUS 200)
Returns number of jobs connected to specific domain value
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
code (integer, optional),
nameTranslations (inline_model, optional),
count (integer, optional)
}
inline_model {}
[
{
"code": 0,
"nameTranslations": {},
"count": 0
}
]
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type type
Type of indicator - EmploymentType - 1, JobCategory - 2, Industry - 3,
ISCOJobFunction - 4
path string whatSearch
Job title or description. You can enter a string with max length 128
chars , Max. length : 128
query string whereSearch
Job city, country. You can enter a string with max length 128 chars ,
Max. length : 128
query string locationAreaRadius
Location area radius of search. You can enter single integer value. ,
Min. value : 0, Max. value : 80
query integer entityStateIds
Integer collection for State of Job. For getting available number you can
find appropriate type at api/domainTypes GET and use it to find values at
api/domainValues GET. You can enter a comma separated list of values.
query Array[integer] employerGuids
Guid collection for Employers of Job. You can enter a comma separated
list of values.
query Array[string] assigneeGuids
Guid collection for Agency Users of Job. You can enter a comma separated
list of values.
query Array[string] ownerGuids
Guid collection for Agencies of Job. You can enter a comma separated list
of values.
query Array[string] jobCategoryIds
Integer collection for Domain Values Job Category of Job. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] industryIds
Integer collection for Domain Values Industries of Job. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] iscoJobFunctionIds
Integer collection for Domain Values ISCO Job Function of Job. For
getting available number you can find appropriate type at api/domainTypes
GET and use it to find values at api/domainValues GET. You can enter a
comma separated list of values.
query Array[integer] tagIds
Integer collection for TagIds of Job. You can enter a comma separated
list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] skillIds
Integer collection for SkillIds of Job. You can enter a comma separated
list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] workingHoursMin
Min value for interval of working hours per week. You can enter single
integer value. , Min. value : 0, Max. value : 168
query integer workingHoursMax
Max value for interval of working hours per week. You can enter single
integer value. , Min. value : 0, Max. value : 168
query integer employmentTypeIds
Integer collection for Domain Values Job Type and Employment Type of Job.
For getting available number you can find appropriate type at
api/domainTypes GET and use it to find values at api/domainValues GET .
You can enter a comma separated list of values.
query Array[integer] salaryMin
Min salary per month value. You can enter single integer value. , Min.
value : 0
query integer salaryMax
Max salary per month value. You can enter single integer value. , Min.
value : 0
query integer lastUpdatedFrom
DateTime value. Get job from last updated date.
query date-time lastUpdatedTo
DateTime value. Get job to last updated date.
query date-time createdByEmployerOnly true false
Boolean value which determines whether to show or not to show jobs
created by the employer only.
query boolean includeArchived true false
Boolean value which determines if include archived jobs. The default is
false.
query boolean isTopOnly true false
Boolean value which determines whether to show top jobs only. The default
is false.
query boolean isPublishedOnly true false
Boolean value which determines whether to show published jobs only. The
default is false.
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PUBLICJOBS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/PUBLICJOBS/{JOBGUID}
* Public Job Detail
IMPLEMENTATION NOTES
Returns public job for Agency by Guid
RESPONSE CLASS (STATUS 200)
Returns public job details
* Model
* Example Value
PublicJobDetailsResponse {
guid (string, optional),
title (string, optional),
publishedDateTimeUtc (string, optional),
lastUpdatedDateTimeUtc (string, optional),
jobCategoryId (integer, optional),
jobCategoryName (string, optional),
industryId (integer, optional),
industryName (string, optional),
countryId (integer, optional),
countryName (string, optional),
city (string, optional),
employmentTypeId (integer, optional),
employmentTypeName (string, optional),
jobTypeId (integer, optional),
jobTypeName (string, optional),
employerGuid (string, optional),
employerName (string, optional),
jobEducationLevelId (integer, optional),
jobEducationLevelName (string, optional),
experienceLevelId (integer, optional),
experienceLevelName (string, optional),
experienceYears (integer, optional),
salaryTypeId (integer, optional),
salaryTypeName (string, optional),
minSalary (number, optional),
maxSalary (number, optional),
minWorkingHoursPerWeek (integer, optional),
maxWorkingHoursPerWeek (integer, optional),
startDate (string, optional),
endDate (string, optional),
tags (Array[TagResponse], optional),
skills (Array[TagResponse], optional),
jobContact (PublicJobContactDetailsResponse, optional),
description (string, optional)
}
TagResponse {
id (integer, optional),
name (string, optional)
}
PublicJobContactDetailsResponse {
name (string, optional),
phone (string, optional),
email (string, optional),
linkedIn (string, optional),
hasPhoto (boolean, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"publishedDateTimeUtc": "2024-06-13T09:50:13.490Z",
"lastUpdatedDateTimeUtc": "2024-06-13T09:50:13.490Z",
"jobCategoryId": 0,
"jobCategoryName": "string",
"industryId": 0,
"industryName": "string",
"countryId": 0,
"countryName": "string",
"city": "string",
"employmentTypeId": 0,
"employmentTypeName": "string",
"jobTypeId": 0,
"jobTypeName": "string",
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerName": "string",
"jobEducationLevelId": 0,
"jobEducationLevelName": "string",
"experienceLevelId": 0,
"experienceLevelName": "string",
"experienceYears": 0,
"salaryTypeId": 0,
"salaryTypeName": "string",
"minSalary": 0,
"maxSalary": 0,
"minWorkingHoursPerWeek": 0,
"maxWorkingHoursPerWeek": 0,
"startDate": "2024-06-13T09:50:13.490Z",
"endDate": "2024-06-13T09:50:13.490Z",
"tags": [
{
"id": 0,
"name": "string"
}
],
"skills": [
{
"id": 0,
"name": "string"
}
],
"jobContact": {
"name": "string",
"phone": "string",
"email": "string",
"linkedIn": "string",
"hasPhoto": true
},
"description": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type jobGuid
Guid of active public job
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Public job with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/PUBLICJOBS
* Public Job List
IMPLEMENTATION NOTES
Returns public job for Agency
RESPONSE CLASS (STATUS 200)
Returns list items of public job
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
publishedDateTimeUtc (string, optional),
lastUpdatedDateTimeUtc (string, optional),
title (string, optional),
shortDescription (string, optional),
countryId (integer, optional),
countryName (string, optional),
city (string, optional),
employmentTypeId (integer, optional),
employmentTypeName (string, optional),
jobTypeId (integer, optional),
jobTypeName (string, optional),
salaryTypeId (integer, optional),
salaryTypeName (string, optional),
minSalary (number, optional),
maxSalary (number, optional),
jobEducationLevelId (integer, optional),
jobEducationLevelName (string, optional),
experienceLevelId (integer, optional),
experienceLevelName (string, optional),
minWorkingHoursPerWeek (integer, optional),
maxWorkingHoursPerWeek (integer, optional),
employerGuid (string, optional),
employerName (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"publishedDateTimeUtc": "2024-06-13T09:50:13.493Z",
"lastUpdatedDateTimeUtc": "2024-06-13T09:50:13.493Z",
"title": "string",
"shortDescription": "string",
"countryId": 0,
"countryName": "string",
"city": "string",
"employmentTypeId": 0,
"employmentTypeName": "string",
"jobTypeId": 0,
"jobTypeName": "string",
"salaryTypeId": 0,
"salaryTypeName": "string",
"minSalary": 0,
"maxSalary": 0,
"jobEducationLevelId": 0,
"jobEducationLevelName": "string",
"experienceLevelId": 0,
"experienceLevelName": "string",
"minWorkingHoursPerWeek": 0,
"maxWorkingHoursPerWeek": 0,
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerName": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type whatSearch
Job title or description. You can enter a string with max length 128
chars , Max. length : 128
query string whereSearch
Job city, country. You can enter a string with max length 128 chars ,
Max. length : 128
query string locationAreaRadius
Location area radius of search. You can enter single integer value. ,
Min. value : 0, Max. value : 80
query integer employmentTypeIds
Integer collection for Domain Values Job Type and Employment Type of Job.
For getting available number you can find appropriate type at
api/domainTypes GET and use it to find values at api/domainValues GET .
You can enter a comma separated list of values.
query Array[integer] salaryMin
Min salary per month value. You can enter single integer value. , Min.
value : 0
query integer salaryMax
Max salary per month value. You can enter single integer value. , Min.
value : 0
query integer jobCategoryIds
Integer collection for Domain Values Job Category of Job. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] industryIds
Integer collection for Domain Values Industries of Job. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] workingHoursMin
Min value for interval of working hours per week. You can enter single
integer value. , Min. value : 0, Max. value : 168
query integer workingHoursMax
Max value for interval of working hours per week. You can enter single
integer value. , Min. value : 0, Max. value : 168
query integer tagIds
Integer collection for TagIds of Job. You can enter a comma separated
list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] skillIds
Integer collection for SkillIds of Job. You can enter a comma separated
list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] lastUpdatedFrom
DateTime value. Get job from last updated date.
query date-time lastUpdatedTo
DateTime value. Get job to last updated date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/PUBLICJOBS/KEYINDICATORS/{TYPE}
* Public Job Key Indicator
IMPLEMENTATION NOTES
Key indicator for domain values
RESPONSE CLASS (STATUS 200)
Returns number of jobs connected to specific domain value
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
code (integer, optional),
nameTranslations (inline_model, optional),
count (integer, optional)
}
inline_model {}
[
{
"code": 0,
"nameTranslations": {},
"count": 0
}
]
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type type
Type of indicator - EmploymentType - 1, JobCategory - 2, Industry - 3
path string whatSearch
Job title or description. You can enter a string with max length 128
chars , Max. length : 128
query string whereSearch
Job city, country. You can enter a string with max length 128 chars ,
Max. length : 128
query string locationAreaRadius
Location area radius of search. You can enter single integer value. ,
Min. value : 0, Max. value : 80
query integer employmentTypeIds
Integer collection for Domain Values Job Type and Employment Type of Job.
For getting available number you can find appropriate type at
api/domainTypes GET and use it to find values at api/domainValues GET .
You can enter a comma separated list of values.
query Array[integer] salaryMin
Min salary per month value. You can enter single integer value. , Min.
value : 0
query integer salaryMax
Max salary per month value. You can enter single integer value. , Min.
value : 0
query integer jobCategoryIds
Integer collection for Domain Values Job Category of Job. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] industryIds
Integer collection for Domain Values Industries of Job. For getting
available number you can find appropriate type at api/domainTypes GET and
use it to find values at api/domainValues GET. You can enter a comma
separated list of values.
query Array[integer] workingHoursMin
Min value for interval of working hours per week. You can enter single
integer value. , Min. value : 0, Max. value : 168
query integer workingHoursMax
Max value for interval of working hours per week. You can enter single
integer value. , Min. value : 0, Max. value : 168
query integer tagIds
Integer collection for TagIds of Job. You can enter a comma separated
list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] skillIds
Integer collection for SkillIds of Job. You can enter a comma separated
list of values. For getting available number see at
/docs/index#!/Tags/Tags_Get_0
query Array[integer] lastUpdatedFrom
DateTime value. Get job from last updated date.
query date-time lastUpdatedTo
DateTime value. Get job to last updated date.
query date-time
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PUBLICNEWS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/PUBLICNEWS/{NEWSGUID}
* Public News
IMPLEMENTATION NOTES
Returns Public News for Customer by guid
RESPONSE CLASS (STATUS 200)
Returns public news details
* Model
* Example Value
NewsDetailsResponse {
guid (string, optional),
title (string, optional),
publicationDateUtc (string, optional),
sourceUrl (string, optional),
description (string, optional),
photoUrl (string, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"publicationDateUtc": "2024-06-13T09:50:13.504Z",
"sourceUrl": "string",
"description": "string",
"photoUrl": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type newsGuid
Guid of Public News
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Public News with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/PUBLICNEWS
* List Public News
IMPLEMENTATION NOTES
Returns public news for Customer
RESPONSE CLASS (STATUS 200)
Returns list items of public news
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
title (string, optional),
publicationDateUtc (string, optional),
sourceUrl (string, optional),
description (string, optional),
photoUrl (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"title": "string",
"publicationDateUtc": "2024-06-13T09:50:13.506Z",
"sourceUrl": "string",
"description": "string",
"photoUrl": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TAGS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/TAGS/{TAGID}
* Tag Detail
IMPLEMENTATION NOTES
Returns tag for Customer by Id
RESPONSE CLASS (STATUS 200)
Returns tag details
* Model
* Example Value
TagDetailsResponse {
id (integer, optional),
name (string, optional),
tagTypeId (integer, optional),
tagTypeName (string, optional)
}
{
"id": 0,
"name": "string",
"tagTypeId": 0,
"tagTypeName": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type tagId
Id of Tag
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Tag with specified Id was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/TAGS
* List Tags
IMPLEMENTATION NOTES
Returns tags for Customer
RESPONSE CLASS (STATUS 200)
Returns list items of tags
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
name (string, optional),
tagTypeId (integer, optional),
tagTypeName (string, optional)
}
[
{
"id": 0,
"name": "string",
"tagTypeId": 0,
"tagTypeName": "string"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type search
Tag name. You can enter a string with max length 128 chars , Max. length
: 128
query string entityTypeIds
Integer collection for Type of Entity wich has connected tag. You can
enter a comma separated list of values. Job - 94, Employer - 18,
Candidate - 95, User - 105, JobMatchProfile - 321, CandidateMatchProfile
- 372
query Array[integer] tagTypeIds
Integer collection for Type of Tag. You can enter a comma separated list
of values. General - 1, Skill - 2
query Array[integer] skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TIMECARDS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/TIMECARDS
* Timecards List
IMPLEMENTATION NOTES
Returns timecards for customer
RESPONSE CLASS (STATUS 200)
Returns list items of timecards
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
guid (string, optional),
entityStateName (string, optional),
number (integer, optional),
version (integer, optional),
agencyGuid (string, optional),
agencyName (string, optional),
agencyContactPersonGuid (string, optional),
agencyContactPersonName (string, optional),
employerGuid (string, optional),
employerName (string, optional),
employerContactPersonGuid (string, optional),
employerContactPersonName (string, optional),
candidateGuid (string, optional),
candidateFormattedName (string, optional),
contractGuid (string, optional),
startDateUtc (string, optional),
endDateUtc (string, optional),
costCenterName (string, optional),
purchaseOrderNumber (string, optional),
totalHours (number, optional),
totalHoursMo (number, optional),
totalHoursTu (number, optional),
totalHoursWe (number, optional),
totalHoursTh (number, optional),
totalHoursFr (number, optional),
totalHoursSa (number, optional),
totalHoursSu (number, optional),
revenu (number, optional),
costNc (number, optional),
costVc (number, optional),
wageProcessingStatus (string, optional),
invoiceProcessingStatus (string, optional),
correctionReason (string, optional),
correctionType (string, optional),
cancelReason (string, optional),
isDefault (boolean, optional),
isCalculatedByClockWise (boolean, optional),
isCorrected (boolean, optional),
createdDateUtc (string, optional),
lastUpdateDateUtc (string, optional)
}
[
{
"guid": "00000000-0000-0000-0000-000000000000",
"entityStateName": "string",
"number": 0,
"version": 0,
"agencyGuid": "00000000-0000-0000-0000-000000000000",
"agencyName": "string",
"agencyContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"agencyContactPersonName": "string",
"employerGuid": "00000000-0000-0000-0000-000000000000",
"employerName": "string",
"employerContactPersonGuid": "00000000-0000-0000-0000-000000000000",
"employerContactPersonName": "string",
"candidateGuid": "00000000-0000-0000-0000-000000000000",
"candidateFormattedName": "string",
"contractGuid": "00000000-0000-0000-0000-000000000000",
"startDateUtc": "2024-06-13T09:50:13.513Z",
"endDateUtc": "2024-06-13T09:50:13.513Z",
"costCenterName": "string",
"purchaseOrderNumber": "string",
"totalHours": 0,
"totalHoursMo": 0,
"totalHoursTu": 0,
"totalHoursWe": 0,
"totalHoursTh": 0,
"totalHoursFr": 0,
"totalHoursSa": 0,
"totalHoursSu": 0,
"revenu": 0,
"costNc": 0,
"costVc": 0,
"wageProcessingStatus": "string",
"invoiceProcessingStatus": "string",
"correctionReason": "string",
"correctionType": "string",
"cancelReason": "string",
"isDefault": true,
"isCalculatedByClockWise": true,
"isCorrected": true,
"createdDateUtc": "2024-06-13T09:50:13.513Z",
"lastUpdateDateUtc": "2024-06-13T09:50:13.513Z"
}
]
Response Content Type application/json text/json
HEADERS
Header Description Type Other X-Total-Count Total count Link Url to
previous and next item if available
PARAMETERS
Parameter Value Description Parameter Type Data Type agencyGuids
Guid collection of Agencies. You can enter a comma separated list of
values.
query Array[string] employerGuids
Guid collection of Employers. You can enter a comma separated list of
values.
query Array[string] candidateGuids
Guid collection of Candidates. You can enter a comma separated list of
values.
query Array[string] contractGuids
Guid collection of Contracts. You can enter a comma separated list of
values.
query Array[string] entityStateIds
Integer collection for State of Timecard. You can enter a comma separated
list of values. Report - 151, Submitted - 152, ToBeApprovedByAgency -
204, Approved - 153, Rejected - 154, Completed - 155, Deleted - 156,
ToBeCalculated - 219, Processed - 231, ToBeCanceled - 391, Canceled - 392
query Array[integer] lastUpdateDateUtcFrom
DateTime value. Get timecards from last updated date.
query date-time lastUpdateDateUtcTo
DateTime value. Get timecards to last updated date.
query date-time startDateUtcFrom
DateTime value. Get timecards from start date.
query date-time startDateUtcTo
DateTime value. Get timecards to start date.
query date-time endDateUtcFrom
DateTime value. Get timecards from end date.
query date-time endDateUtcTo
DateTime value. Get timecards to end date.
query date-time skip
Quantity items to skip. The default is 0, Min. value : 0
query integer take
Quantity items to take on the page. The default is 10, Min. value : 1,
Max. value : 100
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/TIMECARDS/{TIMECARDGUID}
* Timecard Detail
IMPLEMENTATION NOTES
Returns timecard detail by guid
RESPONSE CLASS (STATUS 200)
Returns timecard detail
* Model
* Example Value
TimecardDetailsResponse {
guid (string, optional),
number (integer, optional),
version (integer, optional),
entityStateName (string, optional),
timecardRateclass (Array[RateClassResponse], optional)
}
RateClassResponse {
rateClassName (string, optional),
rateClassTypeName (string, optional),
amount (number, optional),
billAmount (number, optional),
billMultiplier (number, optional),
billMeasureTypeName (string, optional),
payAmount (number, optional),
payMultiplier (number, optional),
payMeasureTypeName (string, optional),
remarks (string, optional),
isAddedManually (boolean, optional),
isVariable (boolean, optional)
}
{
"guid": "00000000-0000-0000-0000-000000000000",
"number": 0,
"version": 0,
"entityStateName": "string",
"timecardRateclass": [
{
"rateClassName": "string",
"rateClassTypeName": "string",
"amount": 0,
"billAmount": 0,
"billMultiplier": 0,
"billMeasureTypeName": "string",
"payAmount": 0,
"payMultiplier": 0,
"payMeasureTypeName": "string",
"remarks": "string",
"isAddedManually": true,
"isVariable": true
}
]
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type timecardGuid
Guid of Timecard
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
Timecard with specified GUID was not found
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* WAGESEARCH
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/WAGESEARCH
* Wage Search
IMPLEMENTATION NOTES
Returns Wage by request parameter. Current version will be deprecated by
31-12-2022. Please use endpoint Wagesearchinfo.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
Response Content Type application/json text/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
410
No longer available
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/WAGESEARCHINFO
* Wage Search
IMPLEMENTATION NOTES
Returns Wage by request parameter
RESPONSE CLASS (STATUS 200)
Returns Wage details
* Model
* Example Value
WageSearchResponseV2 {
information (Array[InformationResponse], optional),
wageSearchPdfResultUrl (string, optional),
hourlyWage (number, optional),
higherExperienceHourlyWage (number, optional),
advPercent (number, optional),
advDays (number, optional),
nextIncreaseDate (string, optional),
nextIncreaseRate (number, optional),
nextIncreaseAmount (number, optional),
nextIncreaseSource (string, optional),
nextIncreaseSourceUrl (string, optional),
wageNotes (string, optional)
}
InformationResponse {
isActive (boolean, optional),
informationGroupId (integer, optional),
informationGroupName (string, optional),
surchargeTypeId (integer, optional),
surchargeTypeName (string, optional),
name (string, optional),
article (string, optional),
description (string, optional),
rateZones (Array[InformationRateZoneResponse], optional),
conditions (InformationConditions, optional)
}
InformationRateZoneResponse {
startTime (string, optional),
endTime (string, optional),
dayRates (Array[number], optional)
}
InformationConditions {
caoFunctions (Array[WageSearchParameterResposneItem], optional),
caoFunctionGroups (Array[WageSearchParameterResposneItem], optional)
}
WageSearchParameterResposneItem {
id (integer, optional),
name (string, optional)
}
{
"information": [
{
"isActive": true,
"informationGroupId": 0,
"informationGroupName": "string",
"surchargeTypeId": 0,
"surchargeTypeName": "string",
"name": "string",
"article": "string",
"description": "string",
"rateZones": [
{
"startTime": "string",
"endTime": "string",
"dayRates": [
0
]
}
],
"conditions": {
"caoFunctions": [
{
"id": 0,
"name": "string"
}
],
"caoFunctionGroups": [
{
"id": 0,
"name": "string"
}
]
}
}
],
"wageSearchPdfResultUrl": "string",
"hourlyWage": 0,
"higherExperienceHourlyWage": 0,
"advPercent": 0,
"advDays": 0,
"nextIncreaseDate": "2024-06-13T09:50:13.528Z",
"nextIncreaseRate": 0,
"nextIncreaseAmount": 0,
"nextIncreaseSource": "string",
"nextIncreaseSourceUrl": "string",
"wageNotes": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type caoId
Id of CAO. You can enter single integer value. For getting available
number see at /docs/index#!/WageSearch/WageSearch_GetCAOs
query integer caoFunctionId
Id of CAOFunction. You can enter single integer value. For getting
available number see at
/docs/index#!/WageSearch/WageSearch_GetCAOFunctions
query integer caoFunctionGroupId
Id of CAOFunctionGroup. You can enter single integer value. For getting
available number see at
/docs/index#!/WageSearch/WageSearch_GetCAOFunctionGroups
query integer workWeekHours
Hours of working week. You can enter single float value. For getting
available number see at
/docs/index#!/WageSearch/WageSearch_GetWorkWeekHours, Min. value : 1,
Max. value : 168
query float birthdate
Date of birth. You can enter DateTime value., Min. value : 13 years
query date-time date
Request start date. You can enter DateTime value.
query date-time periodic
Experience. You can enter single integer value. For getting available
number see at /docs/index#!/WageSearch/WageSearch_GetPeriodics, Min.
value : 0, Max. value : 77
query integer employer
Name of Employer. You can enter string with max length 128 chars., Max.
length : 128
query string agency
Name of Agency. You can enter string with max length 128 chars., Max.
length : 128
query string flexWorker
Name of FlexWorker. You can enter string with max length 64 chars., Max.
length : 64
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/WAGESEARCH/CAOS
* CAO list items
IMPLEMENTATION NOTES
Returns CAO items
RESPONSE CLASS (STATUS 200)
Returns list of CAO items
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
name (string, optional),
sbiCode (string, optional),
sbiCodeName (string, optional),
payrollCode (integer, optional),
payrollName (string, optional)
}
[
{
"id": 0,
"name": "string",
"sbiCode": "string",
"sbiCodeName": "string",
"payrollCode": 0,
"payrollName": "string"
}
]
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type sbiCode
SBI Code. You can enter string value.
query string payrollCode
Payroll Code. You can enter single integer value.
query integer payrollName
Payroll Name. You can enter string value.
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/WAGESEARCH/CAOFUNCTIONS
* CAOFunction list items
IMPLEMENTATION NOTES
Returns CAOFunction items by CAO id
RESPONSE CLASS (STATUS 200)
Returns list of CAOFunction items
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
name (string, optional)
}
[
{
"id": 0,
"name": "string"
}
]
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type caoId
Id of CAO. You can enter single integer value. For getting available
number see at /docs/index#!/WageSearch/WageSearch_GetCAOs
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/WAGESEARCH/CAOFUNCTIONGROUPS
* CAOFunctionGroup list items
IMPLEMENTATION NOTES
Returns CAOFunctionGroup items by CAOFunction id
RESPONSE CLASS (STATUS 200)
Returns list of CAOFunctionGroup items
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (integer, optional),
name (string, optional)
}
[
{
"id": 0,
"name": "string"
}
]
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type caoFunctionId
Id of CAOFunction. You can enter single integer value. For getting
available number see at
/docs/index#!/WageSearch/WageSearch_GetCAOFunctions
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/WAGESEARCH/WORKWEEKHOURS
* Workweek hour values
IMPLEMENTATION NOTES
Returns workweek hour values by CAO id
RESPONSE CLASS (STATUS 200)
Returns list of workweek hour values
* Model
* Example Value
Inline Model [
number
]
[
0
]
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type caoId
Id of CAO. You can enter single integer value. For getting available
number see at /docs/index#!/WageSearch/WageSearch_GetCAOs
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/WAGESEARCH/PERIODICS
* Periodic values
IMPLEMENTATION NOTES
Returns CAOFunctionGroup periodics values
RESPONSE CLASS (STATUS 200)
Returns list of periodic values
* Model
* Example Value
Inline Model [
integer
]
[
0
]
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type caoId
Id of CAO. You can enter single integer value. For getting available
number see at /docs/index#!/WageSearch/WageSearch_GetCAOs
query integer caoFunctionGroupId
Id of CAOFunctionGroup. You can enter single integer value. For getting
available number see at
/docs/index#!/WageSearch/WageSearch_GetCAOFunctionGroups
query integer birthDate
Date of birth. You can enter DateTime value.
query date-time date
Date of birth. You can enter DateTime value.
query date-time
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* WEBHOOKFILTERS
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/WEBHOOKS/FILTERS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
name (string, optional),
description (string, optional)
}
[
{
"name": "string",
"description": "string"
}
]
Response Content Type application/json text/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* WEBHOOKREGISTRATIONS
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /API/WEBHOOKS/REGISTRATIONS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
Response Content Type application/json text/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/WEBHOOKS/REGISTRATIONS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
id (string, optional),
webHookUri (string),
secret (string, optional),
description (string, optional),
isPaused (boolean, optional),
filters (Array[string], optional, read only),
headers (inline_model_0, optional, read only),
properties (inline_model_1, optional, read only)
}
inline_model_0 {}
inline_model_1 {}
[
{
"id": "string",
"webHookUri": "string",
"secret": "string",
"description": "string",
"isPaused": true,
"filters": [
"string"
],
"headers": {},
"properties": {}
}
]
Response Content Type application/json text/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/WEBHOOKS/REGISTRATIONS
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
WebHook {
id (string, optional),
webHookUri (string),
secret (string, optional),
description (string, optional),
isPaused (boolean, optional),
filters (Array[string], optional, read only),
headers (inline_model_0, optional, read only),
properties (inline_model_1, optional, read only)
}
inline_model_0 {}
inline_model_1 {}
{
"id": "string",
"webHookUri": "string",
"secret": "string",
"description": "string",
"isPaused": true,
"filters": [
"string"
],
"headers": {},
"properties": {}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type webHook
Parameter content type: application/json
body
* Model
* Example Value
WebHook {
id (string, optional),
webHookUri (string),
secret (string, optional),
description (string, optional),
isPaused (boolean, optional),
filters (Array[string], optional, read only),
headers (inline_model_0, optional, read only),
properties (inline_model_1, optional, read only)
}
inline_model_0 {}
inline_model_1 {}
{
"id": "string",
"webHookUri": "string",
"secret": "string",
"description": "string",
"isPaused": true,
"filters": [
"string"
],
"headers": {},
"properties": {}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /API/WEBHOOKS/REGISTRATIONS/{ID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/WEBHOOKS/REGISTRATIONS/{ID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
WebHook {
id (string, optional),
webHookUri (string),
secret (string, optional),
description (string, optional),
isPaused (boolean, optional),
filters (Array[string], optional, read only),
headers (inline_model_0, optional, read only),
properties (inline_model_1, optional, read only)
}
inline_model_0 {}
inline_model_1 {}
{
"id": "string",
"webHookUri": "string",
"secret": "string",
"description": "string",
"isPaused": true,
"filters": [
"string"
],
"headers": {},
"properties": {}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /API/WEBHOOKS/REGISTRATIONS/{ID}
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
webHook
Parameter content type: application/json
body
* Model
* Example Value
WebHook {
id (string, optional),
webHookUri (string),
secret (string, optional),
description (string, optional),
isPaused (boolean, optional),
filters (Array[string], optional, read only),
headers (inline_model_0, optional, read only),
properties (inline_model_1, optional, read only)
}
inline_model_0 {}
inline_model_1 {}
{
"id": "string",
"webHookUri": "string",
"secret": "string",
"description": "string",
"isPaused": true,
"filters": [
"string"
],
"headers": {},
"properties": {}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: , API VERSION: V1 ]