Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the sv-pagetree macro with the following parameter(s): []
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

All SummitAI API Requests contain the following common parameters:

For API Key Based Authentication

Common Parameters

Parameter NameTypeDescriptionNotes
AuthType

Status
colourGreen
titleString

Type of Authentication.Value should be APIKey.
APIKey

Status
colourGreen
titleString

APIKey that is generated that is described in API Authentication and Authorization section.
ProxyID

Status
titleInteger

Unique Identification number of the proxy.The value should be 0.
ReturnType

Status
colourGreen
titleString

Type of the request return.For Example: Json, XML, YAML, etc.
OrgID

Status
titleInteger

Unique Identification of the Organization.The value should be 1.
TokenID

Status
colourGreen
titleString

Number of the token whose details should come in Response.The value should be empty.

For Username and Password Based Authentication

Common Parameters

Parameter NameTypeDescriptionNotes
UserName

Status
colourGreen
titleString

Login name of the User.
Password

Status
colourGreen
titleString

Login password of the User.
ProxyID

Status
titleInteger

Unique Identification number of the proxy.The value should be 0.
ReturnType

Status
colourGreen
titleString

Type of the request return.For Example: Json, XML, YAML, etc.
OrgID

Status
titleInteger

Unique Identification of the Organization.The value should be 1.
TokenID

Status
colourGreen
titleString

Number of the token whose details should come in Response.The value should be empty.
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue


1

| |