Requests

Use this page to understand Signal API request URL patterns, authentication, HTTP methods, pagination, searching, sorting, and field views.

Request URLs

The Arcadia Signal API servers are located at:

https://api.genability.com

You can make requests to URLs that follow these patterns:

https://api.genability.com/rest/public/{some resource path}
https://api.genability.com/rest/v1/{some resource path}

For example:

https://api.genability.com/rest/public/lses
https://api.genability.com/rest/public/lses/2756
https://api.genability.com/rest/public/tariffs/512

Each resource type has a dedicated documentation page that specifies the applicable URL pattern. For example, see the Tariffs Overview page.

Authentication

Every request must contain information that identifies you as the client. See Authentication for details.

Data types

In addition to standard string and number inputs, Signal APIs use additional input types throughout requests.

Array inputs

Some fields accept multiple values as comma-separated or repeated query parameters. For example, the customerClasses and tariffTypes fields for the Tariff endpoint use this format.

tariffTypes=DEFAULT,ALTERNATIVE
tariffTypes=DEFAULT&tariffTypes=ALTERNATIVE

JSON payloads

Use JSON in your payload when making HTTP POST and PUT calls that require a request body.

HTTP methods

Most calls to the API use HTTP GET because they request one or more resources. Some operations require other HTTP methods:

HTTP Method	Description
`GET`	Reads resources by URL, often with query string criteria.
`POST`	Creates a new resource, or with the `method` parameter, performs a `PUT` or `DELETE`.
`PUT`	Updates an existing resource.
`DELETE`	Deletes an existing resource.

JavaScript libraries and some other technologies do not easily support PUT or DELETE, so the API supports POST overloads. Include a method parameter with a value of PUT or DELETE to work around that limitation.

Pagination

Most API calls support pagination with pageStart and pageCount.

Parameter	Type	Description
`pageStart`	Integer	Index of the first result. Defaults to `0` if omitted.
`pageCount`	Integer	Number of results to return. Defaults to `25` if omitted.

For example, fetch the first 100 results by setting pageStart=0 and pageCount=100. Fetch the next 100 by setting pageStart=100 and pageCount=100.

The count property in responses indicates how many records matched the query. The API currently limits count to a maximum of 100,000; interpret 100000 as “100,000 or more.”

Searching and sorting

Search and sort parameters let you filter text fields and order response results.

Parameter	Type	Description
`search`	String	Text string to search for.
`searchOn`	String	Comma-separated list of fields to search within.
`startsWith`	Boolean	When true, returns only results that begin with the search string.
`endsWith`	Boolean	When true, returns only results that end with the search string.
`isRegex`	Boolean	When true, treats the search string as a regular expression.
`sortOn`	String	Comma-separated list of fields to sort by.
`sortOrder`	String	Comma-separated list of sort orders. Possible values are `ASC` and `DESC`.