### API Example Tab Content

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

Defines the content for an API example tab. This includes the example's type and the code block itself.

```handlebars
<div class="tab-pane{{#if_eq @index compare=0}} active{{/if_eq}}" id="examples-{{../id}}-{{@index}}">
 <pre data-type="{{type}}
```

--------------------------------

### Comparing Example Code Snippets

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This Handlebars template displays example code snippets within tabbed panes, allowing users to compare different versions of code. It highlights differences and supports various code types.

```html
{{#if typeSame}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="{{../../section}}-compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{source.type}}"><code class="language-{{source.type}}">{{{showDiff source.content compare.content}}}</code></pre> </div> {{/if}} {{#if typeIns}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="{{../../section}}-compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{source.type}}"><code class="language-{{source.type}}">{{{source.content}}}</code></pre> </div> {{/if}} {{#if typeDel}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="{{../../section}}-compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{compare.type}}"><code class="language-{{compare.type}}">{{{compare.content}}}</code></pre> </div> {{/if}}
```

--------------------------------

### API Article Comparison View

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This Handlebars template snippet renders a comparison view for API articles, highlighting differences in titles, descriptions, URLs, and example content between versions. It uses tabs to navigate through different examples.

```html
<article id="api-{{article.group}}-{{article.name}}-{{article.version}}" {{#if hidden}}class="hide"{{/if}} data-group="{{article.group}}" data-name="{{article.name}}" data-version="{{article.version}}" data-compare-version="{{compare.version}}"> <div class="pull-left"> <h1>{{underscoreToSpace article.group}} - {{{showDiff article.title compare.title}}}</h1> </div> <div class="pull-right"> <div class="btn-group"> <button class="btn btn-success" disabled> <strong>{{article.version}}</strong> {{\__ "compared to"}} </button> <button class="version btn btn-danger dropdown-toggle" data-toggle="dropdown"> <strong>{{compare.version}}</strong>&nbsp;<span class="caret"></span> </button> <ul class="versions dropdown-menu open-left"> <li class="disabled"><a href="#">{{\__ "compare changes to:"}}</a></li> <li class="divider"></li> {{#each versions}} <li class="version"><a href="#">{{this}}</a></li> {{/each}} </ul> </div> </div> <div class="clearfix"></div> {{#if article.description}} <p>{{{showDiff article.description compare.description "nl2br"}}}</p> {{else}} {{#if compare.description}} <p>{{{showDiff "" compare.description "nl2br"}}}</p> {{/if}} {{/if}} <pre data-type="{{toLowerCase article.type}}"><code class="language-html">{{{showDiff article.url compare.url}}}</code></pre> {{subTemplate "article-compare-permission" article=article compare=compare}} <ul class="nav nav-tabs nav-tabs-examples"> {{#each_compare_title article.examples compare.examples}} {{#if typeSame}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#compare-examples-{{../../article.id}}-{{index}}">{{{showDiff source.title compare.title}}}</a> </li> {{/if}} {{#if typeIns}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#compare-examples-{{../../article.id}}-{{index}}"><ins>{{{source.title}}}</ins></a> </li> {{/if}} {{#if typeDel}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#compare-examples-{{../../article.id}}-{{index}}"><del>{{{compare.title}}}</del></a> </li> {{/if}} {{/each_compare_title}} </ul> <div class="tab-content"> {{#each_compare_title article.examples compare.examples}} {{#if typeSame}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{source.type}}"><code class="language-{{source.type}}">{{{showDiff source.content compare.content}}}</code></pre> </div> {{/if}} {{#if typeIns}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{source.type}}"><code class="language-{{source.type}}">{{{source.content}}}</code></pre> </div> {{/if}} {{#if typeDel}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{compare.type}}"><code class="language-{{source.type}}">{{{compare.content}}}</code></pre> </div> {{/if}} {{/each_compare_title}} </div> {{subTemplate "article-compare-param-block" source=article.parameter compare=compare.parameter _hasType=_hasTypeInParameterFields section="parameter"}} {{subTemplate "article-compare-param-block" source=article.success compare=compare.success _hasType=_hasTypeInSuccessFields section="success"}} {{subTemplate "article-compare-param-block" source=article.error compare=compare.error _col1="Name" _hasType=_hasTypeInErrorFields section="error"}} {{subTemplate "article-sample-request" article=article id=id}} </article>
```

