mcl-int-bannerapi-nc.mayo.edu
Open in
urlscan Pro
172.214.143.190
Public Scan
Submitted URL: https://mcl-int-bannerapi-nc.mayo.edu/
Effective URL: https://mcl-int-bannerapi-nc.mayo.edu/swagger/ui/index
Submission: On August 09 via api from US — Scanned from DE
Effective URL: https://mcl-int-bannerapi-nc.mayo.edu/swagger/ui/index
Submission: On August 09 via api from US — Scanned from DE
Form analysis 12 forms found in the DOM
<form id="api_selector">
<div class="input"><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"></div>
<div class="input"><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"></div>
<div class="input"><a id="explore" class="header__btn" href="#" data-sw-translate="">Explore</a></div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mmessageSearchCriteria0.23323445911579488">messageSearchCriteria</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="messageSearchCriteria" id="mmessageSearchCriteria0.23323445911579488"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.33259009253456195" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.33259009253456195">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MessageSearchCriteria {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>2147483647</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName ">url</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>2147483647</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">pageNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">pageSize</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">sortBy</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">fromDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">toDate</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 class="hljs json">{
"<span class="hljs-attr">id</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">title</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">active</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">type</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">content</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">url</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">pageNumber</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">pageSize</span>": <span class="hljs-number">0</span>,
"<span class="hljs-attr">sortBy</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">fromDate</span>": <span class="hljs-string">"2024-08-09T01:08:27.279Z"</span>,
"<span class="hljs-attr">toDate</span>": <span class="hljs-string">"2024-08-09T01:08:27.279Z"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code class="hljs xml"><span class="hljs-meta"><?xml version="1.0"?></span>
<span class="hljs-tag"><<span class="hljs-name">MessageSearchCriteria</span>></span>
<span class="hljs-tag"><<span class="hljs-name">id</span>></span>string<span class="hljs-tag"></<span class="hljs-name">id</span>></span>
<span class="hljs-tag"><<span class="hljs-name">title</span>></span>string<span class="hljs-tag"></<span class="hljs-name">title</span>></span>
<span class="hljs-tag"><<span class="hljs-name">active</span>></span>true<span class="hljs-tag"></<span class="hljs-name">active</span>></span>
<span class="hljs-tag"><<span class="hljs-name">type</span>></span>string<span class="hljs-tag"></<span class="hljs-name">type</span>></span>
<span class="hljs-tag"><<span class="hljs-name">content</span>></span>string<span class="hljs-tag"></<span class="hljs-name">content</span>></span>
<span class="hljs-tag"><<span class="hljs-name">url</span>></span>string<span class="hljs-tag"></<span class="hljs-name">url</span>></span>
<span class="hljs-tag"><<span class="hljs-name">pageNumber</span>></span>1<span class="hljs-tag"></<span class="hljs-name">pageNumber</span>></span>
<span class="hljs-tag"><<span class="hljs-name">pageSize</span>></span>1<span class="hljs-tag"></<span class="hljs-name">pageSize</span>></span>
<span class="hljs-tag"><<span class="hljs-name">sortBy</span>></span>string<span class="hljs-tag"></<span class="hljs-name">sortBy</span>></span>
<span class="hljs-tag"><<span class="hljs-name">fromDate</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">fromDate</span>></span>
<span class="hljs-tag"><<span class="hljs-name">toDate</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">toDate</span>></span>
<span class="hljs-tag"></<span class="hljs-name">MessageSearchCriteria</span>></span>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbannerMessageModel0.7939342269503373">bannerMessageModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="bannerMessageModel" id="mbannerMessageModel0.7939342269503373"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7958429602114343" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7958429602114343">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">BannerMessageModel {</span>
<div><span class="propName ">bannerMessageId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>2147483647</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">fromDateUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">toDateUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">canBeHidden</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">urls</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">excludeUrls</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isDeleted</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">createdBy</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>200</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">createdUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">modifiedBy</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>200</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">modifiedUtc</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 class="hljs json">{
"<span class="hljs-attr">bannerMessageId</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">title</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">type</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">content</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">fromDateUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.285Z"</span>,
"<span class="hljs-attr">toDateUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.285Z"</span>,
"<span class="hljs-attr">active</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">canBeHidden</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">urls</span>": [
<span class="hljs-string">"string"</span>
],
"<span class="hljs-attr">excludeUrls</span>": [
<span class="hljs-string">"string"</span>
],
"<span class="hljs-attr">isDeleted</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">createdBy</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">createdUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.285Z"</span>,
"<span class="hljs-attr">modifiedBy</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">modifiedUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.285Z"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code class="hljs xml"><span class="hljs-meta"><?xml version="1.0"?></span>
<span class="hljs-tag"><<span class="hljs-name">BannerMessageModel</span>></span>
<span class="hljs-tag"><<span class="hljs-name">bannerMessageId</span>></span>string<span class="hljs-tag"></<span class="hljs-name">bannerMessageId</span>></span>
<span class="hljs-tag"><<span class="hljs-name">title</span>></span>string<span class="hljs-tag"></<span class="hljs-name">title</span>></span>
<span class="hljs-tag"><<span class="hljs-name">type</span>></span>string<span class="hljs-tag"></<span class="hljs-name">type</span>></span>
<span class="hljs-tag"><<span class="hljs-name">content</span>></span>string<span class="hljs-tag"></<span class="hljs-name">content</span>></span>
<span class="hljs-tag"><<span class="hljs-name">fromDateUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">fromDateUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">toDateUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">toDateUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">active</span>></span>true<span class="hljs-tag"></<span class="hljs-name">active</span>></span>
<span class="hljs-tag"><<span class="hljs-name">canBeHidden</span>></span>true<span class="hljs-tag"></<span class="hljs-name">canBeHidden</span>></span>
<span class="hljs-tag"><<span class="hljs-name">urls</span>></span>string<span class="hljs-tag"></<span class="hljs-name">urls</span>></span>
<span class="hljs-tag"><<span class="hljs-name">excludeUrls</span>></span>string<span class="hljs-tag"></<span class="hljs-name">excludeUrls</span>></span>
<span class="hljs-tag"><<span class="hljs-name">isDeleted</span>></span>true<span class="hljs-tag"></<span class="hljs-name">isDeleted</span>></span>
<span class="hljs-tag"><<span class="hljs-name">createdBy</span>></span>string<span class="hljs-tag"></<span class="hljs-name">createdBy</span>></span>
<span class="hljs-tag"><<span class="hljs-name">createdUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">createdUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">modifiedBy</span>></span>string<span class="hljs-tag"></<span class="hljs-name">modifiedBy</span>></span>
<span class="hljs-tag"><<span class="hljs-name">modifiedUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">modifiedUtc</span>></span>
<span class="hljs-tag"></<span class="hljs-name">BannerMessageModel</span>></span>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="murl0.610621819262422">url</label></td>
<td>
<input class="parameter required" minlength="1" name="url" placeholder="(required)" id="murl0.610621819262422" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbannerMessageModel0.5383511880811871">bannerMessageModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="bannerMessageModel" id="mbannerMessageModel0.5383511880811871"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.016019038697685284" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.016019038697685284">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">BannerMessageModel {</span>
<div><span class="propName ">bannerMessageId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>2147483647</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">fromDateUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">toDateUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">canBeHidden</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">urls</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">excludeUrls</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isDeleted</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">createdBy</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>200</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">createdUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">modifiedBy</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>200</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">modifiedUtc</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 class="hljs json">{
"<span class="hljs-attr">bannerMessageId</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">title</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">type</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">content</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">fromDateUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.293Z"</span>,
"<span class="hljs-attr">toDateUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.293Z"</span>,
"<span class="hljs-attr">active</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">canBeHidden</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">urls</span>": [
<span class="hljs-string">"string"</span>
],
"<span class="hljs-attr">excludeUrls</span>": [
<span class="hljs-string">"string"</span>
],
"<span class="hljs-attr">isDeleted</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">createdBy</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">createdUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.293Z"</span>,
"<span class="hljs-attr">modifiedBy</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">modifiedUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.293Z"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code class="hljs xml"><span class="hljs-meta"><?xml version="1.0"?></span>
<span class="hljs-tag"><<span class="hljs-name">BannerMessageModel</span>></span>
<span class="hljs-tag"><<span class="hljs-name">bannerMessageId</span>></span>string<span class="hljs-tag"></<span class="hljs-name">bannerMessageId</span>></span>
<span class="hljs-tag"><<span class="hljs-name">title</span>></span>string<span class="hljs-tag"></<span class="hljs-name">title</span>></span>
<span class="hljs-tag"><<span class="hljs-name">type</span>></span>string<span class="hljs-tag"></<span class="hljs-name">type</span>></span>
<span class="hljs-tag"><<span class="hljs-name">content</span>></span>string<span class="hljs-tag"></<span class="hljs-name">content</span>></span>
<span class="hljs-tag"><<span class="hljs-name">fromDateUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">fromDateUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">toDateUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">toDateUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">active</span>></span>true<span class="hljs-tag"></<span class="hljs-name">active</span>></span>
<span class="hljs-tag"><<span class="hljs-name">canBeHidden</span>></span>true<span class="hljs-tag"></<span class="hljs-name">canBeHidden</span>></span>
<span class="hljs-tag"><<span class="hljs-name">urls</span>></span>string<span class="hljs-tag"></<span class="hljs-name">urls</span>></span>
<span class="hljs-tag"><<span class="hljs-name">excludeUrls</span>></span>string<span class="hljs-tag"></<span class="hljs-name">excludeUrls</span>></span>
<span class="hljs-tag"><<span class="hljs-name">isDeleted</span>></span>true<span class="hljs-tag"></<span class="hljs-name">isDeleted</span>></span>
<span class="hljs-tag"><<span class="hljs-name">createdBy</span>></span>string<span class="hljs-tag"></<span class="hljs-name">createdBy</span>></span>
<span class="hljs-tag"><<span class="hljs-name">createdUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">createdUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">modifiedBy</span>></span>string<span class="hljs-tag"></<span class="hljs-name">modifiedBy</span>></span>
<span class="hljs-tag"><<span class="hljs-name">modifiedUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">modifiedUtc</span>></span>
<span class="hljs-tag"></<span class="hljs-name">BannerMessageModel</span>></span>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mbannerMessageModel0.21690648892985998">bannerMessageModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="bannerMessageModel" id="mbannerMessageModel0.21690648892985998"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6094986321675737" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6094986321675737">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
<option value="application/xml">application/xml</option>
<option value="text/xml">text/xml</option>
<option value="application/x-www-form-urlencoded">application/x-www-form-urlencoded</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">BannerMessageModel {</span>
<div><span class="propName ">bannerMessageId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">content</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>2147483647</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">fromDateUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">toDateUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">active</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">canBeHidden</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">urls</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">excludeUrls</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isDeleted</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">createdBy</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>200</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">createdUtc</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">modifiedBy</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>200</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName ">modifiedUtc</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 class="hljs json">{
"<span class="hljs-attr">bannerMessageId</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">title</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">type</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">content</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">fromDateUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.296Z"</span>,
"<span class="hljs-attr">toDateUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.296Z"</span>,
"<span class="hljs-attr">active</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">canBeHidden</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">urls</span>": [
<span class="hljs-string">"string"</span>
],
"<span class="hljs-attr">excludeUrls</span>": [
<span class="hljs-string">"string"</span>
],
"<span class="hljs-attr">isDeleted</span>": <span class="hljs-literal">true</span>,
"<span class="hljs-attr">createdBy</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">createdUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.296Z"</span>,
"<span class="hljs-attr">modifiedBy</span>": <span class="hljs-string">"string"</span>,
"<span class="hljs-attr">modifiedUtc</span>": <span class="hljs-string">"2024-08-09T01:08:27.296Z"</span>
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
<div class="snippet_xml" style="display: none;">
<pre><code class="hljs xml"><span class="hljs-meta"><?xml version="1.0"?></span>
<span class="hljs-tag"><<span class="hljs-name">BannerMessageModel</span>></span>
<span class="hljs-tag"><<span class="hljs-name">bannerMessageId</span>></span>string<span class="hljs-tag"></<span class="hljs-name">bannerMessageId</span>></span>
<span class="hljs-tag"><<span class="hljs-name">title</span>></span>string<span class="hljs-tag"></<span class="hljs-name">title</span>></span>
<span class="hljs-tag"><<span class="hljs-name">type</span>></span>string<span class="hljs-tag"></<span class="hljs-name">type</span>></span>
<span class="hljs-tag"><<span class="hljs-name">content</span>></span>string<span class="hljs-tag"></<span class="hljs-name">content</span>></span>
<span class="hljs-tag"><<span class="hljs-name">fromDateUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">fromDateUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">toDateUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">toDateUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">active</span>></span>true<span class="hljs-tag"></<span class="hljs-name">active</span>></span>
<span class="hljs-tag"><<span class="hljs-name">canBeHidden</span>></span>true<span class="hljs-tag"></<span class="hljs-name">canBeHidden</span>></span>
<span class="hljs-tag"><<span class="hljs-name">urls</span>></span>string<span class="hljs-tag"></<span class="hljs-name">urls</span>></span>
<span class="hljs-tag"><<span class="hljs-name">excludeUrls</span>></span>string<span class="hljs-tag"></<span class="hljs-name">excludeUrls</span>></span>
<span class="hljs-tag"><<span class="hljs-name">isDeleted</span>></span>true<span class="hljs-tag"></<span class="hljs-name">isDeleted</span>></span>
<span class="hljs-tag"><<span class="hljs-name">createdBy</span>></span>string<span class="hljs-tag"></<span class="hljs-name">createdBy</span>></span>
<span class="hljs-tag"><<span class="hljs-name">createdUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">createdUtc</span>></span>
<span class="hljs-tag"><<span class="hljs-name">modifiedBy</span>></span>string<span class="hljs-tag"></<span class="hljs-name">modifiedBy</span>></span>
<span class="hljs-tag"><<span class="hljs-name">modifiedUtc</span>></span>1970-01-01T00:00:00.001Z<span class="hljs-tag"></<span class="hljs-name">modifiedUtc</span>></span>
<span class="hljs-tag"></<span class="hljs-name">BannerMessageModel</span>></span>
</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
swagger
Explore
Banner Notification
* BANNERMESSAGES
* Show/Hide
* List Operations
* Expand Operations
* * POST /API/BANNERMESSAGES/ADVANCEDSEARCH
* Searches the Banner Messages
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
BannerMessageModel {
bannerMessageId (string, optional),
title (string, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
fromDateUtc (string, optional),
toDateUtc (string, optional),
active (boolean, optional),
canBeHidden (boolean, optional),
urls (Array[string], optional),
excludeUrls (Array[string], optional),
isDeleted (boolean, optional),
createdBy (string, optional)
stringMax. Length:200
,
createdUtc (string, optional),
modifiedBy (string, optional)
stringMax. Length:200
,
modifiedUtc (string, optional)
}
{
"bannerMessageId": "string",
"title": "string",
"type": "string",
"content": "string",
"fromDateUtc": "2024-08-09T01:08:27.263Z",
"toDateUtc": "2024-08-09T01:08:27.264Z",
"active": true,
"canBeHidden": true,
"urls": [
"string"
],
"excludeUrls": [
"string"
],
"isDeleted": true,
"createdBy": "string",
"createdUtc": "2024-08-09T01:08:27.264Z",
"modifiedBy": "string",
"modifiedUtc": "2024-08-09T01:08:27.264Z"
}
<?xml version="1.0"?>
<BannerMessageModel>
<bannerMessageId>string</bannerMessageId>
<title>string</title>
<type>string</type>
<content>string</content>
<fromDateUtc>1970-01-01T00:00:00.001Z</fromDateUtc>
<toDateUtc>1970-01-01T00:00:00.001Z</toDateUtc>
<active>true</active>
<canBeHidden>true</canBeHidden>
<urls>string</urls>
<excludeUrls>string</excludeUrls>
<isDeleted>true</isDeleted>
<createdBy>string</createdBy>
<createdUtc>1970-01-01T00:00:00.001Z</createdUtc>
<modifiedBy>string</modifiedBy>
<modifiedUtc>1970-01-01T00:00:00.001Z</modifiedUtc>
</BannerMessageModel>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type
messageSearchCriteria
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
MessageSearchCriteria {
id (string, optional),
title (string, optional),
active (boolean, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
url (string, optional)
stringMax. Length:2147483647
,
pageNumber (integer, optional),
pageSize (integer, optional),
sortBy (string, optional),
fromDate (string, optional),
toDate (string, optional)
}
{
"id": "string",
"title": "string",
"active": true,
"type": "string",
"content": "string",
"url": "string",
"pageNumber": 0,
"pageSize": 0,
"sortBy": "string",
"fromDate": "2024-08-09T01:08:27.279Z",
"toDate": "2024-08-09T01:08:27.279Z"
}
<?xml version="1.0"?>
<MessageSearchCriteria>
<id>string</id>
<title>string</title>
<active>true</active>
<type>string</type>
<content>string</content>
<url>string</url>
<pageNumber>1</pageNumber>
<pageSize>1</pageSize>
<sortBy>string</sortBy>
<fromDate>1970-01-01T00:00:00.001Z</fromDate>
<toDate>1970-01-01T00:00:00.001Z</toDate>
</MessageSearchCriteria>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /API/BANNERMESSAGES/DELETEBANNER
* Delete the banner message.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
BannerMessageModel {
bannerMessageId (string, optional),
title (string, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
fromDateUtc (string, optional),
toDateUtc (string, optional),
active (boolean, optional),
canBeHidden (boolean, optional),
urls (Array[string], optional),
excludeUrls (Array[string], optional),
isDeleted (boolean, optional),
createdBy (string, optional)
stringMax. Length:200
,
createdUtc (string, optional),
modifiedBy (string, optional)
stringMax. Length:200
,
modifiedUtc (string, optional)
}
{
"bannerMessageId": "string",
"title": "string",
"type": "string",
"content": "string",
"fromDateUtc": "2024-08-09T01:08:27.284Z",
"toDateUtc": "2024-08-09T01:08:27.284Z",
"active": true,
"canBeHidden": true,
"urls": [
"string"
],
"excludeUrls": [
"string"
],
"isDeleted": true,
"createdBy": "string",
"createdUtc": "2024-08-09T01:08:27.284Z",
"modifiedBy": "string",
"modifiedUtc": "2024-08-09T01:08:27.284Z"
}
<?xml version="1.0"?>
<BannerMessageModel>
<bannerMessageId>string</bannerMessageId>
<title>string</title>
<type>string</type>
<content>string</content>
<fromDateUtc>1970-01-01T00:00:00.001Z</fromDateUtc>
<toDateUtc>1970-01-01T00:00:00.001Z</toDateUtc>
<active>true</active>
<canBeHidden>true</canBeHidden>
<urls>string</urls>
<excludeUrls>string</excludeUrls>
<isDeleted>true</isDeleted>
<createdBy>string</createdBy>
<createdUtc>1970-01-01T00:00:00.001Z</createdUtc>
<modifiedBy>string</modifiedBy>
<modifiedUtc>1970-01-01T00:00:00.001Z</modifiedUtc>
</BannerMessageModel>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type bannerMessageModel
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
BannerMessageModel {
bannerMessageId (string, optional),
title (string, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
fromDateUtc (string, optional),
toDateUtc (string, optional),
active (boolean, optional),
canBeHidden (boolean, optional),
urls (Array[string], optional),
excludeUrls (Array[string], optional),
isDeleted (boolean, optional),
createdBy (string, optional)
stringMax. Length:200
,
createdUtc (string, optional),
modifiedBy (string, optional)
stringMax. Length:200
,
modifiedUtc (string, optional)
}
{
"bannerMessageId": "string",
"title": "string",
"type": "string",
"content": "string",
"fromDateUtc": "2024-08-09T01:08:27.285Z",
"toDateUtc": "2024-08-09T01:08:27.285Z",
"active": true,
"canBeHidden": true,
"urls": [
"string"
],
"excludeUrls": [
"string"
],
"isDeleted": true,
"createdBy": "string",
"createdUtc": "2024-08-09T01:08:27.285Z",
"modifiedBy": "string",
"modifiedUtc": "2024-08-09T01:08:27.285Z"
}
<?xml version="1.0"?>
<BannerMessageModel>
<bannerMessageId>string</bannerMessageId>
<title>string</title>
<type>string</type>
<content>string</content>
<fromDateUtc>1970-01-01T00:00:00.001Z</fromDateUtc>
<toDateUtc>1970-01-01T00:00:00.001Z</toDateUtc>
<active>true</active>
<canBeHidden>true</canBeHidden>
<urls>string</urls>
<excludeUrls>string</excludeUrls>
<isDeleted>true</isDeleted>
<createdBy>string</createdBy>
<createdUtc>1970-01-01T00:00:00.001Z</createdUtc>
<modifiedBy>string</modifiedBy>
<modifiedUtc>1970-01-01T00:00:00.001Z</modifiedUtc>
</BannerMessageModel>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/BANNERMESSAGES
* Gets any active banner messages given the current time and the
requested url. This is the endpoint that the library will invoke to
retrieve a list of
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model [
Inline Model 1
]
Inline Model 1 {
bannerMessageId (string, optional),
title (string, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
fromDateUtc (string, optional),
toDateUtc (string, optional),
active (boolean, optional),
canBeHidden (boolean, optional),
urls (Array[string], optional),
excludeUrls (Array[string], optional),
isDeleted (boolean, optional),
createdBy (string, optional)
stringMax. Length:200
,
createdUtc (string, optional),
modifiedBy (string, optional)
stringMax. Length:200
,
modifiedUtc (string, optional)
}
[
{
"bannerMessageId": "string",
"title": "string",
"type": "string",
"content": "string",
"fromDateUtc": "2024-08-09T01:08:27.288Z",
"toDateUtc": "2024-08-09T01:08:27.288Z",
"active": true,
"canBeHidden": true,
"urls": [
"string"
],
"excludeUrls": [
"string"
],
"isDeleted": true,
"createdBy": "string",
"createdUtc": "2024-08-09T01:08:27.288Z",
"modifiedBy": "string",
"modifiedUtc": "2024-08-09T01:08:27.288Z"
}
]
<?xml version="1.0"?>
<Inline Model>
<bannerMessageId>string</bannerMessageId>
<title>string</title>
<type>string</type>
<content>string</content>
<fromDateUtc>1970-01-01T00:00:00.001Z</fromDateUtc>
<toDateUtc>1970-01-01T00:00:00.001Z</toDateUtc>
<active>true</active>
<canBeHidden>true</canBeHidden>
<urls>string</urls>
<excludeUrls>string</excludeUrls>
<isDeleted>true</isDeleted>
<createdBy>string</createdBy>
<createdUtc>1970-01-01T00:00:00.001Z</createdUtc>
<modifiedBy>string</modifiedBy>
<modifiedUtc>1970-01-01T00:00:00.001Z</modifiedUtc>
</Inline Model>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type url query string
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /API/BANNERMESSAGES
* Creates the banner message.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
BannerMessageModel {
bannerMessageId (string, optional),
title (string, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
fromDateUtc (string, optional),
toDateUtc (string, optional),
active (boolean, optional),
canBeHidden (boolean, optional),
urls (Array[string], optional),
excludeUrls (Array[string], optional),
isDeleted (boolean, optional),
createdBy (string, optional)
stringMax. Length:200
,
createdUtc (string, optional),
modifiedBy (string, optional)
stringMax. Length:200
,
modifiedUtc (string, optional)
}
{
"bannerMessageId": "string",
"title": "string",
"type": "string",
"content": "string",
"fromDateUtc": "2024-08-09T01:08:27.292Z",
"toDateUtc": "2024-08-09T01:08:27.292Z",
"active": true,
"canBeHidden": true,
"urls": [
"string"
],
"excludeUrls": [
"string"
],
"isDeleted": true,
"createdBy": "string",
"createdUtc": "2024-08-09T01:08:27.292Z",
"modifiedBy": "string",
"modifiedUtc": "2024-08-09T01:08:27.292Z"
}
<?xml version="1.0"?>
<BannerMessageModel>
<bannerMessageId>string</bannerMessageId>
<title>string</title>
<type>string</type>
<content>string</content>
<fromDateUtc>1970-01-01T00:00:00.001Z</fromDateUtc>
<toDateUtc>1970-01-01T00:00:00.001Z</toDateUtc>
<active>true</active>
<canBeHidden>true</canBeHidden>
<urls>string</urls>
<excludeUrls>string</excludeUrls>
<isDeleted>true</isDeleted>
<createdBy>string</createdBy>
<createdUtc>1970-01-01T00:00:00.001Z</createdUtc>
<modifiedBy>string</modifiedBy>
<modifiedUtc>1970-01-01T00:00:00.001Z</modifiedUtc>
</BannerMessageModel>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type bannerMessageModel
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
BannerMessageModel {
bannerMessageId (string, optional),
title (string, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
fromDateUtc (string, optional),
toDateUtc (string, optional),
active (boolean, optional),
canBeHidden (boolean, optional),
urls (Array[string], optional),
excludeUrls (Array[string], optional),
isDeleted (boolean, optional),
createdBy (string, optional)
stringMax. Length:200
,
createdUtc (string, optional),
modifiedBy (string, optional)
stringMax. Length:200
,
modifiedUtc (string, optional)
}
{
"bannerMessageId": "string",
"title": "string",
"type": "string",
"content": "string",
"fromDateUtc": "2024-08-09T01:08:27.293Z",
"toDateUtc": "2024-08-09T01:08:27.293Z",
"active": true,
"canBeHidden": true,
"urls": [
"string"
],
"excludeUrls": [
"string"
],
"isDeleted": true,
"createdBy": "string",
"createdUtc": "2024-08-09T01:08:27.293Z",
"modifiedBy": "string",
"modifiedUtc": "2024-08-09T01:08:27.293Z"
}
<?xml version="1.0"?>
<BannerMessageModel>
<bannerMessageId>string</bannerMessageId>
<title>string</title>
<type>string</type>
<content>string</content>
<fromDateUtc>1970-01-01T00:00:00.001Z</fromDateUtc>
<toDateUtc>1970-01-01T00:00:00.001Z</toDateUtc>
<active>true</active>
<canBeHidden>true</canBeHidden>
<urls>string</urls>
<excludeUrls>string</excludeUrls>
<isDeleted>true</isDeleted>
<createdBy>string</createdBy>
<createdUtc>1970-01-01T00:00:00.001Z</createdUtc>
<modifiedBy>string</modifiedBy>
<modifiedUtc>1970-01-01T00:00:00.001Z</modifiedUtc>
</BannerMessageModel>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /API/BANNERMESSAGES
* Updates the banner message.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
BannerMessageModel {
bannerMessageId (string, optional),
title (string, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
fromDateUtc (string, optional),
toDateUtc (string, optional),
active (boolean, optional),
canBeHidden (boolean, optional),
urls (Array[string], optional),
excludeUrls (Array[string], optional),
isDeleted (boolean, optional),
createdBy (string, optional)
stringMax. Length:200
,
createdUtc (string, optional),
modifiedBy (string, optional)
stringMax. Length:200
,
modifiedUtc (string, optional)
}
{
"bannerMessageId": "string",
"title": "string",
"type": "string",
"content": "string",
"fromDateUtc": "2024-08-09T01:08:27.295Z",
"toDateUtc": "2024-08-09T01:08:27.295Z",
"active": true,
"canBeHidden": true,
"urls": [
"string"
],
"excludeUrls": [
"string"
],
"isDeleted": true,
"createdBy": "string",
"createdUtc": "2024-08-09T01:08:27.295Z",
"modifiedBy": "string",
"modifiedUtc": "2024-08-09T01:08:27.295Z"
}
<?xml version="1.0"?>
<BannerMessageModel>
<bannerMessageId>string</bannerMessageId>
<title>string</title>
<type>string</type>
<content>string</content>
<fromDateUtc>1970-01-01T00:00:00.001Z</fromDateUtc>
<toDateUtc>1970-01-01T00:00:00.001Z</toDateUtc>
<active>true</active>
<canBeHidden>true</canBeHidden>
<urls>string</urls>
<excludeUrls>string</excludeUrls>
<isDeleted>true</isDeleted>
<createdBy>string</createdBy>
<createdUtc>1970-01-01T00:00:00.001Z</createdUtc>
<modifiedBy>string</modifiedBy>
<modifiedUtc>1970-01-01T00:00:00.001Z</modifiedUtc>
</BannerMessageModel>
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type bannerMessageModel
Parameter content type: application/json text/json application/xml
text/xml application/x-www-form-urlencoded
body
* Model
* Example Value
BannerMessageModel {
bannerMessageId (string, optional),
title (string, optional),
type (string, optional),
content (string, optional)
stringMax. Length:2147483647
,
fromDateUtc (string, optional),
toDateUtc (string, optional),
active (boolean, optional),
canBeHidden (boolean, optional),
urls (Array[string], optional),
excludeUrls (Array[string], optional),
isDeleted (boolean, optional),
createdBy (string, optional)
stringMax. Length:200
,
createdUtc (string, optional),
modifiedBy (string, optional)
stringMax. Length:200
,
modifiedUtc (string, optional)
}
{
"bannerMessageId": "string",
"title": "string",
"type": "string",
"content": "string",
"fromDateUtc": "2024-08-09T01:08:27.296Z",
"toDateUtc": "2024-08-09T01:08:27.296Z",
"active": true,
"canBeHidden": true,
"urls": [
"string"
],
"excludeUrls": [
"string"
],
"isDeleted": true,
"createdBy": "string",
"createdUtc": "2024-08-09T01:08:27.296Z",
"modifiedBy": "string",
"modifiedUtc": "2024-08-09T01:08:27.296Z"
}
<?xml version="1.0"?>
<BannerMessageModel>
<bannerMessageId>string</bannerMessageId>
<title>string</title>
<type>string</type>
<content>string</content>
<fromDateUtc>1970-01-01T00:00:00.001Z</fromDateUtc>
<toDateUtc>1970-01-01T00:00:00.001Z</toDateUtc>
<active>true</active>
<canBeHidden>true</canBeHidden>
<urls>string</urls>
<excludeUrls>string</excludeUrls>
<isDeleted>true</isDeleted>
<createdBy>string</createdBy>
<createdUtc>1970-01-01T00:00:00.001Z</createdUtc>
<modifiedBy>string</modifiedBy>
<modifiedUtc>1970-01-01T00:00:00.001Z</modifiedUtc>
</BannerMessageModel>
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HEALTHCHECK
* Show/Hide
* List Operations
* Expand Operations
* * GET /API/HEALTHCHECK/FULL
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/HEALTHCHECK/DATABASE
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/HEALTHCHECK/SERVICES
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/HEALTHCHECK/VERSIONNUMBER
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/HEALTHCHECK/REGIONNAME
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /API/HEALTHCHECK/RESOURCEGROUP
*
RESPONSE CLASS (STATUS 200)
string
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: , API VERSION: V1 ]