GET v1/core/documentation/details?apiID={apiID}

Returns documentation for an API call for supplied API ID.

Request Information

Parameters

NameDescriptionAdditional information
apiID

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Success": true,
  "Data": {
    "requestBody": null,
    "responseBody": null,
    "apiDescr": "sample string 1"
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:
{"Success":true,"Data":{"requestBody":null,"responseBody":null,"apiDescr":"sample string 1"},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: One or more errors occurred.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: One or more errors occurred.

application/bson

Sample:
�SuccessData>
requestBody
responseBodyapiDescrsample string 1ErrorCodeErrorDescriptionsample string 3Metasample string 4