--------------------------------

### Sample Request Form Structure

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This section outlines the structure for a sample request form, including fields for URL, headers, and parameters. It uses Handlebars to dynamically render form elements based on API definition.

```Handlebars
{{#if article.sampleRequest}} <h2>{{\__ "Send a Sample Request"}}</h2> <form class="form-horizontal"> <fieldset> <div class="form-group"> <label class="col-md-3 control-label" for="{{../id}}-sample-request-url"></label> <div class="input-group"> <input id="{{../id}}-sample-request-url" type="text" class="form-control sample-request-url" value="{{article.sampleRequest.0.url}}" /> <span class="input-group-addon">{{\__ "url"}}</span> </div> </div> {{#if article.header}} {{#if article.header.fields}} <h3>{{\__ "Headers"}}</h3> {{#each article.header.fields}} <h4><input type="checkbox" data-sample-request-header-group-id="sample-request-header-{{@index}}" name="{{../id}}-sample-request-header" value="{{@index}}" class="sample-request-header sample-request-switch" checked />{{\__ @key}}</h4> <div class="{{../id}}-sample-request-header-fields"> {{#each this}} <div class="form-group"> <label class="col-md-3 control-label" for="sample-request-header-field-{{field}}">{{field}}</label> <div class="input-group"> <input type="text" placeholder="{{field}}" value="{{defaultValue}}" id="sample-request-header-field-{{field}}" class="form-control sample-request-header" data-sample-request-header-name="{{field}}" data-sample-request-header-group="sample-request-header-{{@../index}}"> <span class="input-group-addon">{{{type}}}</span> </div> </div> {{/each}} </div> {{/each}} {{/if}} {{/if}} {{#if article.parameter}} {{#if article.parameter.fields}} <h3>{{\__ "Parameters"}}</h3> {{#each article.parameter.fields}} <h4><input type="checkbox" data-sample-request-param-group-id="sample-request-param-{{@index}}" name="{{../id}}-sample-request-param" value="{{@index}}" class="sample-request-param sample-request-switch" checked/>{{\__ @key}} <select name="{{../id}}-sample-header-content-type" class="{{../id}}-sample-request-param-select sample-header-content-type sample-header-content-type-switch"> <option value="undefined" selected>ajax-auto</option> <option value="body-json" >body/json</option> <option value="body-form-data" >body/form-data</option> </select> </h4> <div class="{{../id}}-sample-request-param-body {{../id}}-sample-header-content-type-body hide"> <div class="form-group"> <div class="input-group"> <textarea id="sample-request-body-json" class="form-control sample-request-body" data-sample-request-body-group="sample-request-param-{{@./index}}" rows="6" style="OVERFLOW: visible" {{#if optional}}data-sample-request-param-optional="true"{{/if}}></textarea> <div class="input-group-addon">json</div> </div> </div> </div> <div class="{{../id}}-sample-request-param-fields {{../id}}-sample-header-content-type-fields"> {{#each this}} <div class="form-group"> <label class="col-md-3 control-label" for="sample-request-pa
```

--------------------------------

### API Endpoint Documentation

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This section details the available API endpoints, including their HTTP methods, paths, and expected request/response formats.

```APIDOC
## GET /api/v1/users/{userId}

### Description
Retrieves information about a specific user.

### Method
GET

### Endpoint
/api/v1/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The unique identifier of the user.

### Response
#### Success Response (200)
- **id** (string) - The user's unique identifier.
- **username** (string) - The user's username.
- **email** (string) - The user's email address.

#### Response Example
{
  "id": "user123",
  "username": "johndoe",
  "email": "john.doe@example.com"
}
```

```APIDOC
## POST /api/v1/users

### Description
Creates a new user.

### Method
POST

### Endpoint
/api/v1/users

### Parameters
#### Request Body
- **username** (string) - Required - The desired username for the new user.
- **email** (string) - Required - The email address for the new user.

### Request Example
{
  "username": "newuser",
  "email": "new.user@example.com"
}

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the newly created user.
- **message** (string) - A confirmation message.

#### Response Example
{
  "id": "user456",
  "message": "User created successfully."
}
```

