GET api/v2.0/System/GetApiDetails

Returns name and parameter type descriptions for the public API endpoints.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Controller
NameDescriptionTypeAdditional information
Name

string

None.

Endpoints

Collection of Endpoint

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Endpoints": [
      {
        "Name": "sample string 1",
        "ParameterCount": 2,
        "Parameters": [
          {
            "Name": "sample string 1",
            "Type": null,
            "ExtendedProperties": [
              {
                "Name": "sample string 1",
                "Type": null
              },
              {
                "Name": "sample string 1",
                "Type": null
              }
            ]
          },
          {
            "Name": "sample string 1",
            "Type": null,
            "ExtendedProperties": [
              {
                "Name": "sample string 1",
                "Type": null
              },
              {
                "Name": "sample string 1",
                "Type": null
              }
            ]
          }
        ],
        "Path": "sample string 2",
        "RequestType": null,
        "ReturnType": null
      },
      {
        "Name": "sample string 1",
        "ParameterCount": 2,
        "Parameters": [
          {
            "Name": "sample string 1",
            "Type": null,
            "ExtendedProperties": [
              {
                "Name": "sample string 1",
                "Type": null
              },
              {
                "Name": "sample string 1",
                "Type": null
              }
            ]
          },
          {
            "Name": "sample string 1",
            "Type": null,
            "ExtendedProperties": [
              {
                "Name": "sample string 1",
                "Type": null
              },
              {
                "Name": "sample string 1",
                "Type": null
              }
            ]
          }
        ],
        "Path": "sample string 2",
        "RequestType": null,
        "ReturnType": null
      }
    ]
  },
  {
    "Name": "sample string 1",
    "Endpoints": [
      {
        "Name": "sample string 1",
        "ParameterCount": 2,
        "Parameters": [
          {
            "Name": "sample string 1",
            "Type": null,
            "ExtendedProperties": [
              {
                "Name": "sample string 1",
                "Type": null
              },
              {
                "Name": "sample string 1",
                "Type": null
              }
            ]
          },
          {
            "Name": "sample string 1",
            "Type": null,
            "ExtendedProperties": [
              {
                "Name": "sample string 1",
                "Type": null
              },
              {
                "Name": "sample string 1",
                "Type": null
              }
            ]
          }
        ],
        "Path": "sample string 2",
        "RequestType": null,
        "ReturnType": null
      },
      {
        "Name": "sample string 1",
        "ParameterCount": 2,
        "Parameters": [
          {
            "Name": "sample string 1",
            "Type": null,
            "ExtendedProperties": [
              {
                "Name": "sample string 1",
                "Type": null
              },
              {
                "Name": "sample string 1",
                "Type": null
              }
            ]
          },
          {
            "Name": "sample string 1",
            "Type": null,
            "ExtendedProperties": [
              {
                "Name": "sample string 1",
                "Type": null
              },
              {
                "Name": "sample string 1",
                "Type": null
              }
            ]
          }
        ],
        "Path": "sample string 2",
        "RequestType": null,
        "ReturnType": null
      }
    ]
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.