List Endpoint REST Endpoint

GET api.ashx/v2/info/endpoints.{json|xml}

LIST web service endpoints.

Scopes

Information › Read Endpoints info.endpoints.readonly

Request Parameters

Name	Type	Location	Description	Required	Default	Options
PageIndex	int?		Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.	Optional
PageSize	int?		Specify the number of results to return per page. If not set the default is 20. The max is 100.	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/info/endpoints.json'
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "Endpoints": [
    {
      "Action": "action",
      "Resource": "resource",
      "Url": "url",
      "Notes": "notes"
    },
    {
      "Action": "action",
      "Resource": "resource",
      "Url": "url",
      "Notes": "notes"
    }
  ],
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Endpoints PageSize="2" PageIndex="0" TotalCount="2">
    <Endpoint>
      <Action>action</Action>
      <Resource>resource</Resource>
      <Url>url</Url>
      <Notes>notes</Notes>
    </Endpoint>
    <Endpoint>
      <Action>action</Action>
      <Resource>resource</Resource>
      <Url>url</Url>
      <Notes>notes</Notes>
    </Endpoint>
  </Endpoints>
</Response>

Recommended