```APIDOC
## PUT /api/v1/users/{userId}

### Description
Updates an existing user's information.

### Method
PUT

### Endpoint
/api/v1/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The unique identifier of the user to update.
#### Request Body
- **email** (string) - Optional - The updated email address for the user.

### Request Example
{
  "email": "updated.email@example.com"
}

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the update was successful.

#### Response Example
{
  "message": "User updated successfully."
}
```

```APIDOC
## DELETE /api/v1/users/{userId}

### Description
Deletes a user.

### Method
DELETE

### Endpoint
/api/v1/users/{userId}

### Parameters
#### Path Parameters
- **userId** (string) - Required - The unique identifier of the user to delete.

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the user was deleted.

#### Response Example
{
  "message": "User deleted successfully."
}
```

--------------------------------

### Display API Article Link

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

Renders a link to a specific API article within a group. It includes the article's title, URL, and associated group information.

```handlebars
<a href="#api-{{group}}-{{name}}" data-group="show-api-{{group}}" data-name="show-api-{{group}}-{{name}}" class="nav-list-item show-api api-{{group}}-{{name}}-init">{{title}}<div class="nav-list-url-item hide">{{url}}</div></a>
```

--------------------------------

### Display API URL

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

Shows the URL for a specific API endpoint. This is often displayed within an API article.

```http
{{article.url}}
```

--------------------------------

### Displaying API Permissions

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This Handlebars snippet iterates through API permissions, displaying their names and providing an info icon for additional details like title and description. It handles displaying comma separators between permissions.

```html
 {{\__ "Permission:"}} {{#each_compare_list_field article.permission compare.permission field="name"}} {{#if source}} {{#if typeSame}} {{source.name}} {{#if source.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unl
```

--------------------------------

### Display API Group URL

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

Displays the URL for an API group. This is typically used for navigation within the documentation.

```handlebars
<a href="#api-{{group}}" data-group="show-api-{{group}}" class="show-group api-{{group}}-init">{{underscoreToSpace title}}</a>
```

--------------------------------

### Comparing Form Fields with Descriptions

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This Handlebars template generates tables to compare form fields, including their names, types, and descriptions. It supports highlighting differences for 'same', 'inserted', and 'deleted' fields.

```html
{{#if typeSame}} <h2>{{\__ source.key}}</h2> <table> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{\__ ../_col1}}{{else}}{{\__ "Field"}}{{/if}}</th> {{#if ../_hasType}}<th style="width: 10%">{{\__ "Type"}}</th>{{/if}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{\__ "Description"}}</th> </tr> </thead> {{subTemplate "article-compare-param-block-body" source=source.value compare=compare.value _hasType=../_hasType}} </table> {{/if}} {{#if typeIns}} <h2><ins>{{\__ source.key}}</ins></h2> <table class="ins"> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{\__ ../_col1}}{{else}}{{\__ "Field"}}{{/if}}</th> {{#if ../_hasType}}<th style="width: 10%">{{\__ "Type"}}</th>{{/if}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{\__ "Description"}}</th> </tr> </thead> {{subTemplate "article-compare-param-block-body" source=source.value compare=source.value _hasType=../_hasType}} </table> {{/if}} {{#if typeDel}} <h2><del>{{\__ compare.key}}</del></h2> <table class="del"> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{\__ ../_col1}}{{else}}{{\__ "Field"}}{{/if}}</th> {{#if ../_hasType}}<th style="width: 10%">{{\__ "Type"}}</th>{{/if}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{\__ "Description"}}</th> </tr> </thead> {{subTemplate "article-compare-param-block-body" source=compare.value compare=compare.value _hasType=../_hasType}} </table> {{/if}}
```

--------------------------------

### Displaying Code Snippets with Language Type

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This Handlebars helper is used to render code snippets. It dynamically sets the language class based on the 'type' variable and displays the 'content'.

