AT AppointmentTrader
Iniciar sesión
En línea ahora  

/v1/documentation/

Search the AppointmentTrader API reference.
GET

/v1/documentation/get_search_index

#
Get a compact index of documented endpoints and category links. Public-by-design: guests can search the public API reference; restricted documentation requires developer access.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/documentation/get_search_index' \
  --data-urlencode 'key={{API_KEY}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$documentation_get_search_index_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.entriesarray si
$.oneOf[0].allOf[1].Payload.entries[]object No
$.oneOf[0].allOf[1].Payload.entries[].categorystring si
$.oneOf[0].allOf[1].Payload.entries[].methodstring si
$.oneOf[0].allOf[1].Payload.entries[].summarystring si
$.oneOf[0].allOf[1].Payload.entries[].urlstring si
$.oneOf[0].allOf[1].Payload.categoriesarray si
$.oneOf[0].allOf[1].Payload.categories[]object No
$.oneOf[0].allOf[1].Payload.categories[].namestring si
$.oneOf[0].allOf[1].Payload.categories[].descriptionstring si
$.oneOf[0].allOf[1].Payload.categories[].countinteger si
$.oneOf[0].allOf[1].Payload.categories[].urlstring si
$.oneOf[0].allOf[1].Payload.versionstring si
$.oneOf[0].allOf[1].Payload.maxAge = 3600 si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/documentation/get_search_index",
    "RequestUserAlias": "example-user",
    "Payload": {
        "entries": [
            {
                "category": "example",
                "method": "get_example",
                "summary": "Read synthetic example.",
                "url": "/api-documentation?category=example#ep-example-get_example"
            }
        ],
        "categories": [
            {
                "name": "example",
                "description": "Synthetic examples.",
                "count": 1,
                "url": "/api-documentation?category=example"
            }
        ],
        "version": "api-docs-0000000000000000000000000000000000000000000000000000000000000000",
        "maxAge": 3600
    }
}
Documentación del endpoint legible por máquinas