fundadminmemberuseraccountservice-cat-3.orientsys.com.au
Open in
urlscan Pro
23.196.3.175
Public Scan
Submitted URL: https://fundadminmemberuseraccountservice-cat-3.orientsys.com.au/
Effective URL: https://fundadminmemberuseraccountservice-cat-3.orientsys.com.au/memberuseraccount/docs/index
Submission: On March 12 via api from US — Scanned from US
Effective URL: https://fundadminmemberuseraccountservice-cat-3.orientsys.com.au/memberuseraccount/docs/index
Submission: On March 12 via api from US — Scanned from US
Form analysis 47 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" 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">
<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="mplanCode0.4607307727008534">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.4607307727008534" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mimpersonationTokenRequest0.3464035353523618">impersonationTokenRequest</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="impersonationTokenRequest" id="mimpersonationTokenRequest0.3464035353523618"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5477872556348122" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5477872556348122">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Details of Impersonation Token being requested</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ImpersonationTokenRequestModel {</span><span class="propWrap">
<div><span class="propName ">accessLevel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['NO_ACCESS', 'VIEW_ONLY', 'FULL_ACCESS']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"NO_ACCESS", "VIEW_ONLY", "FULL_ACCESS"</td>
</tr>
</tbody>
</table>,
</div>
<div><span class="propName ">impersonator</span> (<span class="propType">Impersonator</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">member</span> (<span class="propType">TargetMember</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Impersonator {</span>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div><span class="propWrap">
<div><span class="propName ">entityType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['None', 'Advisor', 'OfficeStaff', 'CCPAdmin']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"None", "Advisor", "OfficeStaff", "CCPAdmin"</td>
</tr>
</tbody>
</table>,
</div>
<div><span class="propName ">entityId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">entityName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">TargetMember {</span>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</span>
</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">accessLevel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"NO_ACCESS"</span></span></span></span>,
"<span class="attribute"><span class="attribute">impersonator</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">entityType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"None"</span></span></span></span>,
"<span class="attribute"><span class="attribute">entityId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">entityName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">member</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span>
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.7611654627498521">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.7611654627498521" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mmcxTokenRequestModel0.6677497281601714">mcxTokenRequestModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="mcxTokenRequestModel" id="mmcxTokenRequestModel0.6677497281601714"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9426335718704446" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9426335718704446">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Details of MCX token being requested</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MCXTokenRequestModel {</span>
<div><span class="propName required">planMemberId</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">planMemberReference</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">email</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">userName</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberReference</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">email</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">userName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.20271693701110705">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.20271693701110705" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mplanMemberId0.9964567402260811">planMemberId</label></td>
<td>
<input class="parameter required" minlength="1" name="planMemberId" placeholder="(required)" id="mplanMemberId0.9964567402260811" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The plan member Id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.6856478052431696">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.6856478052431696" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mplanMemberId0.537802211921447">planMemberId</label></td>
<td>
<input class="parameter required" minlength="1" name="planMemberId" placeholder="(required)" id="mplanMemberId0.537802211921447" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The member's plan member id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
<tr>
<td class="code required"><label for="mcreateUpdateEmailTokenModel0.22325133962279242">createUpdateEmailTokenModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="createUpdateEmailTokenModel" id="mcreateUpdateEmailTokenModel0.22325133962279242"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8190489566111756" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8190489566111756">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The payload</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreateUpdateEmailTokenModel {</span>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The new email address</p>
</span>,</div>
<div><span class="propName ">sendNotificationEmails</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>If True the Token Email is sent to the new email and the Warning Email is sent to the old email. If false only the token is generated</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">email</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sendNotificationEmails</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.8158286558072676">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.8158286558072676" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mmemberID0.4597194001221616">memberID</label></td>
<td>
<input class="parameter" minlength="0" name="memberID" placeholder="" id="mmemberID0.4597194001221616" type="text" value="">
</td>
<td class="markdown">
<p>Retirn MJOLII applications linked this member</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mapplicationId0.936166834659814">applicationId</label></td>
<td>
<input class="parameter" minlength="0" name="applicationId" placeholder="" id="mapplicationId0.936166834659814" type="text" value="">
</td>
<td class="markdown">
<p>Returns MJOL application with this internal Id</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mrequestNumber0.9472169061323503">requestNumber</label></td>
<td>
<input class="parameter" minlength="0" name="requestNumber" placeholder="" id="mrequestNumber0.9472169061323503" type="text" value="">
</td>
<td class="markdown">
<p>Returns MJOL Application with this Request Number</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="memailAddress0.01690344533994903">emailAddress</label></td>
<td>
<input class="parameter" minlength="0" name="emailAddress" placeholder="" id="memailAddress0.01690344533994903" type="text" value="">
</td>
<td class="markdown">
<p>Filter applications created with this email address</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="memployerID0.6359640005613885">employerID</label></td>
<td>
<input class="parameter" minlength="0" name="employerID" placeholder="" id="memployerID0.6359640005613885" type="text" value="">
</td>
<td class="markdown">
<p>Return MJOLII applications linked to this employer</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="madviserID0.26858801413099465">adviserID</label></td>
<td>
<input class="parameter" minlength="0" name="adviserID" placeholder="" id="madviserID0.26858801413099465" type="text" value="">
</td>
<td class="markdown">
<p>Returns Applications only for this Adviser</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcreatedDateFrom0.006754790708842107">createdDateFrom</label></td>
<td>
<input class="parameter" minlength="0" name="createdDateFrom" placeholder="" id="mcreatedDateFrom0.006754790708842107" type="text" value="">
</td>
<td class="markdown">
<p>Filter to applaications Created on or after this Date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcreatedDateTo0.46544458988174875">createdDateTo</label></td>
<td>
<input class="parameter" minlength="0" name="createdDateTo" placeholder="" id="mcreatedDateTo0.46544458988174875" type="text" value="">
</td>
<td class="markdown">
<p>Filter to applicatioations Created on or before this date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mmodifiedDateFrom0.8138742225628395">modifiedDateFrom</label></td>
<td>
<input class="parameter" minlength="0" name="modifiedDateFrom" placeholder="" id="mmodifiedDateFrom0.8138742225628395" type="text" value="">
</td>
<td class="markdown">
<p>Filter to applaications Modified on or after this Date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mmodifiedDateTo0.3716881872882729">modifiedDateTo</label></td>
<td>
<input class="parameter" minlength="0" name="modifiedDateTo" placeholder="" id="mmodifiedDateTo0.3716881872882729" type="text" value="">
</td>
<td class="markdown">
<p>Filter to applicatiations Modified on or before this date</p>
</td>
<td>query</td>
<td>
<span class="model-signature">date-time</span>
</td>
</tr>
<tr>
<td class="code"><label for="mgivenName0.37557258186041653">givenName</label></td>
<td>
<input class="parameter" minlength="0" name="givenName" placeholder="" id="mgivenName0.37557258186041653" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfamilyName0.3164763813702842">familyName</label></td>
<td>
<input class="parameter" minlength="0" name="familyName" placeholder="" id="mfamilyName0.3164763813702842" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.0016128911143542535">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.0016128911143542535" type="text" value="">
</td>
<td class="markdown">
<p>Sorting, CSV list, + or - prefix to indicate direction. Valid fields: ApplicationID, RequestNumber, MemberID, EmployerID, EmailAddress, CreatedDate, ModifiedDate, Surname, GivenName. Example: -RequestNumber,+MemberID,+CreatedDate</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="moffset0.38410861536847696">offset</label></td>
<td>
<input class="parameter" minlength="0" name="offset" placeholder="" id="moffset0.38410861536847696" type="text" value="">
</td>
<td class="markdown">
<p>The offset.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.08377626864219057">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.08377626864219057" type="text" value="">
</td>
<td class="markdown">
<p>The limit.</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">
<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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.10956478079360354">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.10956478079360354" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mmjolApplication0.9558966941743581">mjolApplication</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="mjolApplication" id="mmjolApplication0.9558966941743581"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.39616392485237695" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.39616392485237695">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Content of the new MJOL Application.</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreateMJOLApplicationModel {</span>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">memberID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">employerID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">adviserID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">registerMember</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">member</span> (<span class="propType">CreateMemberDetails</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">applicationText</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">CreateMemberDetails {</span>
<div><span class="propName required">isForSuperConsolidationToPension</span> (<span class="propType">boolean</span>),</div><span class="propWrap">
<div><span class="propName ">initialInvestmentElection</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['Nominated', 'None', 'Default', 'Unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"Nominated", "None", "Default", "Unknown"</td>
</tr>
</tbody>
</table>,
</div>
<div><span class="propName ">isPermanentlyRetired</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div><span class="propWrap">
<div><span class="propName ">sourcePlanCode</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>20</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">sourcePlanMemberId</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>20</td>
</tr>
</tbody>
</table>,</div>
<div><span class="propName required">planCode</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">applicationReceivedDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div><span class="propWrap">
<div><span class="propName required">title</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>20</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName required">givenNames</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>120</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName required">familyName</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>120</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName required">gender</span> (<span class="propType">string</span>) = <span class="propVals">['Male', 'Female', 'Unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"Male", "Female", "Unknown"</td>
</tr>
</tbody>
</table>,
</div>
<div><span class="propName required">birthDate</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">classificationId</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">dateJoinedFund</span> (<span class="propType">string</span>),</div>
<div><span class="propName ">addresses</span> (<span class="propType">Array[Address]</span>, <span class="propOptKey">optional</span>),</div><span class="propWrap">
<div><span class="propName required">email</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Max. Length:</td>
<td>120</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">phoneNumber</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>40</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">mobileNumber</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>40</td>
</tr>
</tbody>
</table>,</div>
<div><span class="propName ">tfn</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Address {</span>
<div><span class="propName ">addressType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div><span class="propWrap">
<div><span class="propName ">addressLine1</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>120</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">addressLine2</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>120</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">suburb</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>120</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">state</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>120</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">postCode</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>20</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">countryCode</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>5</td>
</tr>
</tbody>
</table>,</div><span class="propWrap">
<div><span class="propName ">deliveryPointIdentifier</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">integer</th>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>99999999</td>
</tr>
</tbody>
</table>,</div>
<div><span class="propName ">addressStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">memberID</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">employerID</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adviserID</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">registerMember</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">member</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">isForSuperConsolidationToPension</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">initialInvestmentElection</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"Nominated"</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPermanentlyRetired</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">sourcePlanCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">sourcePlanMemberId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">applicationReceivedDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.141Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">title</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">givenNames</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">familyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">gender</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"Male"</span></span></span></span>,
"<span class="attribute"><span class="attribute">birthDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.141Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">classificationId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">dateJoinedFund</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.143Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">addresses</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">addressType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">addressLine1</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">addressLine2</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">suburb</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">state</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">postCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">countryCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deliveryPointIdentifier</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">addressStatus</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">email</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">phoneNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">mobileNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">tfn</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">applicationText</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">201</td>
<td class="markdown">
<p>A user account</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiResponse[MJOLApplicationModel] {</span>
<div><span class="propName ">_links</span> (<span class="propType">Array[ApiLink]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the links. "self" is automatically populated.</p>
</span>,</div>
<div><span class="propName ">resource</span> (<span class="propType">MJOLApplicationModel</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the resource.</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the message.</p>
</span></div><span class="strong">}</span><br><span class="strong">ApiLink {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the relationship name</p>
</span>,</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the href.</p>
</span></div><span class="strong">}</span><br><span class="strong">MJOLApplicationModel {</span>
<div><span class="propName ">applicationID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">requestNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">memberID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">memberName</span> (<span class="propType">Name</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">employerID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">adviserID</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">registerMember</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">directResumeUrl</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">createdDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modifiedDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">submittedDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">passCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Name {</span>
<div><span class="propName ">titleCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">givenName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">familyName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">_links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">resource</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">applicationID</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">requestNumber</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">memberID</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">memberName</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">titleCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">givenName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">familyName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">employerID</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">adviserID</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">registerMember</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">directResumeUrl</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">createdDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.206Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">modifiedDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.206Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">submittedDate</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.206Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">passCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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"></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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.20656450232028356">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.20656450232028356" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the plan being joined in application</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mapplicationId0.9158464030552913">applicationId</label></td>
<td>
<input class="parameter required" minlength="1" name="applicationId" placeholder="(required)" id="mapplicationId0.9158464030552913" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Internal Id number for application</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">long</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.8761519083312908">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.8761519083312908" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mapplicationId0.35737468271482764">applicationId</label></td>
<td>
<input class="parameter required" minlength="1" name="applicationId" placeholder="(required)" id="mapplicationId0.35737468271482764" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id number for a User in Member Centre. Distinct From Aaspire Member Id and User Name</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">
<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"></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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.514307682604833">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.514307682604833" 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="muserId0.6138979703956777">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.6138979703956777" type="text" value="">
</td>
<td>
<strong><span class="markdown"></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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.38101308598512573">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.38101308598512573" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.5790238228948359">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.5790238228948359" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="msecurityQuestionId0.4454039516366808">securityQuestionId</label></td>
<td>
<input class="parameter required" minlength="1" name="securityQuestionId" placeholder="(required)" id="msecurityQuestionId0.4454039516366808" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The security question identifier.</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.019358813104725314">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.019358813104725314" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.8867516407869234">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.8867516407869234" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique Identifier to represent a user in system</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">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.10914821989601609">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.10914821989601609" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.6722340024180773">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.6722340024180773" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique Identifier to represent a user in system</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">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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>NoContent</p>
</td>
<td width="50%"><span class="model-signature"></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 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">
<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">503</td>
<td class="markdown">
<p>Busy</p>
</td>
<td width="50%"><span class="model-signature"></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">
<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="mincludeAllAssemblies0.09703950627033531">includeAllAssemblies</label></td>
<td>
<select class="parameter " name="includeAllAssemblies" id="mincludeAllAssemblies0.09703950627033531">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>if set to true includes resources in all assemblies.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<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">
<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="mdataType0.7195993125996152">dataType</label></td>
<td>
<input class="parameter required" minlength="1" name="dataType" placeholder="(required)" id="mdataType0.7195993125996152" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>uri,rule</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mclient0.8768129912094165">client</label></td>
<td>
<input class="parameter" minlength="0" name="client" placeholder="" id="mclient0.8768129912094165" type="text" value="">
</td>
<td class="markdown">
<p>The clientId (customer name). Mandatory for rule. Ignored for uri.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlistType0.17999783612750608">listType</label></td>
<td>
<input class="parameter" minlength="0" name="listType" placeholder="" id="mlistType0.17999783612750608" type="text" value="">
</td>
<td class="markdown">
<p>sql,raw</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mincludeServiceApis0.4862761470249124">includeServiceApis</label></td>
<td>
<select class="parameter " name="includeServiceApis" id="mincludeServiceApis0.4862761470249124">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>if set to true includes service apis</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<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="mcontentDisposition0.357939653958359">contentDisposition</label></td>
<td>
<input class="parameter" minlength="0" name="contentDisposition" placeholder="" id="mcontentDisposition0.357939653958359" type="text" value="">
</td>
<td class="markdown">
<p>"attachment" or "inline". If not specified "attachment" is used</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mfixups0.37627877275953336">fixups</label></td>
<td>
<select class="parameter " name="fixups" id="mfixups0.37627877275953336">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>if set to true fixups are applied.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth">
<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.8335055822496478">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.8335055822496478" 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">
<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>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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.39161452247640605">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.39161452247640605" 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"><label for="mincDeps0.7314847806987359">incDeps</label></td>
<td>
<select class="parameter " name="incDeps" id="mincDeps0.7314847806987359">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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.2522865150452114">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.2522865150452114" 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="mserviceHealthModel0.6550517266054325">serviceHealthModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="serviceHealthModel" id="mserviceHealthModel0.6550517266054325"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3270052305461384" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3270052305461384">
<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>
</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SystemHealthModel {</span>
<div><span class="propName ">status</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">system</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">version</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">deps</span> (<span class="propType">Array[SystemHealthModel]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">status</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">system</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">version</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deps</span></span>": <span class="value"><span class="value">[
{}
]
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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.3948407100224003">id</label></td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" id="mid0.3948407100224003" 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="mserviceHealthModel0.4184901493506552">serviceHealthModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="serviceHealthModel" id="mserviceHealthModel0.4184901493506552"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7298398089313423" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7298398089313423">
<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>
</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SystemHealthModel {</span>
<div><span class="propName ">status</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">system</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">version</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">deps</span> (<span class="propType">Array[SystemHealthModel]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">status</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">system</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">version</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">deps</span></span>": <span class="value"><span class="value">[
{}
]
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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>OK</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mincDeps0.9557514941962202">incDeps</label></td>
<td>
<select class="parameter " name="incDeps" id="mincDeps0.9557514941962202">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.9919470522259621">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.9919470522259621" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="muserName0.417764431909033">userName</label></td>
<td>
<input class="parameter" minlength="0" name="userName" placeholder="" id="muserName0.417764431909033" type="text" value="">
</td>
<td class="markdown">
<p>User Name of the User account</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mplanMemberID0.9207365502838329">planMemberID</label></td>
<td>
<input class="parameter" minlength="0" name="planMemberID" placeholder="" id="mplanMemberID0.9207365502838329" type="text" value="">
</td>
<td class="markdown">
<p>PlanMemberID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">long</span>
</td>
</tr>
<tr>
<td class="code"><label for="mplanMemberReference0.7314878360077774">planMemberReference</label></td>
<td>
<input class="parameter" minlength="0" name="planMemberReference" placeholder="" id="mplanMemberReference0.7314878360077774" type="text" value="">
</td>
<td class="markdown">
<p>PlanMemberReference</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="memailAddress0.6891358181556031">emailAddress</label></td>
<td>
<input class="parameter" minlength="0" name="emailAddress" placeholder="" id="memailAddress0.6891358181556031" type="text" value="">
</td>
<td class="markdown">
<p>Email Address of the user</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mlimit0.9725955589880768">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.9725955589880768" type="text" value="">
</td>
<td class="markdown">
<p>The limit.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="moffset0.04479031511379872">offset</label></td>
<td>
<input class="parameter" minlength="0" name="offset" placeholder="" id="moffset0.04479031511379872" type="text" value="">
</td>
<td class="markdown">
<p>The offset.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="msort0.28142512664173336">sort</label></td>
<td>
<input class="parameter" minlength="0" name="sort" placeholder="" id="msort0.28142512664173336" type="text" value="">
</td>
<td class="markdown">
<p>Sorting, CSV list, + or - prefix to indicate direction. Valid fields: UserID, UserName, PlanMemberID, EmailAddress, PlanMemberReference, LastLoginDateTime, CreatedDateTime, IsAccountLocked, HasActiveToken Example:
-UserName,+PlanMemberID,+PlanMemberReference</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code"><label for="mcustomerReference0.0719124420620938">customerReference</label></td>
<td>
<input class="parameter" minlength="0" name="customerReference" placeholder="" id="mcustomerReference0.0719124420620938" type="text" value="">
</td>
<td class="markdown">
<p>Customer Refernce</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">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.878513776822681">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.878513776822681" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserAccount0.9868906108537288">userAccount</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="userAccount" id="muserAccount0.9868906108537288"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.38737582921947666" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.38737582921947666">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The user account.</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreateUserAccountModel {</span>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">userName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isActivated</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPlanMemberDefault</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPlanMemberEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPasswordResetRequired</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">classificationId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">securityQuestion</span> (<span class="propType">Array[UserAccountSecurityQuestionAnswerModel]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">UserAccountSecurityQuestionAnswerModel {</span>
<div><span class="propName ">securityQuestionId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">securityQuestion</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">securityQuestionAnswer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">userName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberReference</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">password</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">isActivated</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPlanMemberDefault</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPlanMemberEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPasswordResetRequired</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">classificationId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">securityQuestion</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">securityQuestionId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">securityQuestion</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">securityQuestionAnswer</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">201</td>
<td class="markdown">
<p>A user account</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiResponse[UserAccountModel] {</span>
<div><span class="propName ">_links</span> (<span class="propType">Array[ApiLink]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the links. "self" is automatically populated.</p>
</span>,</div>
<div><span class="propName ">resource</span> (<span class="propType">UserAccountModel</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the resource.</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the message.</p>
</span></div><span class="strong">}</span><br><span class="strong">ApiLink {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the relationship name</p>
</span>,</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the href.</p>
</span></div><span class="strong">}</span><br><span class="strong">UserAccountModel {</span>
<div><span class="propName ">id</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">userName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isActivated</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPlanMemberDefault</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPlanMemberEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPasswordResetRequired</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hasLinkedAccounts</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isAccountLocked</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">lastLoginDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">createdDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isLockedOutFailedAttempts</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">failedAttemptsLockedDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isAccountLockedAdmin</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">adminLockDateTime</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">linkedMembers</span> (<span class="propType">Array[LinkedMembersModel]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">LinkedMembersModel
{</span>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">userName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPrimary</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">_links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">resource</span></span>": <span class="value"><span class="value">{
"<span class="attribute"><span class="attribute">id</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">userName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">isActivated</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPlanMemberDefault</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPlanMemberEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPasswordResetRequired</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">hasLinkedAccounts</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">isAccountLocked</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">lastLoginDateTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.263Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberReference</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">createdDateTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.263Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">isLockedOutFailedAttempts</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">failedAttemptsLockedDateTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.263Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">isAccountLockedAdmin</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">adminLockDateTime</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"2024-03-12T12:51:58.263Z"</span></span></span></span>,
"<span class="attribute"><span class="attribute">linkedMembers</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberReference</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">userName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPrimary</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span>
]
}</span></span></span><span class="value"></span></span>,
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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"></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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.1938940318815685">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.1938940318815685" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.49115736287109324">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.49115736287109324" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id number for a User in Member Centre. Distinct From Aaspire Member Id and User Name</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">
<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>NoContent</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.033814571279084715">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.033814571279084715" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.02051578519032682">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.02051578519032682" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id number for a User in Member Centre. Distinct From Aaspire Member Id and User Name</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mlimit0.3892051540369652">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.3892051540369652" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="moffset0.8913800559054725">offset</label></td>
<td>
<input class="parameter" minlength="0" name="offset" placeholder="" id="moffset0.8913800559054725" type="text" value="">
</td>
<td class="markdown"></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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.37565203741361985">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.37565203741361985" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.7759458733360163">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.7759458733360163" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id number for a User in Member Centre. Distinct From Aaspire Member Id and User Name</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="muserModel0.562782731236183">userModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="userModel" id="muserModel0.562782731236183"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5381058416421152" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5381058416421152">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The user account.</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserModel {</span>
<div><span class="propName ">userName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">emailAddress</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">userName</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">emailAddress</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberReference</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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"></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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.6533297296591878">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.6533297296591878" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.15136412170449876">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.15136412170449876" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id number for a User in Member Centre. Distinct From Aaspire Member Id and User Name</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="muserPasswordModel0.6397297330908014">userPasswordModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="userPasswordModel" id="muserPasswordModel0.6397297330908014"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.06110463939089339" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.06110463939089339">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>User Password model that contains old and new password</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PasswordModel {</span>
<div><span class="propName ">oldPassword</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">newPassword</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">token</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">oldPassword</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">newPassword</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">token</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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"></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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.4521082385859878">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.4521082385859878" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.36128423734471427">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.36128423734471427" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id of the user.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mstatus0.49297414315016974">status</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="status" id="mstatus0.49297414315016974"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.07751209703492123" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.07751209703492123">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Controls whether to Enable or Disable the User</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UpdateUserAccountStatusModel {</span>
<div><span class="propName ">isEnabled</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">isEnabled</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.6671237107837966">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.6671237107837966" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The plan code.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserName0.7352679179068053">userName</label></td>
<td>
<input class="parameter required" minlength="1" name="userName" placeholder="(required)" id="muserName0.7352679179068053" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="moneTimePasswordRequest0.681115377963182">oneTimePasswordRequest</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="oneTimePasswordRequest" id="moneTimePasswordRequest0.681115377963182"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5432916729413086" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5432916729413086">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The one time password request.</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserAccountOneTimePasswordModel {</span>
<div><span class="propName required">length</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>The length of the one time password. Minimum 6</p>
</span>,</div>
<div><span class="propName required">purpose</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The intent of the one time password. Used for audit. Free text. "Registration", "UpdateAddress", "ChangePassword", "UpdateEmail" etc.</p>
</span>,</div>
<div><span class="propName required">timeToLiveSeconds</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>The number of seconds the one time password remains valid after creation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">length</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">purpose</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">timeToLiveSeconds</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>User does not exist</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.5381930822925296">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.5381930822925296" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character alphanumeric code of the User's Plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.28804848399430805">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.28804848399430805" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique Identifier to represent a user in system. Different from aaspire Plan Member Id and User Name</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.301383489275417">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.301383489275417" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.5562318535299089">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.5562318535299089" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique Identifier to represent a user in system. Different from aaspire Plan Member Id and User Name</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.05270804445637056">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.05270804445637056" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.43115417483536556">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.43115417483536556" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.18449185126316636">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.18449185126316636" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id number for a User in Member Centre. Distinct From Aaspire Member Id and User Name</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mforgottenPasswordRequest0.7338480820394162">forgottenPasswordRequest</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="forgottenPasswordRequest" id="mforgottenPasswordRequest0.7338480820394162"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9222132151026126" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9222132151026126">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Flag indicating whether or not to return a token link to Member Centre</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ForgottenPasswordRequestModel {</span>
<div><span class="propName ">generateResetTokenUrl</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">generateResetTokenUrl</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.725538283678649">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.725538283678649" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.5068504461986829">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.5068504461986829" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id number for a User in Member Centre. Distinct From Aaspire Member Id and User Name</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mresetToken0.33753529886174305">resetToken</label></td>
<td>
<input class="parameter required" minlength="1" name="resetToken" placeholder="(required)" id="mresetToken0.33753529886174305" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Previously Provided Token Value</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mforgottenPasswordResetModel0.3483470029719611">forgottenPasswordResetModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="forgottenPasswordResetModel" id="mforgottenPasswordResetModel0.3483470029719611"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3946835137157936" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3946835137157936">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The forgotten password reset</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ForgottenPasswordResetModel {</span>
<div><span class="propName ">securityQuestionResponses</span> (<span class="propType">Array[SecurityQuestionResponse]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">resetToken</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">newPassword</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">SecurityQuestionResponse {</span>
<div><span class="propName ">securityQuestionId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">securityAnswer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">securityQuestionResponses</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">securityQuestionId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">securityAnswer</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">resetToken</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">newPassword</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.08579298332712937">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.08579298332712937" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The plan code</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.5689950457648889">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.5689950457648889" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user identifier</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code"><label for="mlimit0.802669129700671">limit</label></td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" id="mlimit0.802669129700671" type="text" value="">
</td>
<td class="markdown">
<p>The limit</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code"><label for="moffset0.13275951517770945">offset</label></td>
<td>
<input class="parameter" minlength="0" name="offset" placeholder="" id="moffset0.13275951517770945" type="text" value="">
</td>
<td class="markdown">
<p>The offset</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">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.8312277773401673">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.8312277773401673" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the member's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.06436728805508674">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.06436728805508674" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user identifier</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mlinkedMember0.16676808539899013">linkedMember</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="linkedMember" id="mlinkedMember0.16676808539899013"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.31778578147210035" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.31778578147210035">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The linked member</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreateLinkedMemberModel {</span>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">memberReference</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the member reference. Optional, only necessary when Member Reference != PlanMemberId.</p>
</span>,</div>
<div><span class="propName ">isPrimary</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">memberReference</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPrimary</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">201</td>
<td class="markdown">
<p>A linked member</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiResponse[List[LinkedMemberModel]] {</span>
<div><span class="propName ">_links</span> (<span class="propType">Array[ApiLink]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the links. "self" is automatically populated.</p>
</span>,</div>
<div><span class="propName ">resource</span> (<span class="propType">Array[LinkedMemberModel]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the resource.</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the message.</p>
</span></div><span class="strong">}</span><br><span class="strong">ApiLink {</span>
<div><span class="propName ">rel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the relationship name</p>
</span>,</div>
<div><span class="propName ">href</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the href.</p>
</span></div><span class="strong">}</span><br><span class="strong">LinkedMemberModel {</span>
<div><span class="propName ">userPlanMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">userId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">isPrimary</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">planMemberRefernce</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">_links</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">rel</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">href</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">resource</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">userPlanMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">userId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">planCode</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">isPrimary</span></span>": <span class="value"><span class="literal"><span class="value"><span class="literal">true</span></span></span></span>,
"<span class="attribute"><span class="attribute">planMemberRefernce</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.09849898702502258">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.09849898702502258" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the member's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.6072438381760921">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.6072438381760921" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user identifier</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="muserPlanMemberId0.3200804668715811">userPlanMemberId</label></td>
<td>
<input class="parameter required" minlength="1" name="userPlanMemberId" placeholder="(required)" id="muserPlanMemberId0.3200804668715811" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user plan member identifier</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">
<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>NoContent</p>
</td>
<td width="50%"><span class="model-signature"></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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.5128676223559083">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.5128676223559083" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.8404174116198111">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.8404174116198111" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Id number for a User in Member Centre. Distinct From Aaspire Member Id and User Name</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.8488342122864183">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.8488342122864183" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.6999620974386076">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.6999620974386076" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user identifier</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="msecurityQuestionAnswer0.8221767944054967">securityQuestionAnswer</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="securityQuestionAnswer" id="msecurityQuestionAnswer0.8221767944054967"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9303458374262901" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9303458374262901">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The user security question</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">NewUserSecurityQuestionAnswerModel {</span>
<div><span class="propName ">questions</span> (<span class="propType">Array[CreateUserSecurityQuestionAnswerModel]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">CreateUserSecurityQuestionAnswerModel
{</span>
<div><span class="propName ">securityQuestionId</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">securityQuestionAnswer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">questions</span></span>": <span class="value"><span class="value">[
{
"<span class="attribute"><span class="attribute">securityQuestionId</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">securityQuestionAnswer</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span>
]</span></span>,
"<span class="attribute"><span class="attribute">password</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td class="markdown">
<p>Forbidden</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.47508024815855254">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.47508024815855254" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the User's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="msessionId0.7727834573432193">sessionId</label></td>
<td>
<input class="parameter required" minlength="1" name="sessionId" placeholder="(required)" id="msessionId0.7727834573432193" 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">
<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">401</td>
<td class="markdown">
<p>Unauthorized</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.9231618854317025">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.9231618854317025" 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="muserId0.5738955773979735">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.5738955773979735" type="text" value="">
</td>
<td>
<strong><span class="markdown"></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">
<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">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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">
<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="mplanCode0.9784495226959853">planCode</label></td>
<td>
<input class="parameter required" minlength="1" name="planCode" placeholder="(required)" id="mplanCode0.9784495226959853" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Two character Alphanumeric code of the member's plan</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="muserId0.6593509833760294">userId</label></td>
<td>
<input class="parameter required" minlength="1" name="userId" placeholder="(required)" id="muserId0.6593509833760294" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user identifier</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required"><label for="mcreateUserVerifiedIdentityModel0.47878869247933387">createUserVerifiedIdentityModel</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="createUserVerifiedIdentityModel" id="mcreateUserVerifiedIdentityModel0.47878869247933387"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09480620524152616" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09480620524152616">
<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>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>itsme userId</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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreateUserVerifiedIdentityModel {</span>
<div><span class="propName ">verifiedIdentityUserId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">verifiedIdentityUserId</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span><span class="value">
}</span></span></code></pre>
<small class="notice" data-sw-translate="">Click to set as parameter value</small>
</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">
<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>NoContent</p>
</td>
<td width="50%"><span class="model-signature"></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"></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"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature"></span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">default</td>
<td class="markdown">
<p>Default response</p>
</td>
<td width="50%"><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="">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApiError {</span>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">exceptionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stackTrace</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">innerException</span> (<span class="propType">ApiError</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">source</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">helpLink</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">hResult</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">data</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">modelState</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the state of the model. Populated if action or controller is decorated with [ModelValidationFilter].</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute"><span class="attribute">message</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionMessage</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">exceptionType</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">stackTrace</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">innerException</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">source</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">helpLink</span></span>": <span class="value"><span class="string"><span class="value"><span class="string">"string"</span></span></span></span>,
"<span class="attribute"><span class="attribute">hResult</span></span>": <span class="value"><span class="number"><span class="value"><span class="number">0</span></span></span></span>,
"<span class="attribute"><span class="attribute">data</span></span>": <span class="value"><span class="value">{}</span></span>,
"<span class="attribute"><span class="attribute">modelState</span></span>": <span class="value"><span class="value">{}
}</span></span></code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</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
swagger
Explore
Fund Admin Member User Management Service
HTTP Headers
HTTP HEADERS
X-CORRELATION-ID
All responses from the service contain an X-Correlation-Id header containing a
unique GUID per request. If the request contains an X-Correlation-Id HTTP Header
the service will use this value, otherwise it will generate a new correlation
id.
The correlation id is a GUID in 8-4-4-12 format.
X-CORRELATION-*
Additional correlation information can be specified by adding additional headers
beginning with "X-Correlation-".
All X-Correlation- headers are recorded in our logs and MUST NOT contain any
information that is confidential or compromises the caller’s security.
%timeoffsetHeaderDetails%
Authorisation
Unless otherwise specified, all requests must contain a valid OAUTH2
Authorization header containing a bearer access token. Access Tokens are
acquired from LinkGroup's OAuth2/OIDC IDP.
Callers will need to choose the appropriate flow -- Client Credentials for back
end to API and Resource Owner or Hybrid for client to API. Consult with
LinkGroup to determine which flow is appropriate for your use case.
The Client Credentials flow would have these steps:
1. Client Application requests an Access Token from our OAUTH2 Identity
Provider token endpoint:
https://idsrv-cat-3.orientcapital.local/core/20/connect/token
2. The token endpoint returns an Access Token
3. Subsequent method requests are authenticated by including the Access Token
in the request’s Authorization header
The Resource Owner flow would have these steps
1. Client Application acquires username and password
2. Client Application requests an Access Token from our OAUTH2 Identity
Provider token endpoint:
https://idsrv-cat-3.orientcapital.local/core/20/connect/token
3. Subsequent method requests are authenticated by including the Access Token
in the request’s Authorization header
The Hybrid flow redirects to the LinkGroup IDP to verify the user identity
before redirecting back to the application.
Sample authorisation using Client Credentials flow
// 1. Obtain an OAUTH2 access token from the Identity Provider
var tokenUri = new Uri("https://idsrv-cat-3.orientcapital.local/core/20/connect/token");
// obtain OAUTH token
var responseContent = "";
using (var client = new WebClient())
{
var parameters = new System.Collections.Specialized.NameValueCollection();
// OAUTH2 parameters
parameters.Add("grant_type", "client_credentials");
parameters.Add("client_id", "1000000000000002-dev.registryservices.linkgroup.com");
parameters.Add("client_secret", "limejelly");
parameters.Add("scope", "read write")
// POST request to /memberuseraccount/token
var responseBytes = client.UploadValues(tokenUri, "POST", parameters);
responseContent = Encoding.UTF8.GetString(responseBytes);
}
// 2. Use the OAUTH access token when calling GET FooBar
var foobarUri = new Uri("https://fundadminmemberuseraccountservice-cat-3.orientcapital.local/memberuseraccount/foobar/2000");
var response = JObject.Parse(responseContent);
var tokenType = (string)response["token_type"];
var token = (string)response["access_token"];
using (var client = new WebClient())
{
// Add OAUTH2 access token to request
client.Headers.Add("Authorization", tokenType + " " + token);
// GET request to /memberuseraccount/foobar
responseContent = client.DownloadString(foobarUri);
// :TODO: 401==the access token has expired, request a new one, try again
var foobar = JObject.Parse(responseContent);
var balanceAvailable = (decimal)investorBalanceDetails["balanceAvailable"];
// etc
}
FUND ADMIN MEMBER USER MANAGEMENT SERVICE DOCUMENTATION
* IMPERSONATIONTOKENS
* Show/Hide
* List Operations
* Expand Operations
* * POST /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/IMPERSONATIONTOKENS
* Request an Impersonation Token and token link, to allow user to access
Member Centre with the specifeid entity
IMPLEMENTATION NOTES
Could not find POST.ImpersonationToken.md documentation. Make sure it's
an Embedded Resource in the API project
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Forgotten Password Response
* Model
* Model Schema
ApiResponse[ImpersonationTokenResponseModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (ImpersonationTokenResponseModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
ImpersonationTokenResponseModel {
tokenUrl (string, optional),
accessLevel (string, optional) = ['NO_ACCESS', 'VIEW_ONLY',
'FULL_ACCESS']
stringEnum:"NO_ACCESS", "VIEW_ONLY", "FULL_ACCESS"
,
impersonator (ImpersonatorResponse, optional),
member (TargetMember, optional)
}
ImpersonatorResponse {
planCode (string, optional),
entityType (string, optional) = ['None', 'Advisor', 'OfficeStaff',
'CCPAdmin']
stringEnum:"None", "Advisor", "OfficeStaff", "CCPAdmin"
,
entityId (integer, optional)
}
TargetMember {
planCode (string, optional),
planMemberId (integer, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"tokenUrl": "string",
"accessLevel": "NO_ACCESS",
"impersonator": {
"planCode": "string",
"entityType": "None",
"entityId": 0
},
"member": {
"planCode": "string",
"planMemberId": 0
}
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string impersonationTokenRequest
Parameter content type: application/json text/json application/xml
text/xml
Details of Impersonation Token being requested
body
* Model
* Model Schema
ImpersonationTokenRequestModel {
accessLevel (string, optional) = ['NO_ACCESS', 'VIEW_ONLY',
'FULL_ACCESS']
stringEnum:"NO_ACCESS", "VIEW_ONLY", "FULL_ACCESS"
,
impersonator (Impersonator, optional),
member (TargetMember, optional)
}
Impersonator {
planCode (string, optional),
entityType (string, optional) = ['None', 'Advisor', 'OfficeStaff',
'CCPAdmin']
stringEnum:"None", "Advisor", "OfficeStaff", "CCPAdmin"
,
entityId (integer, optional),
entityName (string, optional)
}
TargetMember {
planCode (string, optional),
planMemberId (integer, optional)
}
{
"accessLevel": "NO_ACCESS",
"impersonator": {
"planCode": "string",
"entityType": "None",
"entityId": 0,
"entityName": "string"
},
"member": {
"planCode": "string",
"planMemberId": 0
}
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Forbidden
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MCXTOKEN
* Show/Hide
* List Operations
* Expand Operations
* * POST /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/MCXTOKEN
* Requests a access token link to access member centre pages from MCX
web.
IMPLEMENTATION NOTES
CREATE MEMBER CENTRE ACCESS TOKEN
This api can be used to get a token to access member centre pages.
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
MCX token response
* Model
* Model Schema
ApiResponse[MCXTokenResponseModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (MCXTokenResponseModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
MCXTokenResponseModel {
tokenUrl (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"tokenUrl": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string mcxTokenRequestModel
Parameter content type: application/json text/json application/xml
text/xml
Details of MCX token being requested
body
* Model
* Model Schema
MCXTokenRequestModel {
planMemberId (string),
planMemberReference (string),
email (string),
userName (string)
}
{
"planMemberId": "string",
"planMemberReference": "string",
"email": "string",
"userName": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 403
Forbidden
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MEMBERUPDATEEMAILTOKENS
* Show/Hide
* List Operations
* Expand Operations
* * GET
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/MEMBERS/{PLANMEMBERID}/EMAILTOKENS
* Retrieves List of outstanding Update Email tokens
IMPLEMENTATION NOTES
Could not find GET.EmailTokens.md documentation. Make sure it's an
Embedded Resource in the API project
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
An update email token link
* Model
* Model Schema
ApiResponse[List[UpdateEmailTokenModel]] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Array[UpdateEmailTokenModel], optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UpdateEmailTokenModel {
planCode (string, optional),
planMemberId (integer, optional),
email (string, optional),
token (string, optional),
tokenUrl (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": [
{
"planCode": "string",
"planMemberId": 0,
"email": "string",
"token": "string",
"tokenUrl": "string"
}
],
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string planMemberId
The plan member Id
path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/MEMBERS/{PLANMEMBERID}/EMAILTOKENS
* Create a new Update Email token, optionally email token link to new
Email Address, and warning email to Old Email Address
IMPLEMENTATION NOTES
Could not find POST.EmailToken.md documentation. Make sure it's an
Embedded Resource in the API project
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
An email token link
* Model
* Model Schema
ApiResponse[CreateUpdateEmailTokenResponseModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (CreateUpdateEmailTokenResponseModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
CreateUpdateEmailTokenResponseModel {
planCode (string, optional),
planMemberId (integer, optional),
email (string, optional),
token (string, optional),
tokenUrl (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"planCode": "string",
"planMemberId": 0,
"email": "string",
"token": "string",
"tokenUrl": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string planMemberId
The member's plan member id
path long createUpdateEmailTokenModel
Parameter content type: application/json text/json application/xml
text/xml
The payload
body
* Model
* Model Schema
CreateUpdateEmailTokenModel {
planCode (string, optional),
planMemberId (integer, optional),
email (string, optional):
The new email address
,
sendNotificationEmails (boolean, optional):
If True the Token Email is sent to the new email and the Warning Email is
sent to the old email. If false only the token is generated
}
{
"planCode": "string",
"planMemberId": 0,
"email": "string",
"sendNotificationEmails": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MJOLAPPLICATIONS
* Show/Hide
* List Operations
* Expand Operations
* * GET /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/MJOLAPPLICATIONS
* Searches for and returns a list of in progress MJOL applications
IMPLEMENTATION NOTES
GET MJOL APPLICATIONS
This API is used to search for existing MJOL Applications. MJOL
Applications are searched by filter criteria, and returned as a MJOL
application listing collection. To retrieve the content of an MJOL
Application, use GET .../MJOLApplication/{applicationID}.
RESPONSE FIELDS
Field Use/Value <ApplicationID> Identifier for Application
<RequestNumber> Request number, entered into Resume Page of MJOL
<PlanCode> Plan Code to Create new Member for <EmailAddress> Email
Address to use for saving/resuming application. Note this is not
Pre-Populated to the Member Profile Module, and should be specified
separately if required <MemberID> Existing Member to Update, if this is
an MJOL II application. Otherwise Null <EmployerID> Employer Linked to
application, if applicable <AdviserID> Advisor Linked to application, if
applicable <RegisterMember> True if Member Should be registered at end of
process.
False if Member should not be registered, and Password and CAPTCHA
modules should not be shown <DirectResumeURL> Direct Resume URL.
Following link should resume application, at most recently completed
module <MemberName> Title, First Name and Surname of Member, as entered
in Member Profile Module <CreatedDate> Date MJOL Application Created
<ModifiedDate> Date MJOL Application Last Modified <SubmittedDate> Date
MJOL Application Submitted
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
MJOL applications collection
* Model
* Model Schema
ApiResponse[List[MJOLApplicationModel]] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Array[MJOLApplicationModel], optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
MJOLApplicationModel {
applicationID (string, optional),
requestNumber (string, optional),
planCode (string, optional),
emailAddress (string, optional),
memberID (string, optional),
memberName (Name, optional),
employerID (string, optional),
adviserID (string, optional),
registerMember (boolean, optional),
directResumeUrl (string, optional),
createdDate (string, optional),
modifiedDate (string, optional),
submittedDate (string, optional),
passCode (string, optional)
}
Name {
titleCode (string, optional),
givenName (string, optional),
familyName (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": [
{
"applicationID": "string",
"requestNumber": "string",
"planCode": "string",
"emailAddress": "string",
"memberID": "string",
"memberName": {
"titleCode": "string",
"givenName": "string",
"familyName": "string"
},
"employerID": "string",
"adviserID": "string",
"registerMember": true,
"directResumeUrl": "string",
"createdDate": "2024-03-12T12:51:58.189Z",
"modifiedDate": "2024-03-12T12:51:58.189Z",
"submittedDate": "2024-03-12T12:51:58.189Z",
"passCode": "string"
}
],
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string memberID
Retirn MJOLII applications linked this member
query string applicationId
Returns MJOL application with this internal Id
query string requestNumber
Returns MJOL Application with this Request Number
query string emailAddress
Filter applications created with this email address
query string employerID
Return MJOLII applications linked to this employer
query string adviserID
Returns Applications only for this Adviser
query string createdDateFrom
Filter to applaications Created on or after this Date
query date-time createdDateTo
Filter to applicatioations Created on or before this date
query date-time modifiedDateFrom
Filter to applaications Modified on or after this Date
query date-time modifiedDateTo
Filter to applicatiations Modified on or before this date
query date-time givenName query string familyName query string sort
Sorting, CSV list, + or - prefix to indicate direction. Valid fields:
ApplicationID, RequestNumber, MemberID, EmployerID, EmailAddress,
CreatedDate, ModifiedDate, Surname, GivenName. Example:
-RequestNumber,+MemberID,+CreatedDate
query string offset
The offset.
query integer limit
The limit.
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/MJOLAPPLICATIONS
* Creates a New MJOL Application
IMPLEMENTATION NOTES
Could not find POST.MJOLApplication.md documentation. Make sure it's an
Embedded Resource in the API project
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
ApiResponse[MJOLApplicationModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (MJOLApplicationModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
MJOLApplicationModel {
applicationID (string, optional),
requestNumber (string, optional),
planCode (string, optional),
emailAddress (string, optional),
memberID (string, optional),
memberName (Name, optional),
employerID (string, optional),
adviserID (string, optional),
registerMember (boolean, optional),
directResumeUrl (string, optional),
createdDate (string, optional),
modifiedDate (string, optional),
submittedDate (string, optional),
passCode (string, optional)
}
Name {
titleCode (string, optional),
givenName (string, optional),
familyName (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"applicationID": "string",
"requestNumber": "string",
"planCode": "string",
"emailAddress": "string",
"memberID": "string",
"memberName": {
"titleCode": "string",
"givenName": "string",
"familyName": "string"
},
"employerID": "string",
"adviserID": "string",
"registerMember": true,
"directResumeUrl": "string",
"createdDate": "2024-03-12T12:51:58.202Z",
"modifiedDate": "2024-03-12T12:51:58.202Z",
"submittedDate": "2024-03-12T12:51:58.202Z",
"passCode": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string mjolApplication
Parameter content type: application/json text/json application/xml
text/xml
Content of the new MJOL Application.
body
* Model
* Model Schema
CreateMJOLApplicationModel {
planCode (string, optional),
emailAddress (string, optional),
memberID (string, optional),
employerID (string, optional),
adviserID (string, optional),
registerMember (boolean, optional),
member (CreateMemberDetails, optional),
applicationText (string, optional)
}
CreateMemberDetails {
isForSuperConsolidationToPension (boolean),
initialInvestmentElection (string, optional) = ['Nominated', 'None',
'Default', 'Unknown']
stringEnum:"Nominated", "None", "Default", "Unknown"
,
isPermanentlyRetired (boolean, optional),
sourcePlanCode (string, optional)
stringMax. Length:20
,
sourcePlanMemberId (string, optional)
stringMax. Length:20
,
planCode (string),
applicationReceivedDate (string, optional),
title (string)
stringMax. Length:20
,
givenNames (string)
stringMax. Length:120
,
familyName (string)
stringMax. Length:120
,
gender (string) = ['Male', 'Female', 'Unknown']
stringEnum:"Male", "Female", "Unknown"
,
birthDate (string),
classificationId (string),
dateJoinedFund (string),
addresses (Array[Address], optional),
email (string)
stringMax. Length:120
,
phoneNumber (string, optional)
stringMax. Length:40
,
mobileNumber (string, optional)
stringMax. Length:40
,
tfn (string, optional)
}
Address {
addressType (string, optional),
addressLine1 (string, optional)
stringMax. Length:120
,
addressLine2 (string, optional)
stringMax. Length:120
,
suburb (string, optional)
stringMax. Length:120
,
state (string, optional)
stringMax. Length:120
,
postCode (string, optional)
stringMax. Length:20
,
countryCode (string, optional)
stringMax. Length:5
,
deliveryPointIdentifier (integer, optional)
integerMax. Value:99999999
,
addressStatus (string, optional)
}
{
"planCode": "string",
"emailAddress": "string",
"memberID": "string",
"employerID": "string",
"adviserID": "string",
"registerMember": true,
"member": {
"isForSuperConsolidationToPension": true,
"initialInvestmentElection": "Nominated",
"isPermanentlyRetired": true,
"sourcePlanCode": "string",
"sourcePlanMemberId": "string",
"planCode": "string",
"applicationReceivedDate": "2024-03-12T12:51:58.141Z",
"title": "string",
"givenNames": "string",
"familyName": "string",
"gender": "Male",
"birthDate": "2024-03-12T12:51:58.141Z",
"classificationId": "string",
"dateJoinedFund": "2024-03-12T12:51:58.143Z",
"addresses": [
{
"addressType": "string",
"addressLine1": "string",
"addressLine2": "string",
"suburb": "string",
"state": "string",
"postCode": "string",
"countryCode": "string",
"deliveryPointIdentifier": 0,
"addressStatus": "string"
}
],
"email": "string",
"phoneNumber": "string",
"mobileNumber": "string",
"tfn": "string"
},
"applicationText": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 201
A user account
* Model
* Model Schema
ApiResponse[MJOLApplicationModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (MJOLApplicationModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
MJOLApplicationModel {
applicationID (string, optional),
requestNumber (string, optional),
planCode (string, optional),
emailAddress (string, optional),
memberID (string, optional),
memberName (Name, optional),
employerID (string, optional),
adviserID (string, optional),
registerMember (boolean, optional),
directResumeUrl (string, optional),
createdDate (string, optional),
modifiedDate (string, optional),
submittedDate (string, optional),
passCode (string, optional)
}
Name {
titleCode (string, optional),
givenName (string, optional),
familyName (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"applicationID": "string",
"requestNumber": "string",
"planCode": "string",
"emailAddress": "string",
"memberID": "string",
"memberName": {
"titleCode": "string",
"givenName": "string",
"familyName": "string"
},
"employerID": "string",
"adviserID": "string",
"registerMember": true,
"directResumeUrl": "string",
"createdDate": "2024-03-12T12:51:58.206Z",
"modifiedDate": "2024-03-12T12:51:58.206Z",
"submittedDate": "2024-03-12T12:51:58.206Z",
"passCode": "string"
},
"message": "string"
}
400
BadRequest
401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/MJOLAPPLICATIONS/{APPLICATIONID}
* Cancels an InProgress MJOL applications
IMPLEMENTATION NOTES
Could not find DELETE.MJOLApplication.md documentation. Make sure it's an
Embedded Resource in the API project
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Cancels MJOL Application
* Model
* Model Schema
ApiResponse[Boolean] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (boolean, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": true,
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the plan being joined in application
path string applicationId
Internal Id number for application
path long
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/MJOLAPPLICATIONS/{APPLICATIONID}
* Retrieves an MJOL Application with the specified Id, including the XML
IMPLEMENTATION NOTES
GET MJOL APPLICATION
This API is used internally by Member Centre applications, to take an
MJOL Application ID, and retrieve the data required.
RESPONSE FIELDS
<ApplicationID> Identifier for Application <RequestNumber> Request
number, entered into Resume Page of MJOL <PlanCode> Plan Code to Create
new Member for <EmailAddress> Email Address to use for saving/resuming
application. Note this is not Pre-Populated to the Member Profile Module,
and should be specified separately if required <MemberID> Existing Member
to Update, if this is an MJOL II application. Otherwise Null <EmployerID>
Employer Linked to application, if applicable <AdviserID> Advisor Linked
to application, if applicable <RegisterMember> True if Member Should be
registered at end of process.
False if Member should not be registered, and Password and CAPTCHA
modules should not be shown <DirectResumeURL> Direct Resume URL.
Following link should resume application, at most recently completed
module <MemberName> Title, First Name and Surname of Member, as entered
in Member Profile Module <CreatedDate> Date MJOL Application Created
<ModifiedDate> Date MJOL Application Last Modified <SubmittedDate> Date
MJOL Application Submitted <ApplicationText> RAW XML output of
Application Structure
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A MJOL Application
* Model
* Model Schema
ApiResponse[MJOLApplicationTextModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (MJOLApplicationTextModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
MJOLApplicationTextModel {
applicationText (string, optional),
applicationID (string, optional),
requestNumber (string, optional),
planCode (string, optional),
emailAddress (string, optional),
memberID (string, optional),
memberName (Name, optional),
employerID (string, optional),
adviserID (string, optional),
registerMember (boolean, optional),
directResumeUrl (string, optional),
createdDate (string, optional),
modifiedDate (string, optional),
submittedDate (string, optional),
passCode (string, optional)
}
Name {
titleCode (string, optional),
givenName (string, optional),
familyName (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"applicationText": "string",
"applicationID": "string",
"requestNumber": "string",
"planCode": "string",
"emailAddress": "string",
"memberID": "string",
"memberName": {
"titleCode": "string",
"givenName": "string",
"familyName": "string"
},
"employerID": "string",
"adviserID": "string",
"registerMember": true,
"directResumeUrl": "string",
"createdDate": "2024-03-12T12:51:58.214Z",
"modifiedDate": "2024-03-12T12:51:58.214Z",
"submittedDate": "2024-03-12T12:51:58.214Z",
"passCode": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string applicationId
Id number for a User in Member Centre. Distinct From Aaspire Member Id
and User Name
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MULTIFACTORAUTHENTICATION
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERS/{USERID}/USERFACTORS
*
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
Object {}
{}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode path string
userId path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PLANSECURITYQUESTION
* Show/Hide
* List Operations
* Expand Operations
* * GET /MEMBERUSERACCOUNT/PLANCODE/{PLANCODE}/SECURITYQUESTIONS
* Returns all Security Questions Configured for Plan, and available for
a User to Answer
IMPLEMENTATION NOTES
SECURITY QUESTIONS
This API is used to Retrieve the set of Security Questions that have been
configured for the Plan, and are Available for the User to provide
answers for. These Security Questions are used to allow a User who has
forgotten their password, to reset it without contacting the contact
centre.
QUESTIONS
Each question is has the following two Fields:
Field Use SecurityQuestionId Code used to identify the Question
SecurityQuestion Question Text to Display
MINUMUM NUMBER OF QUESTIONS
The <MinQuestionsToAnswer> field, indicates the Minumum Number of
Questions a User must provide, in order to use the Forgotten Password
functionality
QUESTIONS TO ASK
The <QuestionsAskedForReset> field indicates the Number of Questions that
will be asked of a User, using the Forgetten Password functionality.
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A plan security question collection
* Model
* Model Schema
ApiResponse[PlanSecurityQuestionConfigurationModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (PlanSecurityQuestionConfigurationModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
PlanSecurityQuestionConfigurationModel {
securityQuestions (Array[PlanSecurityQuestionModel], optional),
minQuestionsToAnswer (integer, optional),
questionsAskedForReset (integer, optional)
}
PlanSecurityQuestionModel {
planCode (string, optional),
securityQuestionId (integer, optional),
securityQuestion (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"securityQuestions": [
{
"planCode": "string",
"securityQuestionId": 0,
"securityQuestion": "string"
}
],
"minQuestionsToAnswer": 0,
"questionsAskedForReset": 0
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/MEMBERUSERACCOUNT/PLANCODE/{PLANCODE}/SECURITYQUESTIONS/{SECURITYQUESTIONID}
* Gets an individual Security Question by Id
IMPLEMENTATION NOTES
SECURITY QUESTIONS
This API is used to Retrieve the set of Security Questions that have been
configured for the Plan, and are Available for the User to provide
answers for. These Security Questions are used to allow a User who has
forgotten their password, to reset it without contacting the contact
centre.
QUESTIONS
Each question is has the following two Fields:
Field Use SecurityQuestionId Code used to identify the Question
SecurityQuestion Question Text to Display
MINUMUM NUMBER OF QUESTIONS
The <MinQuestionsToAnswer> field, indicates the Minumum Number of
Questions a User must provide, in order to use the Forgotten Password
functionality
QUESTIONS TO ASK
The <QuestionsAskedForReset> field indicates the Number of Questions that
will be asked of a User, using the Forgetten Password functionality.
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A plan security question
* Model
* Model Schema
ApiResponse[PlanSecurityQuestionModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (PlanSecurityQuestionModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
PlanSecurityQuestionModel {
planCode (string, optional),
securityQuestionId (integer, optional),
securityQuestion (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"planCode": "string",
"securityQuestionId": 0,
"securityQuestion": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string securityQuestionId
The security question identifier.
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* REGISTRATIONTOKENS
* Show/Hide
* List Operations
* Expand Operations
* * GET
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/REGISTRATIONTOKENS
* Retrieves list of outstanding Registration tokens based on the
planCode and userId
IMPLEMENTATION NOTES
Could not find GET.RegistrationTokens.md documentation. Make sure it's an
Embedded Resource in the API project
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
An update registration token link
* Model
* Model Schema
ApiResponse[List[RegistrationTokenResponeModel]] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Array[RegistrationTokenResponeModel], optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
RegistrationTokenResponeModel {
planCode (string, optional),
userId (integer, optional),
token (string, optional),
tokenUrl (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": [
{
"planCode": "string",
"userId": 0,
"token": "string",
"tokenUrl": "string"
}
],
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
The unique Identifier to represent a user in system
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/REGISTRATIONTOKENS
* Creates a new Registration token based on the planCode and userId
IMPLEMENTATION NOTES
Could not find POST.RegistrationTokens.md documentation. Make sure it's
an Embedded Resource in the API project
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
An registration token link
* Model
* Model Schema
ApiResponse[RegistrationTokenResponeModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (RegistrationTokenResponeModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
RegistrationTokenResponeModel {
planCode (string, optional),
userId (integer, optional),
token (string, optional),
tokenUrl (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"planCode": "string",
"userId": 0,
"token": "string",
"tokenUrl": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
The unique Identifier to represent a user in system
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SERVICE
* Show/Hide
* List Operations
* Expand Operations
* * GET /MEMBERUSERACCOUNT/SERVICE/LOGIN
* Please login
IMPLEMENTATION NOTES
1. Click the Off button
2. Enter username+password
3. Off button has changed to On
4. Click "Explore" at top of page
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
NoContent
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/SERVICE/VERSION
* Gets the service version information
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
ServiceVersionModel {
releaseVersion (string, optional),
assemblyVersions (Array[AssemblyVersionModel], optional),
environmentName (string, optional):
Gets or sets the environment name (DEV, SIT, UAT, STAGING, DR, PROD)
,
serverName (string, optional):
Gets or sets the server name.
,
uptimeSeconds (number, optional):
Gets or sets the service uptime in seconds.
,
requestHeaders (Array[string], optional)
}
AssemblyVersionModel {
fullName (string, optional):
Gets or sets the full name.
,
company (string, optional),
assemblyVersion (string, optional):
Gets or sets the version.
,
buildDate (string, optional):
Gets or sets the build date.
,
buildType (string, optional):
Gets the type of the build (Debug or Release)
}
{
"releaseVersion": "string",
"assemblyVersions": [
{
"fullName": "string",
"company": "string",
"assemblyVersion": "string",
"buildDate": "2024-03-12T12:51:58.232Z",
"buildType": "string"
}
],
"environmentName": "string",
"serverName": "string",
"uptimeSeconds": 0,
"requestHeaders": [
"string"
]
}
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/SERVICE/STATUS
* Gets the status of this instance of the service. As the service is
load-balanced this method cannot be used to determine the status of
the service farm.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
ServiceStatusModel {
status (string, optional):
Gets or sets the service status.
}
{
"status": "string"
}
Response Content Type application/json text/json application/xml text/xml
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 503
Busy
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/SERVICE/RESOURCES
* Gets a list of embedded resources. Restricted.
linkgroup.fundadmin.memberuseraccountservice.api
linkgroup.api.internal
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
Inline Model [
string
]
[
"string"
]
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type includeAllAssemblies
true false
if set to true includes resources in all assemblies.
query boolean
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/SERVICE/USER
* Gets the identity of the authenticated user. Restricted.
linkgroup.fundadmin.memberuseraccountservice.api
linkgroup.api.internal
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
ServiceUserModel {
name (string, optional),
authenticationType (string, optional),
isAuthenticated (boolean, optional),
claims (Array[ServiceClaimModel], optional)
}
ServiceClaimModel {
claimType (string, optional),
claimValue (string, optional)
}
{
"name": "string",
"authenticationType": "string",
"isAuthenticated": true,
"claims": [
{
"claimType": "string",
"claimValue": "string"
}
]
}
Response Content Type application/json text/json application/xml text/xml
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/SERVICE/AUTHORIZATIONRULES
* Generates seed data for resource authorization database
linkgroup.fundadmin.memberuseraccountservice.api
linkgroup.api.internal
RESPONSE CLASS (STATUS 200)
Apis
* Model
* Model Schema
Inline Model [
string
]
[
"string"
]
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type dataType
uri,rule
query string client
The clientId (customer name). Mandatory for rule. Ignored for uri.
query string listType
sql,raw
query string includeServiceApis true false
if set to true includes service apis
query boolean
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/SERVICE/RAML
* Gets RAML. Uses apimatic.io to transform Swagger to RAML 1.0.
RESPONSE CLASS (STATUS 200)
Response Content Type application/octet-stream
PARAMETERS
Parameter Value Description Parameter Type Data Type contentDisposition
"attachment" or "inline". If not specified "attachment" is used
query string fixups true false
if set to true fixups are applied.
query boolean
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SYSTEMHEALTH
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /MEMBERUSERACCOUNT/SYSTEM/HEALTH/{ID}
*
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/SYSTEM/HEALTH/{ID}
*
RESPONSE CLASS (STATUS 200)
A SystemHealth
* Model
* Model Schema
ApiResponse[SystemHealthModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (SystemHealthModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
SystemHealthModel {
status (string, optional),
id (string, optional),
system (string, optional),
version (string, optional),
data (string, optional),
deps (Array[SystemHealthModel], optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"status": "string",
"id": "string",
"system": "string",
"version": "string",
"data": "string",
"deps": [
{}
]
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
incDeps true false query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERUSERACCOUNT/SYSTEM/HEALTH/{ID}
*
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
serviceHealthModel
Parameter content type: application/json text/json application/xml
text/xml
body
* Model
* Model Schema
SystemHealthModel {
status (string, optional),
id (string, optional),
system (string, optional),
version (string, optional),
data (string, optional),
deps (Array[SystemHealthModel], optional)
}
{
"status": "string",
"id": "string",
"system": "string",
"version": "string",
"data": "string",
"deps": [
{}
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /MEMBERUSERACCOUNT/SYSTEM/HEALTH/{ID}
*
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
serviceHealthModel
Parameter content type: application/json text/json application/xml
text/xml
body
* Model
* Model Schema
SystemHealthModel {
status (string, optional),
id (string, optional),
system (string, optional),
version (string, optional),
data (string, optional),
deps (Array[SystemHealthModel], optional)
}
{
"status": "string",
"id": "string",
"system": "string",
"version": "string",
"data": "string",
"deps": [
{}
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 200
OK
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/SYSTEM/HEALTH
*
RESPONSE CLASS (STATUS 200)
A SystemHealth
* Model
* Model Schema
ApiResponse[SystemHealthModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (SystemHealthModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
SystemHealthModel {
status (string, optional),
id (string, optional),
system (string, optional),
version (string, optional),
data (string, optional),
deps (Array[SystemHealthModel], optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"status": "string",
"id": "string",
"system": "string",
"version": "string",
"data": "string",
"deps": [
{}
]
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type incDeps true false
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USERACCOUNTS
* Show/Hide
* List Operations
* Expand Operations
* * GET /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS
* Gets a collection of User Accounts
IMPLEMENTATION NOTES
USER ACCOUNT SEARCH
This API, is used to search for a Member Centre User, based on certain
criteria. This is used as part of Registration To check if a Member is
currently Registered for Member Centre.
Returns following data fields for User Accounts
DATA FIELDS
Field NameDescription User IdReference Code, used to refer to Specific
Users in the API User NameMember login name. Note this will likely be the
same as a if a Custom User Name has not been set Member ID <planMemberId>
of Member in aaspire, for this User Account Email Email ID used for login
and password reset Plan CodeTwo character alphanumeric code of the member
plan Plan Member RefExternal Member reference number (<planMemberRef>) of
Member in aaspire, for this User Account Last Login dateTimestamp of user
last login User Creation dateTimestamp of when the user account was
created EnabledFlag indicating whether Member is Enabled or Disabled Is
LockedOut Failed AttemptsIf the user is locked with multiple failed
attemptsFailed Attempts Locked DateTimeFailed attempt date and time Is
Account Locked AdminIf the user is disabled by Admin Admin Lock
DateTimeDate time, when admin disabled the User Created DateTimeUser
Account created date and time
NOTE
Linked Members will always be null in the response.
OPERATIONS
Unrestricted, this API will return all Registered Users for a Plan. If
this is not required, a calling application should use one or more Search
and Pagination Operations to restrict the response
FILTER/SEARCH USER ACCOUNTS
Retrieve user accounts based on search on one of the following:
Field UserID UserName MemberID Email planMemberRef customerReference
For Example to search for a User by Custom User Name use GET
/api/plans/{planCode}/userAccounts?userName=JohnSmith Or to get the User
Id of a Registered Member with a particular <planMemberRef> use GET
/api/plans/{planCode}/userAccounts?planMemberRef=12345678
SORT USER ACCOUNT
User Account Search Results can be sorted in ascending or descending
order on:
Field UserID UserName MemberID Email planMemberRef LastLoginDate Created
Date
Eg, to find the most recently registered users use GET
/api/plans/{planCode}/userAccounts?limit=20&sort=+createdDate
PAGINATION
To implement pagination of results, a calling application should use the
limit parameter to set the number of results to return at a time, and the
offset to set the starting index of the page of results eg. to return
results 41-60 GET /api/plans/{planCode}/userAccounts?limit=20&offset=41
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A user accounts collection
* Model
* Model Schema
ApiResponse[List[UserAccountsModel]] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Array[UserAccountsModel], optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserAccountsModel {
id (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
hasLinkedAccounts (boolean, optional),
isAccountLocked (boolean, optional),
lastLoginDateTime (string, optional),
planMemberReference (string, optional),
createdDateTime (string, optional),
isLockedOutFailedAttempts (boolean, optional),
failedAttemptsLockedDateTime (string, optional),
isAccountLockedAdmin (boolean, optional),
adminLockDateTime (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": [
{
"id": 0,
"planCode": "string",
"planMemberId": 0,
"userName": "string",
"emailAddress": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"hasLinkedAccounts": true,
"isAccountLocked": true,
"lastLoginDateTime": "2024-03-12T12:51:58.252Z",
"planMemberReference": "string",
"createdDateTime": "2024-03-12T12:51:58.252Z",
"isLockedOutFailedAttempts": true,
"failedAttemptsLockedDateTime": "2024-03-12T12:51:58.252Z",
"isAccountLockedAdmin": true,
"adminLockDateTime": "2024-03-12T12:51:58.252Z"
}
],
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userName
User Name of the User account
query string planMemberID
PlanMemberID
query long planMemberReference
PlanMemberReference
query string emailAddress
Email Address of the user
query string limit
The limit.
query integer offset
The offset.
query integer sort
Sorting, CSV list, + or - prefix to indicate direction. Valid fields:
UserID, UserName, PlanMemberID, EmailAddress, PlanMemberReference,
LastLoginDateTime, CreatedDateTime, IsAccountLocked, HasActiveToken
Example: -UserName,+PlanMemberID,+PlanMemberReference
query string customerReference
Customer Refernce
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS
* Creates a new User Account for Member Centre. Used for Registration
and Join.
IMPLEMENTATION NOTES
CREATE MEMBER CENTRE USER
This API is used to create a new User in Member Centre. It is called as a
last step of Registration processes, to give access to Existing Members
of fund currently in Aaspire, and for the Member Join Online (MJOL)
processes to give access to New Members.
REGISTRATION
To Register an Existing Member, a Calling Application should follow the
following steps:
1. Call GET /member/plans/{planCode}/members to confirm the Member
Exists
2. Call GET /api/plans/{planCode}/userAccounts to confirm the Member is
not already Registered for Member Centre and/or if Username is taken
3. Verify that the Member exists, through challenge fields
4. Call other Member Update APIs, to update any Member Information
Provided as part of registration eg.
5. PUT /member/plans/{planCode}/members/{id} to update Personal Details
and Contact Details. Email Address Mandatory for User Creation
6. PUT /member/plans/{planCode}/members/{id}/additionalData
7. Using the <planMemberId> of the Member in aaspire, call POST
/api/plans/{planCode}/userAccounts to create the new user
8. Set the New user's Security Questions with POST
/api/planCode/{planCode}/userAccounts/{userId}/securityQuestions
MEMBER JOIN ONLINE (MJOL)
To Join a New Member to the Fund, a Calling Application should follow the
following steps:
1. Call GET /member/plans/{planCode}/members to confirm a Member with
the provided details exists
2. Call GET /api/plans/{planCode}/userAccounts to confirm the new
Member's preferred Username is taken
3. Call Post /member/plans/{planCode}/members to create the new Member
4. Using the <planMemberId> of the New Member returned from aaspire,
call POST /api/plans/{planCode}/userAccounts to create the new user
USER CREATION
To create a User, the following Fields are to be passed in to this API
call:
Field Use/Source Validation PlanMemberId <planMemberId> from Aaspire, of
the Member this User is being Created for Member Must Exist in Aaspire.
Member Must also have email address set. Username Username Member Wishes
to Log in to Member Centre with Optional, Unique to Plan if provided
Password Password of New User Mandatory
If the New User Account is successfully created, then the Member will be
able to log in to Member Centre with their nominated username and
password. If a calling application does not provide a value, it will
default to the Member's <planMemberRef> value from aaspire.
VALIDATIONS
This API will throw an error and not create a new user if validations are
failed. It is recommended that calling applications use other GET API
calls and perform their own checks on user provided data, before calling
this API.
The Password must be minimum 7 characters long and should contain at
least 1 letter and 1 number (0-9).
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
ApiResponse[UserAccountModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserAccountModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserAccountModel {
id (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
hasLinkedAccounts (boolean, optional),
isAccountLocked (boolean, optional),
lastLoginDateTime (string, optional),
planMemberReference (string, optional),
createdDateTime (string, optional),
isLockedOutFailedAttempts (boolean, optional),
failedAttemptsLockedDateTime (string, optional),
isAccountLockedAdmin (boolean, optional),
adminLockDateTime (string, optional),
linkedMembers (Array[LinkedMembersModel], optional)
}
LinkedMembersModel {
planCode (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
userName (string, optional),
isPrimary (boolean, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"id": 0,
"planCode": "string",
"planMemberId": 0,
"userName": "string",
"emailAddress": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"hasLinkedAccounts": true,
"isAccountLocked": true,
"lastLoginDateTime": "2024-03-12T12:51:58.260Z",
"planMemberReference": "string",
"createdDateTime": "2024-03-12T12:51:58.260Z",
"isLockedOutFailedAttempts": true,
"failedAttemptsLockedDateTime": "2024-03-12T12:51:58.260Z",
"isAccountLockedAdmin": true,
"adminLockDateTime": "2024-03-12T12:51:58.260Z",
"linkedMembers": [
{
"planCode": "string",
"planMemberId": 0,
"planMemberReference": "string",
"userName": "string",
"isPrimary": true
}
]
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userAccount
Parameter content type: application/json text/json application/xml
text/xml
The user account.
body
* Model
* Model Schema
CreateUserAccountModel {
planCode (string, optional),
userName (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
emailAddress (string, optional),
password (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
classificationId (integer, optional),
securityQuestion (Array[UserAccountSecurityQuestionAnswerModel],
optional)
}
UserAccountSecurityQuestionAnswerModel {
securityQuestionId (integer, optional),
securityQuestion (string, optional),
securityQuestionAnswer (string, optional)
}
{
"planCode": "string",
"userName": "string",
"planMemberId": 0,
"planMemberReference": "string",
"emailAddress": "string",
"password": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"classificationId": 0,
"securityQuestion": [
{
"securityQuestionId": 0,
"securityQuestion": "string",
"securityQuestionAnswer": "string"
}
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 201
A user account
* Model
* Model Schema
ApiResponse[UserAccountModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserAccountModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserAccountModel {
id (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
hasLinkedAccounts (boolean, optional),
isAccountLocked (boolean, optional),
lastLoginDateTime (string, optional),
planMemberReference (string, optional),
createdDateTime (string, optional),
isLockedOutFailedAttempts (boolean, optional),
failedAttemptsLockedDateTime (string, optional),
isAccountLockedAdmin (boolean, optional),
adminLockDateTime (string, optional),
linkedMembers (Array[LinkedMembersModel], optional)
}
LinkedMembersModel {
planCode (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
userName (string, optional),
isPrimary (boolean, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"id": 0,
"planCode": "string",
"planMemberId": 0,
"userName": "string",
"emailAddress": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"hasLinkedAccounts": true,
"isAccountLocked": true,
"lastLoginDateTime": "2024-03-12T12:51:58.263Z",
"planMemberReference": "string",
"createdDateTime": "2024-03-12T12:51:58.263Z",
"isLockedOutFailedAttempts": true,
"failedAttemptsLockedDateTime": "2024-03-12T12:51:58.263Z",
"isAccountLockedAdmin": true,
"adminLockDateTime": "2024-03-12T12:51:58.263Z",
"linkedMembers": [
{
"planCode": "string",
"planMemberId": 0,
"planMemberReference": "string",
"userName": "string",
"isPrimary": true
}
]
},
"message": "string"
}
400
BadRequest
401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}
* Soft delete the User
IMPLEMENTATION NOTES
Could not find DELETE.UserAccount.md documentation. Make sure it's an
Embedded Resource in the API project
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
Object {}
{}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
Id number for a User in Member Centre. Distinct From Aaspire Member Id
and User Name
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
NoContent
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}
* Gets a user account
IMPLEMENTATION NOTES
USER ACCOUNT
This API returns details on a Specific User, identified by {userId}. Note
{userId} values are internal facing identifiers for Member Centre User
Accounts. To retrieve a User based on aaspire <planMemberRef> or the
User's UserName calling applications should use GET
/api/plans/{planCode}/userAccounts Most User Management API calls will
use {userId}, to refer to Meember Centre Users.
DATA FIELDS
Field NameDescription/Use User IdReference Code, used to refer to
Specific Users in the API User NameMember login name. Note this will
likely be the same as a if a Custom User Name has not been set Member ID
<planMemberId> of Member in aaspire, for this User Account Email Email ID
used for login and password reset Plan CodeTwo character alphanumeric
code of the member plan Plan Member RefExternal Member reference number
(<planMemberRef>) of Member in aaspire, for this User Account Last Login
dateTimestamp of user last login User Creation dateTimestamp of when the
user account was created EnabledFlag indicating whether Member is Enabled
or Disabled Is LockedOut Failed AttemptsIf the user is locked with
multiple failed attempts Failed Attempts Locked DateTimeFailed attempt
date and time Is Account Locked AdminIf the user is disabled by Admin
Admin Lock DateTimeDate time, when admin disabled the User Created
DateTimeUser Account created date and time Linked MembersMemberships
linked to the User
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A user account
* Model
* Model Schema
ApiResponse[UserAccountModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserAccountModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserAccountModel {
id (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
hasLinkedAccounts (boolean, optional),
isAccountLocked (boolean, optional),
lastLoginDateTime (string, optional),
planMemberReference (string, optional),
createdDateTime (string, optional),
isLockedOutFailedAttempts (boolean, optional),
failedAttemptsLockedDateTime (string, optional),
isAccountLockedAdmin (boolean, optional),
adminLockDateTime (string, optional),
linkedMembers (Array[LinkedMembersModel], optional)
}
LinkedMembersModel {
planCode (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
userName (string, optional),
isPrimary (boolean, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"id": 0,
"planCode": "string",
"planMemberId": 0,
"userName": "string",
"emailAddress": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"hasLinkedAccounts": true,
"isAccountLocked": true,
"lastLoginDateTime": "2024-03-12T12:51:58.267Z",
"planMemberReference": "string",
"createdDateTime": "2024-03-12T12:51:58.267Z",
"isLockedOutFailedAttempts": true,
"failedAttemptsLockedDateTime": "2024-03-12T12:51:58.267Z",
"isAccountLockedAdmin": true,
"adminLockDateTime": "2024-03-12T12:51:58.267Z",
"linkedMembers": [
{
"planCode": "string",
"planMemberId": 0,
"planMemberReference": "string",
"userName": "string",
"isPrimary": true
}
]
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
Id number for a User in Member Centre. Distinct From Aaspire Member Id
and User Name
path integer limit query integer offset query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}
* Sets a new custom Username for the User
IMPLEMENTATION NOTES
UPDATE USERNAME
This service is used when user updates account details, service updates
user accounts data for specified Plan and User
Following data fields will be updated to user accounts
DATA FIELDS
The following fields, are updatable for a User's account.
Field Use/Source Validation Username Username Member Wishes to Log in to
Member Centre with Unique to Plan if provided
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Updates user name
* Model
* Model Schema
ApiResponse[UserAccountModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserAccountModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserAccountModel {
id (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
hasLinkedAccounts (boolean, optional),
isAccountLocked (boolean, optional),
lastLoginDateTime (string, optional),
planMemberReference (string, optional),
createdDateTime (string, optional),
isLockedOutFailedAttempts (boolean, optional),
failedAttemptsLockedDateTime (string, optional),
isAccountLockedAdmin (boolean, optional),
adminLockDateTime (string, optional),
linkedMembers (Array[LinkedMembersModel], optional)
}
LinkedMembersModel {
planCode (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
userName (string, optional),
isPrimary (boolean, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"id": 0,
"planCode": "string",
"planMemberId": 0,
"userName": "string",
"emailAddress": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"hasLinkedAccounts": true,
"isAccountLocked": true,
"lastLoginDateTime": "2024-03-12T12:51:58.270Z",
"planMemberReference": "string",
"createdDateTime": "2024-03-12T12:51:58.270Z",
"isLockedOutFailedAttempts": true,
"failedAttemptsLockedDateTime": "2024-03-12T12:51:58.270Z",
"isAccountLockedAdmin": true,
"adminLockDateTime": "2024-03-12T12:51:58.270Z",
"linkedMembers": [
{
"planCode": "string",
"planMemberId": 0,
"planMemberReference": "string",
"userName": "string",
"isPrimary": true
}
]
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
Id number for a User in Member Centre. Distinct From Aaspire Member Id
and User Name
path integer userModel
Parameter content type: application/json text/json application/xml
text/xml
The user account.
body
* Model
* Model Schema
UserModel {
userName (string, optional),
planMemberId (integer, optional),
emailAddress (string, optional),
planMemberReference (string, optional)
}
{
"userName": "string",
"planMemberId": 0,
"emailAddress": "string",
"planMemberReference": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/PASSWORD
* Update a Member's Password
IMPLEMENTATION NOTES
CHANGE USER PASSWORD
This API is used to Change a User Password. It has two modes, the first
is when a user interface has OldPassword and NewPassword fields, and the
other is when a password is changed after a user has validated a
OneTimePassword (OTP).
DATA FIELDS
To Update a password, the following should be passed in the request body.
Calling applications are responsible for collecting the details securely
To change a password with the old password:
Field Use/Validation OldPassword Must Match password stored for Member
Centre Token null NewPassword User's New Password. Mandatory
To change a password with an OTP token:
Field Use/Validation OldPassword null Token Token generated by POST
/memberuseraccount/plans/{planCode}/userAccounts/{userName}/onetimepasswords.
NewPassword User's New Password. Mandatory
VALIDATIONS
The User Id must have at least one linked plan member belonging to the
Plan Code from the URL.
The New Password must be minimum 7 characters long and should contain at
least 1 letter and 1 number (0-9).
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Updates user password
* Model
* Model Schema
ApiResponse[UserAccountModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserAccountModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserAccountModel {
id (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
hasLinkedAccounts (boolean, optional),
isAccountLocked (boolean, optional),
lastLoginDateTime (string, optional),
planMemberReference (string, optional),
createdDateTime (string, optional),
isLockedOutFailedAttempts (boolean, optional),
failedAttemptsLockedDateTime (string, optional),
isAccountLockedAdmin (boolean, optional),
adminLockDateTime (string, optional),
linkedMembers (Array[LinkedMembersModel], optional)
}
LinkedMembersModel {
planCode (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
userName (string, optional),
isPrimary (boolean, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"id": 0,
"planCode": "string",
"planMemberId": 0,
"userName": "string",
"emailAddress": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"hasLinkedAccounts": true,
"isAccountLocked": true,
"lastLoginDateTime": "2024-03-12T12:51:58.274Z",
"planMemberReference": "string",
"createdDateTime": "2024-03-12T12:51:58.274Z",
"isLockedOutFailedAttempts": true,
"failedAttemptsLockedDateTime": "2024-03-12T12:51:58.274Z",
"isAccountLockedAdmin": true,
"adminLockDateTime": "2024-03-12T12:51:58.274Z",
"linkedMembers": [
{
"planCode": "string",
"planMemberId": 0,
"planMemberReference": "string",
"userName": "string",
"isPrimary": true
}
]
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
Id number for a User in Member Centre. Distinct From Aaspire Member Id
and User Name
path integer userPasswordModel
Parameter content type: application/json text/json application/xml
text/xml
User Password model that contains old and new password
body
* Model
* Model Schema
PasswordModel {
oldPassword (string, optional),
newPassword (string, optional),
token (string, optional)
}
{
"oldPassword": "string",
"newPassword": "string",
"token": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
401
Unauthorized
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/STATUS
* Disable or Enable a User (planCode, userId) in Member Centre
IMPLEMENTATION NOTES
ENABLE/DISABLE USER ACCOUNTS
This API is used to Disable or Enable a User's Account. Disabled Users
will not be able to log in to Member Centre.
Note this API does NOT remove a Member from Aaspire, or change their
status in Aaspire. Active Members will remain active.
ACCOUNT STATUS
To Disable a User's account call PUT
/api/plans/{planCode}/userAccounts/{userId}/status with isEnabled=false
in the request body.
To Enable a User's account call PUT
/api/plans/{planCode}/userAccounts/{userId}/status with isEnabled=true in
the request body
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Member Status Updated
* Model
* Model Schema
UserAccountModel {
id (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
hasLinkedAccounts (boolean, optional),
isAccountLocked (boolean, optional),
lastLoginDateTime (string, optional),
planMemberReference (string, optional),
createdDateTime (string, optional),
isLockedOutFailedAttempts (boolean, optional),
failedAttemptsLockedDateTime (string, optional),
isAccountLockedAdmin (boolean, optional),
adminLockDateTime (string, optional),
linkedMembers (Array[LinkedMembersModel], optional)
}
LinkedMembersModel {
planCode (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
userName (string, optional),
isPrimary (boolean, optional)
}
{
"id": 0,
"planCode": "string",
"planMemberId": 0,
"userName": "string",
"emailAddress": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"hasLinkedAccounts": true,
"isAccountLocked": true,
"lastLoginDateTime": "2024-03-12T12:51:58.278Z",
"planMemberReference": "string",
"createdDateTime": "2024-03-12T12:51:58.278Z",
"isLockedOutFailedAttempts": true,
"failedAttemptsLockedDateTime": "2024-03-12T12:51:58.278Z",
"isAccountLockedAdmin": true,
"adminLockDateTime": "2024-03-12T12:51:58.278Z",
"linkedMembers": [
{
"planCode": "string",
"planMemberId": 0,
"planMemberReference": "string",
"userName": "string",
"isPrimary": true
}
]
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
Id of the user.
path integer status
Parameter content type: application/json text/json application/xml
text/xml
Controls whether to Enable or Disable the User
body
* Model
* Model Schema
UpdateUserAccountStatusModel {
isEnabled (boolean, optional)
}
{
"isEnabled": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERNAME}/ONETIMEPASSWORDS
* Creates a user one time password (OTP).
IMPLEMENTATION NOTES
The OTP is single-use and stored against the user record. A user has at
most one active OTP.
The OTP can be by calling Identity Server using the OpenID Connect
"onetimepassword" custom grant_type.
The OTP is generated using a cryptographic-strength RNG.
This method cannot be called by a user-level access token (eg
client_credentials only)
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
ApiResponse[List[OneTimePasswordResponseModel]] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Array[OneTimePasswordResponseModel], optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
OneTimePasswordResponseModel {
planCode (string, optional):
Plan code
,
userName (string, optional):
User name
,
userId (integer, optional):
User Id
,
oneTimePassword (string, optional):
The one time password (OTP). Validate with the UserOneTimePassword
grant_type on the IDP
,
expiresAt (string, optional):
Valid until this time
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": [
{
"planCode": "string",
"userName": "string",
"userId": 0,
"oneTimePassword": "string",
"expiresAt": "2024-03-12T12:51:58.282Z"
}
],
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
The plan code.
path string userName
The user identifier.
path string oneTimePasswordRequest
Parameter content type: application/json text/json application/xml
text/xml
The one time password request.
body
* Model
* Model Schema
UserAccountOneTimePasswordModel {
length (integer):
The length of the one time password. Minimum 6
,
purpose (string):
The intent of the one time password. Used for audit. Free text.
"Registration", "UpdateAddress", "ChangePassword", "UpdateEmail" etc.
,
timeToLiveSeconds (integer):
The number of seconds the one time password remains valid after creation
}
{
"length": 0,
"purpose": "string",
"timeToLiveSeconds": 0
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
403
Forbidden
404
User does not exist
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/TERMSANDCONDITIONS
* Gets Terms and Conditions acceptance date for a user
IMPLEMENTATION NOTES
TERMS AND CONDITIONS
This endpoint gets the Terms and Conditions acceptance date based on the
provided planCode and userId.
Following fields would be retrieved in response:
Value Use id The unique ID associated with the user planCode The Plan
Code userName User Name who accepted the Terms and Conditions. This could
be either planMemberReference or custom User Name termsAcceptanceDate The
date and time at which user accepted the terms and conditions. Null in
case user haven't accepted T&C
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Terms and Conditions
* Model
* Model Schema
ApiResponse[TermsConditionsModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (TermsConditionsModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
TermsConditionsModel {
id (integer, optional),
planCode (string, optional),
userName (string, optional),
termsAcceptanceDate (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"id": 0,
"planCode": "string",
"userName": "string",
"termsAcceptanceDate": "2024-03-12T12:51:58.286Z"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character alphanumeric code of the User's Plan
path string userId
The unique Identifier to represent a user in system. Different from
aaspire Plan Member Id and User Name
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/TERMSANDCONDITIONS
* Updates Terms and Conditions acceptance date for a user
IMPLEMENTATION NOTES
TERMS AND CONDITIONS
This endpoint updates the Terms and Conditions acceptance date based on
the provided planCode and userId. API would use the current system date
and time to update termsAcceptanceDate.
Following fields would be retrieved in response:
Value Use id The unique ID associated with the user planCode The Plan
Code userName User Name who accepted the Terms and Conditions. This could
be either planMemberReference or custom User Name termsAcceptanceDate The
date and time at which user accepted the terms and conditions. Null in
case user haven't accepted T&C
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Terms and Conditions
* Model
* Model Schema
ApiResponse[Boolean] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (boolean, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": true,
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character alphanumeric code of the User's plan
path string userId
The unique Identifier to represent a user in system. Different from
aaspire Plan Member Id and User Name
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
403
Forbidden
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/GENERALSETTINGS
* Gets Terms and Conditions details
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Terms and Conditions
* Model
* Model Schema
ApiResponse[GeneralSettingsModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (GeneralSettingsModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
GeneralSettingsModel {
isSSOEnabled (boolean, optional),
termsLastResetDate (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"isSSOEnabled": true,
"termsLastResetDate": "2024-03-12T12:51:58.291Z"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USERFORGOTTENPASSWORD
* Show/Hide
* List Operations
* Expand Operations
* * POST
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/FORGOTTENPASSWORD
* Request a Forgotten Password Reset, and return a password token and
Security Questions to ask the Member
IMPLEMENTATION NOTES
FORGOTTEN PASSWORD
This API is used for the first step of the Forgotten Password process for
a user. The steps to reset a forgotten password are as follows:
1. Call POST
/api/planCode/{planCode}/userAccounts/{userId}/forgottenPassword to
Request the security questions, and password reset token
2. Send Token User's responses, and requested new password to PUT
/api/planCode/{planCode}/userAccounts/{userId}/forgottenPassword{ResetToken}
3. If the token is still valid, and responses match the answers
previously given by the User to the Security questions, the User's
password is updated
RESET REQUEST RESPONSE
A calling application will need to capture the response of the POST
request, as there will be no other method to obtain the Token
Link/Security Questions combination that needs to provided to reset a
forgotten password.
Field Use/Value <SecurityQuestions> Collection of Security Questions that
needs to be Answered by User to reset Password <SecurityQuestions>
<SecurityQuestionId> Id Code of Question, from GET
/api/planCode/{planCode}/securityQuestions <SecurityQuestions>
<SecurityQuestion> Display Text for Question <ResetToken> ResetToken
Value to pass to PUT
/api/planCode/{planCode}/userAccounts/{userId}/forgottenPassword{ResetToken}
<ResetTokenURL> URL for Member To Complete Forgotten Password process in
Member Centre. <ResetTokenExpiry> Expiry Time for Token. Second step must
be called, before this date
FORGOTTEN PASSWORD URL
If a client application is NOT implementing the second step of the
Forgotten Password processm it should use tokenLink=true eg POST
/api/planCode/{planCode}/userAccounts/{userId}/forgottenPassword?tokenLink=true
The response will inlcude a URL in the <ResetTokenURL> field, for the
User to navigate to, and complete the process in Member Centre.
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Forgotten Password Response
* Model
* Model Schema
ApiResponse[ForgottenPasswordRequestResponseModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (ForgottenPasswordRequestResponseModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
ForgottenPasswordRequestResponseModel {
securityQuestions (Array[PlanSecurityQuestionModel], optional),
resetToken (string, optional),
resetTokenUrl (string, optional),
resetTokenExpiry (string, optional)
}
PlanSecurityQuestionModel {
planCode (string, optional),
securityQuestionId (integer, optional),
securityQuestion (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"securityQuestions": [
{
"planCode": "string",
"securityQuestionId": 0,
"securityQuestion": "string"
}
],
"resetToken": "string",
"resetTokenUrl": "string",
"resetTokenExpiry": "2024-03-12T12:51:58.296Z"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
Id number for a User in Member Centre. Distinct From Aaspire Member Id
and User Name
path integer forgottenPasswordRequest
Parameter content type: application/json text/json application/xml
text/xml
Flag indicating whether or not to return a token link to Member Centre
body
* Model
* Model Schema
ForgottenPasswordRequestModel {
generateResetTokenUrl (boolean, optional)
}
{
"generateResetTokenUrl": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
403
Forbidden
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/FORGOTTENPASSWORD/{RESETTOKEN}
* Provide Security Question Responses and New Password, for a Forgotten
Password Reset Request {ResetToken}
IMPLEMENTATION NOTES
FORGOTTEN PASSWORD - SET PASSWORD
This API is used for the second step of the Forgotten Password process
for a user. The steps to reset a forgotten password are as follows:
1. Call POST
/api/planCode/{planCode}/userAccounts/{userId}/forgottenPassword to
Request the security questions, and password reset token
2. Send Token User's responses, and requested new password to PUT
/api/planCode/{planCode}/userAccounts/{userId}/forgottenPassword{ResetToken}
3. If the token is still valid, and responses match the answers
previously given by the User to the Security questions, the User's
password is updated
NEW PASSWORD REQUEST
To update a Users password, when they have Forgotten their password, a
Client Application will have to Obtain the following information, to be
passed to this API call.
Field Use/Value <SecurityQuestionResponses> Collection of responses
provided by User <SecurityQuestionResponses> <SecurityQuestionId> Id Code
of Question, from GET /api/planCode/{planCode}/securityQuestions
<SecurityQuestionResponses> <SecurityQuestionAnswer> Response Provided by
User <ResetToken> ResetToken Value obtained from POST
/api/planCode/{planCode}/userAccounts/{userId}/forgottenPassword
<NewPassword> New Password provided by User
VALIDATIONS
Before Updating the Password, the API will check the following:
1. Reset Token is valid, and not past Expiry Date
2. Security Question Ids match Questions Provided by POST response for
Token
3. Security Question Responses Match Responses stored for User in Member
Centre.
4. The New Password must be minimum 7 characters long and should contain
at least 1 letter and 1 number (0-9).
If all criteria are met, the User's password is set to the New Password,
and the token consumed. Tokens remain valid (up to Expiry) until a
successful forgotten password update is recieved
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A user security question
* Model
* Model Schema
ApiResponse[UserSecurityQuestionAnswerModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserSecurityQuestionAnswerModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserSecurityQuestionAnswerModel {
userId (integer, optional),
userSecurityQuestionId (integer, optional),
securityQuestionId (integer, optional),
securityQuestion (string, optional),
securityQuestionAnswer (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"userId": 0,
"userSecurityQuestionId": 0,
"securityQuestionId": 0,
"securityQuestion": "string",
"securityQuestionAnswer": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
Id number for a User in Member Centre. Distinct From Aaspire Member Id
and User Name
path string resetToken
Previously Provided Token Value
path string forgottenPasswordResetModel
Parameter content type: application/json text/json application/xml
text/xml
The forgotten password reset
body
* Model
* Model Schema
ForgottenPasswordResetModel {
securityQuestionResponses (Array[SecurityQuestionResponse], optional),
resetToken (string, optional),
newPassword (string, optional)
}
SecurityQuestionResponse {
securityQuestionId (integer, optional),
securityAnswer (string, optional)
}
{
"securityQuestionResponses": [
{
"securityQuestionId": 0,
"securityAnswer": "string"
}
],
"resetToken": "string",
"newPassword": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
403
Forbidden
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USERLINKEDMEMBERS
* Show/Hide
* List Operations
* Expand Operations
* * GET
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/LINKEDMEMBERS
* Gets a collection of linked members.
IMPLEMENTATION NOTES
LINKED MEMBERSHIPS
This API Returns a Listing of all Memberships linked to the specified
User. When logged in this user is able to view the details of the
returned Memberships. Linked members may belong to different plans
Field Value UserId The internal Id code for Member Centre users. Distinct
from MEmber Id and Username PlanCode Two Letter Alphanumeric Code of
Member's plan from Aaspire PlanMemberId <planMemberId> from Aaspire
IsPrimary This is the primay/default member for this collection of linked
memberships.
USER ID
Memberships are linked together to a User ID, and links are only
maintained for Members who are also registered Users of Member Centre. To
confirm if a Member is registered for Member Centre, and obtain their
User Id, calling applications should use GET
/api/plans/{planCode}/userAccounts?memberId?=12345678
VALIDATIONS
If a linked member belongs to a different plan than in the calling
application's whitelist of valid plancodes, that linked member is not
returned (it is not possible to determine if any members belong to other
plan codes were excluded).
The supplied User Id must have at least one linked plan member belonging
to the Plan Code from the URL. If not 403 FORBIDDEN is returned.
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A list of members linked to this account
* Model
* Model Schema
ApiResponse[List[LinkedMemberModel]] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Array[LinkedMemberModel], optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
LinkedMemberModel {
userPlanMemberId (integer, optional),
userId (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
isPrimary (boolean, optional),
planMemberRefernce (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": [
{
"userPlanMemberId": 0,
"userId": 0,
"planCode": "string",
"planMemberId": 0,
"isPrimary": true,
"planMemberRefernce": "string"
}
],
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
The plan code
path string userId
The user identifier
path integer limit
The limit
query integer offset
The offset
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERUSERACCOUNT/PLANS/{PLANCODE}/LINKEDMEMBERS
* Adds to the collection of linked members
IMPLEMENTATION NOTES
LINK MEMBERSHIPS
This API call is used to link a membership (linkedMember.PlanCode,
linkedMember.PlanMemberId) to a user account (planCode, userId); When an
additional Membership is linked to a User, the User will also be able to
access that member via Member Centre. One User may also be linked to
multiple memberships.
Please note this linking is "one way", I.E. if Membership B is linked to
Member A (Primary User), the User will be able to switch to the details
of Membership B when logged in as A, but not see the accounts of
Membership A, when logged in as Member B (Secondary User). A client
application will need to make a second call to this API to link
Memebrship A to Member B, if the ablilty view Membership A when logged in
as Member B (Secondary User).
Field Description PlanCode The plan code of the member to link. The plan
codes of the linker and linkee may differ but must be within the same
fund. PlanMemberId The member to link to PlanMemberReference Optional.
Provide for members where PlanMemberId != PlanMemberReference IsPrimary
Is this the primary/default member for this set of linked members?
VALIDATIONS
Both the Member ID and linked member ID has to exist in Aaspire. This can
can be validated using GET /member/plans/{planCode}/members/ to search
for a member in Aaspire.
The planCode of the member to be linked to must be in the whitelist of
permitted planCodes for the caller. If not 403 FORBIDDEN is returned.
The supplied User Id must have at least one linked plan member belonging
to the Plan Code from the URL. If not 403 FORBIDDEN is returned.
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
ApiResponse[LinkedMemberModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (LinkedMemberModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
LinkedMemberModel {
userPlanMemberId (integer, optional),
userId (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
isPrimary (boolean, optional),
planMemberRefernce (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"userPlanMemberId": 0,
"userId": 0,
"planCode": "string",
"planMemberId": 0,
"isPrimary": true,
"planMemberRefernce": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the member's plan
path string userId
The user identifier
query integer linkedMember
Parameter content type: application/json text/json application/xml
text/xml
The linked member
body
* Model
* Model Schema
CreateLinkedMemberModel {
planCode (string, optional),
planMemberId (integer, optional),
memberReference (string, optional):
Gets or sets the member reference. Optional, only necessary when Member
Reference != PlanMemberId.
,
isPrimary (boolean, optional)
}
{
"planCode": "string",
"planMemberId": 0,
"memberReference": "string",
"isPrimary": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 201
A linked member
* Model
* Model Schema
ApiResponse[List[LinkedMemberModel]] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Array[LinkedMemberModel], optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
LinkedMemberModel {
userPlanMemberId (integer, optional),
userId (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
isPrimary (boolean, optional),
planMemberRefernce (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": [
{
"userPlanMemberId": 0,
"userId": 0,
"planCode": "string",
"planMemberId": 0,
"isPrimary": true,
"planMemberRefernce": "string"
}
],
"message": "string"
}
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/LINKEDACCOUNTS
* Unlinks a membership form the Specified user (planCode, id)
IMPLEMENTATION NOTES
UNLINK MEMBERSHIP
This API is used to Unlink a secondary Memberships linked from the
specified Member's Primary (planCode, Id) user. A user when logged in as
this Member, will no longer be able view the details of this membership.
VALIDATIONS
The API validates that the user does have link to the specified
Membership, and will throw an error if there is no link
The PlanCode of the member must be in the whitelist of planCodes for the
caller. If not 403 FORBIDDEN is returned.
Regardless of whether UserPlanMemberId exists or not the service returns
201.
DATA FIELDS
Field Value PlanCode Two Letter Code for the Plan of Secondary Membership
in aaspire PlanMemberId Plan Member Id of the Secondary Value in aaspire
UserPlanMemberId Identifies the linked membership to remove
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
ApiResponse[UserAccountModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserAccountModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserAccountModel {
id (integer, optional),
planCode (string, optional),
planMemberId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
isActivated (boolean, optional),
isPlanMemberDefault (boolean, optional),
isPlanMemberEnabled (boolean, optional),
isPasswordResetRequired (boolean, optional),
hasLinkedAccounts (boolean, optional),
isAccountLocked (boolean, optional),
lastLoginDateTime (string, optional),
planMemberReference (string, optional),
createdDateTime (string, optional),
isLockedOutFailedAttempts (boolean, optional),
failedAttemptsLockedDateTime (string, optional),
isAccountLockedAdmin (boolean, optional),
adminLockDateTime (string, optional),
linkedMembers (Array[LinkedMembersModel], optional)
}
LinkedMembersModel {
planCode (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
userName (string, optional),
isPrimary (boolean, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"id": 0,
"planCode": "string",
"planMemberId": 0,
"userName": "string",
"emailAddress": "string",
"isActivated": true,
"isPlanMemberDefault": true,
"isPlanMemberEnabled": true,
"isPasswordResetRequired": true,
"hasLinkedAccounts": true,
"isAccountLocked": true,
"lastLoginDateTime": "2024-03-12T12:51:58.311Z",
"planMemberReference": "string",
"createdDateTime": "2024-03-12T12:51:58.311Z",
"isLockedOutFailedAttempts": true,
"failedAttemptsLockedDateTime": "2024-03-12T12:51:58.311Z",
"isAccountLockedAdmin": true,
"adminLockDateTime": "2024-03-12T12:51:58.311Z",
"linkedMembers": [
{
"planCode": "string",
"planMemberId": 0,
"planMemberReference": "string",
"userName": "string",
"isPrimary": true
}
]
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the member's plan
path string userId
The user identifier
path integer userPlanMemberId
The user plan member identifier
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
NoContent
401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USERSECURITYQUESTIONS
* Show/Hide
* List Operations
* Expand Operations
* * GET
/MEMBERUSERACCOUNT/PLANCODE/{PLANCODE}/USERACCOUNTS/{USERID}/SECURITYQUESTIONS
* Gets the Security Questions a User has provided
IMPLEMENTATION NOTES
SECURITY QUESTIONS
This API is used to return the Security Question a Member has provided.
The Answers the user has provided are not available for security reasons
(additionally they are stored using a one-way hash).
The caller can request a random subset of questions for use in a password
reset or a list of all questions the user has answered.
A User (and Calling application) must provide answers for no fewer than
the <MinQuestionsToAnswer>Configured for the Plan. This can be checked
with GET /api/planCode/{planCode}/securityQuestion
Please refer to Post
/memberuseraccount/plans/{planCode}/userAccounts/{userId}/forgottenPassword
to fetch the secret questions
VALIDATIONS
The supplied User Id must have at least one linked plan member belonging
to the Plan Code from the URL. If not 403 FORBIDDEN is returned.
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
Security Questions Answered by User
* Model
* Model Schema
ApiResponse[JArray] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Object, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
Object {}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {},
"message": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
Id number for a User in Member Centre. Distinct From Aaspire Member Id
and User Name
path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/MEMBERUSERACCOUNT/PLANCODE/{PLANCODE}/USERACCOUNTS/{USERID}/SECURITYQUESTIONS
* Adds a Security Questions For a User
IMPLEMENTATION NOTES
SET USER SECURITY QUESTIONS
This service is used during user password reset process to submit users
answer to security quesions. Service creates/submits collection of
answers to security questions.
QUESTION DATA FIELDS
Field NameDescriptionValidations IDSecurity Question IDMust Match
<SecurityQuestionId> from GET /api/planCode/{planCode}/securityQuestion
AnswerToSecurityQuestionAnswer provided by user to the security question
Mandatory
VALIDATIONS
The User Id must have at least one linked plan member belonging to the
Plan Code from the URL.
A User (and Calling application) must provide answers for no fewer than
the <MinQuestionsToAnswer>Configured for the Plan. This can be checked
with GET /api/planCode/{planCode}/securityQuestion
The supplied User Id must have at least one linked plan member belonging
to the Plan Code from the URL. If not 403 FORBIDDEN is returned.
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A user security question
* Model
* Model Schema
ApiResponse[UserSecurityQuestionAnswerModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserSecurityQuestionAnswerModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserSecurityQuestionAnswerModel {
userId (integer, optional),
userSecurityQuestionId (integer, optional),
securityQuestionId (integer, optional),
securityQuestion (string, optional),
securityQuestionAnswer (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"userId": 0,
"userSecurityQuestionId": 0,
"securityQuestionId": 0,
"securityQuestion": "string",
"securityQuestionAnswer": "string"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string userId
The user identifier
path integer securityQuestionAnswer
Parameter content type: application/json text/json application/xml
text/xml
The user security question
body
* Model
* Model Schema
NewUserSecurityQuestionAnswerModel {
questions (Array[CreateUserSecurityQuestionAnswerModel], optional),
password (string, optional)
}
CreateUserSecurityQuestionAnswerModel {
securityQuestionId (integer, optional),
securityQuestionAnswer (string, optional)
}
{
"questions": [
{
"securityQuestionId": 0,
"securityQuestionAnswer": "string"
}
],
"password": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
403
Forbidden
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USERSESSIONS
* Show/Hide
* List Operations
* Expand Operations
* * GET /MEMBERUSERACCOUNT/PLANCODE/{PLANCODE}/SESSIONS/{SESSIONID}
* Gets user session information
IMPLEMENTATION NOTES
RETRIEVE USER SESSION INFORMATION
This API is used to identify whether the user is impersonating. Also it
is designed to be extendable to include additional session information.
DATA FIELDS
To retrieve the user session information, the following should be passed
in the Body of api. Passing values in the Body of the API call will allow
it to be encrypted during communication. Calling applications are
responsible for collecting the details securely
Field Use/Validation RS Two Letter Alphanumeric Code of Member's plan
from Aaspire SessionId User Session ID
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A plan user session
* Model
* Model Schema
ApiResponse[UserSessionModel] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (UserSessionModel, optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
UserSessionModel {
sessionToken (string, optional),
isImpersonating (boolean, optional),
userId (integer, optional),
userName (string, optional),
emailAddress (string, optional),
planCode (string, optional),
planMemberId (integer, optional),
planMemberReference (string, optional),
registrationDateTime (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": {
"sessionToken": "string",
"isImpersonating": true,
"userId": 0,
"userName": "string",
"emailAddress": "string",
"planCode": "string",
"planMemberId": 0,
"planMemberReference": "string",
"registrationDateTime": "2024-03-12T12:51:58.320Z"
},
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the User's plan
path string sessionId path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USERVERIFIEDIDENTITY
* Show/Hide
* List Operations
* Expand Operations
* * GET
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/VERIFIEDIDENTITYUSER
* Retreives the verifiedidentityuserid
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
A list of members linked to this account
* Model
* Model Schema
ApiResponse[List[GetUserVerifiedIdentityModel]] {
_links (Array[ApiLink], optional):
Gets or sets the links. "self" is automatically populated.
,
resource (Array[GetUserVerifiedIdentityModel], optional):
Gets or sets the resource.
,
message (string, optional):
Gets or sets the message.
}
ApiLink {
rel (string, optional):
Gets or sets the relationship name
,
href (string, optional):
Gets or sets the href.
}
GetUserVerifiedIdentityModel {
planCode (string, optional),
userId (integer, optional),
verifiedIdentityUserId (string, optional)
}
{
"_links": [
{
"rel": "string",
"href": "string"
}
],
"resource": [
{
"planCode": "string",
"userId": 0,
"verifiedIdentityUserId": "string"
}
],
"message": "string"
}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode path string
userId path integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST
/MEMBERUSERACCOUNT/PLANS/{PLANCODE}/USERACCOUNTS/{USERID}/VERIFIEDIDENTITYUSER
* Links verifiedIdentityUserId to user
linkgroup.fundadmin.memberuseraccountservice.api
RESPONSE CLASS (STATUS 200)
OK
* Model
* Model Schema
Object {}
{}
Response Content Type application/json text/json application/xml text/xml
PARAMETERS
Parameter Value Description Parameter Type Data Type planCode
Two character Alphanumeric code of the member's plan
path string userId
The user identifier
path integer createUserVerifiedIdentityModel
Parameter content type: application/json text/json application/xml
text/xml
itsme userId
body
* Model
* Model Schema
CreateUserVerifiedIdentityModel {
verifiedIdentityUserId (string, optional)
}
{
"verifiedIdentityUserId": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 204
NoContent
400
BadRequest
401
Unauthorized
404
NotFound
default
Default response
* Model
* Model Schema
ApiError {
message (string, optional),
exceptionMessage (string, optional),
exceptionType (string, optional),
stackTrace (string, optional),
innerException (ApiError, optional),
source (string, optional),
helpLink (string, optional),
hResult (integer, optional),
data (object, optional),
modelState (object, optional):
Gets or sets the state of the model. Populated if action or controller is
decorated with [ModelValidationFilter].
}
{
"message": "string",
"exceptionMessage": "string",
"exceptionType": "string",
"stackTrace": "string",
"innerException": {},
"source": "string",
"helpLink": "string",
"hResult": 0,
"data": {},
"modelState": {}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: , API VERSION: V1 ]