```Handlebars
</div> {{/each}} </div> {{/if_gt}} {{subTemplate "article-param-block" params=article.header _hasType=_hasTypeInHeaderFields section="header"}} {{subTemplate "article-param-block" params=article.parameter _hasType=_hasTypeInParameterFields section="parameter"}} {{subTemplate "article-param-block" params=article.success _hasType=_hasTypeInSuccessFields section="success"}} {{subTemplate "article-param-block" params=article.error _col1="Name" _hasType=_hasTypeInErrorFields section="error"}} {{subTemplate "article-sample-request" article=article id=id}} </article> {{#if params}} {{#each params.fields}} <h2>{{\__ @key}}</h2> <table> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{\__ ../_col1}}{{else}}{{\__ "Field"}}{{/if}}</th> {{#if ../_hasType}}<th style="width: 10%">{{\__ "Type"}}</th>{{/if}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{\__ "Description"}}</th> </tr> </thead> <tbody> {{#each this}} <tr> <td class="code">{{{splitFill field "." "&nbsp;&nbsp;"}}}{{#if optional}} <span class="label label-optional">{{\__ "optional"}}</span>{{/if}}</td> {{#if ../../_hasType}} <td> {{{type}}} </td> {{/if}} <td> {{{nl2br description}}} {{#if defaultValue}}<p class="default-value">{{\__ "Default value:"}} <code>{{{defaultValue}}}</code></p>{{/if}} {{#if size}}<p class="type-size">{{\__ "Size range:"}} <code>{{{size}}}</code></p>{{/if}} {{#if allowedValues}}<p class="type-size">{{\__ "Allowed values:"}} {{#each allowedValues}} <code>{{{this}}}</code>{{#unless @last}}, {{/unless}} {{/each}} </p>{{/if}} </td> </tr> {{/each}} </tbody> </table> {{/each}} {{#if_gt params.examples.length compare=0}} <ul class="nav nav-tabs nav-tabs-examples"> {{#each params.examples}} <li{{#if_eq @index compare=0}} class="active"{{/if_eq}}> <a href="#{{../section}}-examples-{{../id}}-{{@index}}">{{title}}</a> </li> {{/each}} </ul> <div class="tab-content"> {{#each params.examples}} <div class="tab-pane{{#if_eq @index compare=0}} active{{/if_eq}}" id="{{../section}}-examples-{{../id}}-{{@index}}"> <pre data-type="{{type}}"><code class="language-{{type}}">{{reformat content type}}</code></pre> </div> {{/each}} </div> {{/if_gt}} {{/if}}
```

--------------------------------

### Displaying API Request Parameters

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This Handlebars template snippet dynamically generates input fields for API request parameters. It supports different input types and optional fields, rendering them within an input group.

```html
<label for="sample-request-param-field-{{field}}">{{field}}</label> <div class="input-group"> <input id="sample-request-param-field-{{field}}" type="{{setInputType type}}" placeholder="{{field}}" class="form-control sample-request-param" data-sample-request-param-name="{{field}}" data-sample-request-param-group="sample-request-param-{{@../index}}" {{#if optional}}data-sample-request-param-optional="true"{{/if}}> <div class="input-group-addon">{{{type}}}</div> </div> </div> {{/each}} </div> {{/each}} {{/if}} <div class="form-group"> <div class="controls pull-right"> <button class="btn btn-primary sample-request-send" data-sample-request-type="{{article.type}}">{{\__ "Send"}}</button> </div> </div> <div class="form-group sample-request-response" style="display: none;"> <h3> {{\__ "Response"}} <button class="btn btn-default btn-xs pull-right sample-request-clear">X</button> </h3> <pre data-type="json"><code class="language-json sample-request-response-json"></code></pre> </div> </fieldset> </form>
```

--------------------------------

### Displaying Form Field Differences

Source: https://github.com/mitechnologies/formitize-net-api/blob/master/docs/index.html

This Handlebars template logic renders form field names, indicating whether they are the same, inserted, or deleted when comparing two versions. It includes popover functionality for additional details if available.

```html
{{#if typeIns}} <ins>{{source.name}}</ins> {{#if source.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{#if typeDel}} <del>{{source.name}}</del> {{#if source.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{else}} {{#if typeSame}} {{compare.name}} {{#if compare.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{#if typeIns}} <ins>{{compare.name}}</ins> {{#if compare.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{#if typeDel}} <del>{{compare.name}}</del> {{#if compare.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{/if}} {{/each_compare_list_field}}
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.