Skip to content
Permalink
580ecb1886
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time
663 lines (564 sloc) 25.7 KB
<!doctype html>
<html>
<head>
<title>ID Match API</title>
<style type="text/css">
body {
font-family: Trebuchet MS, sans-serif;
font-size: 15px;
color: #444;
margin-right: 24px;
}
h1 {
font-size: 25px;
}
h2 {
font-size: 20px;
}
h3 {
font-size: 16px;
font-weight: bold;
}
hr {
height: 1px;
border: 0;
color: #ddd;
background-color: #ddd;
}
.app-desc {
clear: both;
margin-left: 20px;
}
.param-name {
width: 100%;
}
.license-info {
margin-left: 20px;
}
.license-url {
margin-left: 20px;
}
.model {
margin: 0 0 0px 20px;
}
.method {
margin-left: 20px;
}
.method-notes {
margin: 10px 0 20px 0;
font-size: 90%;
color: #555;
}
pre {
padding: 10px;
margin-bottom: 2px;
}
.http-method {
text-transform: uppercase;
}
pre.get {
background-color: #0f6ab4;
}
pre.post {
background-color: #10a54a;
}
pre.put {
background-color: #c5862b;
}
pre.delete {
background-color: #a41e22;
}
.huge {
color: #fff;
}
pre.example {
background-color: #f3f3f3;
padding: 10px;
border: 1px solid #ddd;
}
code {
white-space: pre;
}
.nickname {
font-weight: bold;
}
.method-path {
font-size: 1.5em;
background-color: #0f6ab4;
}
.up {
float:right;
}
.parameter {
width: 500px;
}
.param {
width: 500px;
padding: 10px 0 0 20px;
font-weight: bold;
}
.param-desc {
width: 700px;
padding: 0 0 0 20px;
color: #777;
}
.param-type {
font-style: italic;
}
.param-enum-header {
width: 700px;
padding: 0 0 0 60px;
color: #777;
font-weight: bold;
}
.param-enum {
width: 700px;
padding: 0 0 0 80px;
color: #777;
font-style: italic;
}
.field-label {
padding: 0;
margin: 0;
clear: both;
}
.field-items {
padding: 0 0 15px 0;
margin-bottom: 15px;
}
.return-type {
clear: both;
padding-bottom: 10px;
}
.param-header {
font-weight: bold;
}
.method-tags {
text-align: right;
}
.method-tag {
background: none repeat scroll 0% 0% #24A600;
border-radius: 3px;
padding: 2px 10px;
margin: 2px;
color: #FFF;
display: inline-block;
text-decoration: none;
}
</style>
</head>
<body>
<h1>ID Match API</h1>
<div class="app-desc">ID Match API Specification from Internet2 Trust and Identity, and Spherical Cow Group</div>
<div class="app-desc">More information: <a href="https://helloreverb.com">https://helloreverb.com</a></div>
<div class="app-desc">Contact Info: <a href="hello@helloreverb.com">hello@helloreverb.com</a></div>
<div class="app-desc">Version: 1.1.1</div>
<div class="app-desc">BasePath:/I2/idMatch/v1</div>
<div class="license-info">All rights reserved</div>
<div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div>
<h2>Access</h2>
<ol>
<li>OAuth AuthorizationUrl:http://example.com/oauth/authTokenUrl:http://example.com/oauth/token</li>
</ol>
<h2><a name="__Methods">Methods</a></h2>
[ Jump to <a href="#__Models">Models</a> ]
<h3>Table of Contents </h3>
<div class="method-summary"></div>
<h4><a href="#Default">Default</a></h4>
<ul>
<li><a href="#pingGet"><code><span class="http-method">get</span> /ping</code></a></li>
</ul>
<h4><a href="#IdMatch">IdMatch</a></h4>
<ul>
<li><a href="#requestRefId"><code><span class="http-method">put</span> /people/{sorLabel}/{sorId}</code></a></li>
<li><a href="#requestSerchOnlyGet"><code><span class="http-method">get</span> /people/{sorLabel}/{sorId}</code></a></li>
<li><a href="#requestSerchOnlyPost"><code><span class="http-method">post</span> /people/{sorLabel}/{sorId}</code></a></li>
</ul>
<h1><a name="Default">Default</a></h1>
<div class="method"><a name="pingGet"></a>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /ping</code></pre></div>
<div class="method-summary">Server heartbeat operation (<span class="nickname">pingGet</span>)</div>
<div class="method-notes">This operation shows how to override the global security defined above as we want to open it up for all users.</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
OK
<a href="#"></a>
</div> <!-- method -->
<hr/>
<h1><a name="IdMatch">IdMatch</a></h1>
<div class="method"><a name="requestRefId"></a>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="put"><code class="huge"><span class="http-method">put</span> /people/{sorLabel}/{sorId}</code></pre></div>
<div class="method-summary">Request a Reference Identifier for an SOR Person (<span class="nickname">requestRefId</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">sorLabel (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; The official designation of the requesting SOR </div> <div class="param">sorId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; The SOR-assigned identifier for the person </div> </div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body <a href="#people">people</a> (optional)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
<div class="param-desc"><span class="param-type">example: <code>{
&quot;names&quot; : [ {
&quot;type&quot; : &quot;official&quot;,
&quot;given&quot; : &quot;Pat&quot;,
&quot;family&quot; : &quot;Lee&quot;
} ],
&quot;dateOfBirth&quot; : &quot;1983-03-18&quot;,
&quot;identifiers&quot; : [ {
&quot;type&quot; : &quot;national&quot;,
&quot;identifier&quot; : &quot;3B902AE12DF55196&quot;
} ],
&quot;telephoneNumbers&quot; : [ {
&quot;type&quot; : &quot;mobile&quot;,
&quot;number&quot; : 8185551234
} ]
}</code></span></div> </div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#people">people</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"sorLabel" : "sorLabel",
"identifier" : [ {
"id" : "id",
"type" : "type"
}, {
"id" : "id",
"type" : "type"
} ],
"emailAddress" : [ {
"address" : "address",
"verified" : "verified",
"type" : "type"
}, {
"address" : "address",
"verified" : "verified",
"type" : "type"
} ],
"names" : [ {
"given" : "given",
"type" : "type",
"family" : "family"
}, {
"given" : "given",
"type" : "type",
"family" : "family"
} ],
"address" : [ {
"country" : "country",
"streetAddress" : "streetAddress",
"formatted" : "formatted",
"postalCode" : "postalCode",
"locality" : "locality",
"verified" : "verified",
"language" : "language",
"region" : "region",
"type" : "type",
"room" : "room"
}, {
"country" : "country",
"streetAddress" : "streetAddress",
"formatted" : "formatted",
"postalCode" : "postalCode",
"locality" : "locality",
"verified" : "verified",
"language" : "language",
"region" : "region",
"type" : "type",
"room" : "room"
} ],
"telephoneNumber" : [ {
"number" : "number",
"type" : "type"
}, {
"number" : "number",
"type" : "type"
} ],
"gender" : "gender",
"sorId" : "sorId",
"dateOfBirth" : "dateOfBirth",
"primaryAffiliation" : "primaryAffiliation",
"referenceId" : "referenceId"
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Return referenceId for a person known to ID Match
<a href="#people">people</a>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{&quot;names&quot;:[{&quot;type&quot;:&quot;official&quot;,&quot;given&quot;:&quot;Pat&quot;,&quot;family&quot;:&quot;Lee&quot;}],&quot;dateOfBirth&quot;:&quot;1983-03-18&quot;,&quot;identifiers&quot;:[{&quot;type&quot;:&quot;national&quot;,&quot;identifier&quot;:&quot;3B902AE12DF55196&quot;}],&quot;telephoneNumbers&quot;:[{&quot;type&quot;:&quot;mobile&quot;,&quot;number&quot;:8185551234}],&quot;referenceId&quot;:&quot;M523441767&quot;}</code></pre>
<h4 class="field-label">201</h4>
Return new referenceId for a person new to ID Match
<a href="#people">people</a>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{&quot;names&quot;:[{&quot;type&quot;:&quot;official&quot;,&quot;given&quot;:&quot;Pat&quot;,&quot;family&quot;:&quot;Lee&quot;}],&quot;dateOfBirth&quot;:&quot;1983-03-18&quot;,&quot;identifiers&quot;:[{&quot;type&quot;:&quot;national&quot;,&quot;identifier&quot;:&quot;3B902AE12DF55196&quot;}],&quot;telephoneNumbers&quot;:[{&quot;type&quot;:&quot;mobile&quot;,&quot;number&quot;:8185551234}],&quot;referenceId&quot;:&quot;M523441767&quot;}</code></pre>
<h4 class="field-label">400</h4>
Invalid request
<a href="#inline_response_400">inline_response_400</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="requestSerchOnlyGet"></a>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /people/{sorLabel}/{sorId}</code></pre></div>
<div class="method-summary">GET-based; Search only, similar to a regular request, except that a new identity will never be created as a result of the request (<span class="nickname">requestSerchOnlyGet</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">sorLabel (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; The official designation of the requesting SOR </div> <div class="param">sorId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; The SOR-assigned identifier for the person </div> </div> <!-- field-items -->
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">name.0 (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The </div> <div class="param">dateOfBirth (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> &mdash; The </div> </div> <!-- field-items -->
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
An existing identity was found matching the specified attributes.
<a href="#"></a>
<h4 class="field-label">201</h4>
Return new referenceId for a person new to ID Match
<a href="#"></a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="requestSerchOnlyPost"></a>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /people/{sorLabel}/{sorId}</code></pre></div>
<div class="method-summary">POST-based; Search only, similar to a regular request, except that a new identity will never be created as a result of the request (<span class="nickname">requestSerchOnlyPost</span>)</div>
<div class="method-notes"></div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">sorLabel (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; The official designation of the requesting SOR </div> <div class="param">sorId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; The SOR-assigned identifier for the person </div> </div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body <a href="#people">people</a> (optional)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
<div class="param-desc"><span class="param-type">example: <code>{
&quot;names&quot; : [ {
&quot;type&quot; : &quot;official&quot;,
&quot;given&quot; : &quot;Pat&quot;,
&quot;family&quot; : &quot;Lee&quot;
} ],
&quot;dateOfBirth&quot; : &quot;1983-03-18&quot;,
&quot;identifiers&quot; : [ {
&quot;type&quot; : &quot;national&quot;,
&quot;identifier&quot; : &quot;3B902AE12DF55196&quot;
} ],
&quot;telephoneNumbers&quot; : [ {
&quot;type&quot; : &quot;mobile&quot;,
&quot;number&quot; : 8185551234
} ]
}</code></span></div> </div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#people">people</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"sorLabel" : "sorLabel",
"identifier" : [ {
"id" : "id",
"type" : "type"
}, {
"id" : "id",
"type" : "type"
} ],
"emailAddress" : [ {
"address" : "address",
"verified" : "verified",
"type" : "type"
}, {
"address" : "address",
"verified" : "verified",
"type" : "type"
} ],
"names" : [ {
"given" : "given",
"type" : "type",
"family" : "family"
}, {
"given" : "given",
"type" : "type",
"family" : "family"
} ],
"address" : [ {
"country" : "country",
"streetAddress" : "streetAddress",
"formatted" : "formatted",
"postalCode" : "postalCode",
"locality" : "locality",
"verified" : "verified",
"language" : "language",
"region" : "region",
"type" : "type",
"room" : "room"
}, {
"country" : "country",
"streetAddress" : "streetAddress",
"formatted" : "formatted",
"postalCode" : "postalCode",
"locality" : "locality",
"verified" : "verified",
"language" : "language",
"region" : "region",
"type" : "type",
"room" : "room"
} ],
"telephoneNumber" : [ {
"number" : "number",
"type" : "type"
}, {
"number" : "number",
"type" : "type"
} ],
"gender" : "gender",
"sorId" : "sorId",
"dateOfBirth" : "dateOfBirth",
"primaryAffiliation" : "primaryAffiliation",
"referenceId" : "referenceId"
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Return referenceId for a person known to ID Match
<a href="#people">people</a>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{&quot;names&quot;:[{&quot;type&quot;:&quot;official&quot;,&quot;given&quot;:&quot;Pat&quot;,&quot;family&quot;:&quot;Lee&quot;}],&quot;dateOfBirth&quot;:&quot;1983-03-18&quot;,&quot;identifiers&quot;:[{&quot;type&quot;:&quot;national&quot;,&quot;identifier&quot;:&quot;3B902AE12DF55196&quot;}],&quot;telephoneNumbers&quot;:[{&quot;type&quot;:&quot;mobile&quot;,&quot;number&quot;:8185551234}],&quot;referenceId&quot;:&quot;M523441767&quot;}</code></pre>
<h4 class="field-label">201</h4>
Return new referenceId for a person new to ID Match
<a href="#people">people</a>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{&quot;names&quot;:[{&quot;type&quot;:&quot;official&quot;,&quot;given&quot;:&quot;Pat&quot;,&quot;family&quot;:&quot;Lee&quot;}],&quot;dateOfBirth&quot;:&quot;1983-03-18&quot;,&quot;identifiers&quot;:[{&quot;type&quot;:&quot;national&quot;,&quot;identifier&quot;:&quot;3B902AE12DF55196&quot;}],&quot;telephoneNumbers&quot;:[{&quot;type&quot;:&quot;mobile&quot;,&quot;number&quot;:8185551234}],&quot;referenceId&quot;:&quot;M523441767&quot;}</code></pre>
<h4 class="field-label">300</h4>
Multiple Choices
<a href="#people">people</a>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{&quot;names&quot;:[{&quot;type&quot;:&quot;official&quot;,&quot;given&quot;:&quot;Pat&quot;,&quot;family&quot;:&quot;Lee&quot;}],&quot;dateOfBirth&quot;:&quot;1983-03-18&quot;,&quot;identifiers&quot;:[{&quot;type&quot;:&quot;national&quot;,&quot;identifier&quot;:&quot;3B902AE12DF55196&quot;}],&quot;telephoneNumbers&quot;:[{&quot;type&quot;:&quot;mobile&quot;,&quot;number&quot;:8185551234}],&quot;referenceId&quot;:&quot;M523441767&quot;}</code></pre>
<h4 class="field-label">400</h4>
Invalid request
<a href="#inline_response_400">inline_response_400</a>
</div> <!-- method -->
<hr/>
<h2><a name="__Models">Models</a></h2>
[ Jump to <a href="#__Methods">Methods</a> ]
<h3>Table of Contents</h3>
<ol>
<li><a href="#inline_response_400"><code>inline_response_400</code></a></li>
<li><a href="#people"><code>people</code></a></li>
<li><a href="#people_address"><code>people_address</code></a></li>
<li><a href="#people_emailAddress"><code>people_emailAddress</code></a></li>
<li><a href="#people_identifier"><code>people_identifier</code></a></li>
<li><a href="#people_names"><code>people_names</code></a></li>
<li><a href="#people_telephoneNumber"><code>people_telephoneNumber</code></a></li>
</ol>
<div class="model">
<h3><a name="inline_response_400"><code>inline_response_400</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">message (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="people"><code>people</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">sorLabel (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">sorId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">dateOfBirth (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">names (optional)</div><div class="param-desc"><span class="param-type"><a href="#people_names">array[people_names]</a></span> </div>
<div class="param">address (optional)</div><div class="param-desc"><span class="param-type"><a href="#people_address">array[people_address]</a></span> </div>
<div class="param">emailAddress (optional)</div><div class="param-desc"><span class="param-type"><a href="#people_emailAddress">array[people_emailAddress]</a></span> </div>
<div class="param">identifier (optional)</div><div class="param-desc"><span class="param-type"><a href="#people_identifier">array[people_identifier]</a></span> </div>
<div class="param">primaryAffiliation (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">gender (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">telephoneNumber (optional)</div><div class="param-desc"><span class="param-type"><a href="#people_telephoneNumber">array[people_telephoneNumber]</a></span> </div>
<div class="param">referenceId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="people_address"><code>people_address</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">country (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">formatted (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">language (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">locality (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">postalCode (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">region (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">room (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">streetAddress (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">verified (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="people_emailAddress"><code>people_emailAddress</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">address (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">verified (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="people_identifier"><code>people_identifier</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="people_names"><code>people_names</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">given (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">family (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="people_telephoneNumber"><code>people_telephoneNumber</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">number (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
</div> <!-- field-items -->
</div>
</body>
</html>