{{nickname}}
{{summary}}
{{notes}}
{{path}}
Usage and SDK Samples
curl -X {{vendorExtensions.x-codegen-httpMethodUpperCase}}{{#authMethods}}{{#is this 'api-key'}}{{#is this 'key-in-header'}} -H "{{keyParamName}}: [[apiKey]]"{{/is}}{{/is}}{{#is this 'basic'}}{{#has this 'produces'}} -H "Accept: {{#produces}}{{{mediaType}}}{{#hasMore}},{{/hasMore}}{{/produces}}"{{/has}}{{#has this 'consumes'}} -H "Content-Type: {{#consumes}}{{{mediaType}}}{{#hasMore}},{{/hasMore}}{{/consumes}}"{{/has}} -H "Authorization: Basic [[basicHash]]"{{/is}}{{/authMethods}} "{{basePath}}{{path}}{{#hasQueryParams}}?{{#queryParams}}{{^@first}}&{{/@first}}{{baseName}}={{vendorExtensions.x-eg}}{{/queryParams}}{{/hasQueryParams}}"
{{>sample_java}}
{{>sample_android}}
{{>sample_objc}}
{{>sample_js}}
{{>sample_csharp}}
{{>sample_php}}
{{>sample_perl}}
{{>sample_python}}
Parameters
{{#hasPathParams}}Path parameters
| Name | Description |
|---|
Header parameters
| Name | Description |
|---|
Body parameters
| Name | Description |
|---|
Form parameters
| Name | Description |
|---|
Query parameters
| Name | Description |
|---|
Responses
{{#responses}}Status: {{code}} - {{message}}
{{#schema}}
{{#examples}}
{{/examples}}
{{/schema}}
{{#hasHeaders}}
{{/hasHeaders}}
{{/responses}}
{{example}}
| Name | Type | Format | Description |
|---|---|---|---|
| {{#name}}{{name}}{{/name}} | {{#datatype}}{{datatype}}{{/datatype}} | {{#dataFormat}}{{dataFormat}}{{/dataFormat}} | {{#description}}{{description}}{{/description}} |
