Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Updated the hideelements-macro macro with the following parameter(s): []
Scroll ignore | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
All SummitAI API Requests contain the following common parameters:
For API Key Based Authentication
Common Parameters
Parameter Name | Type | Description | Notes | ||||||
---|---|---|---|---|---|---|---|---|---|
AuthType |
| Type of Authentication. | Value should be APIKey. | ||||||
APIKey |
| APIKey that is generated that is described in API Authentication and Authorization section. | |||||||
ProxyID |
| Unique Identification number of the proxy. | The value should be 0. | ||||||
ReturnType |
| Type of the request return. | For Example: Json, XML, YAML, etc. | ||||||
OrgID |
| Unique Identification of the Organization. | The value should be 1. | ||||||
TokenID |
| Number of the token whose details should come in Response. | The value should be empty. |
For Username and Password Based Authentication
Common Parameters
Parameter Name | Type | Description | Notes | ||||||
---|---|---|---|---|---|---|---|---|---|
UserName |
| Login name of the User. | |||||||
Password |
| Login password of the User. | |||||||
ProxyID |
| Unique Identification number of the proxy. | The value should be 0. | ||||||
ReturnType |
| Type of the request return. | For Example: Json, XML, YAML, etc. | ||||||
OrgID |
| Unique Identification of the Organization. | The value should be 1. | ||||||
TokenID |
| Number of the token whose details should come in Response. | The value should be empty. |
Scroll ignore | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|