User:Drakken Keisterbane/CREST: Difference between revisions

Line 69:

'''Singularity''': {{code | http://public-crest.sisi.testeveonline.com}}

==Endpoints==

===Notes===

Many of the endpoints available on CREST will give an overview of an entire set of related resources. For example, the ''alliance'' endpoint, with no specification to a particular alliance, will give an overview of all alliances in EVE Online. For the purposes of this guide, we will call these types of endpoints '''collections'''.

Since there are usually a very large number of items in a collection, it is often split into pages, each with its own array of objects of an arbitrary length. There is no guarantee that the length of the arrays across pages are equal.

All pages will contain a '''pageCount''' name/value pair that indicates the total number of pages in the collection.

In addition, each page will always have a '''next''' JSON object, which will contain a name/value pair, named '''href''' whose value is a URI that can be used to reach the next page of data in the collection.

===Alliances and Corporations===

'''Function''': Information on all open alliances in EVE Online.

<br />'''URI''': http://public-crest.eveonline.com/alliances/

<br />'''Collection?''': Yes.

<br />'''Structure''':

* '''totalCount_str''': A JSON string, which indicates the number of objects in the collection.

* '''pageCount''': A JSON int, which indicates the total number of pages in this collection.

* '''items''': A JSON array, containing an arbitrary amount of objects. Each object in this array contains limited information on an alliance, shown below.

** '''href''': A JSON object, which contains the information on this alliance.

*** '''id_str''': The alliance id, in the form of a JSON string.

*** '''shortName''': The alliance ticker, in the form of a JSON string.

*** '''href''': A URI which can be used to access more detailed information on this alliance ''(see the /alliances/allianceid endpoint for more information)''

*** '''id''': The alliance id, in the form of a JSON number.

*** '''name''': The name of the alliance, in the form of a JSON string.

* '''next''': A JSON object, which contains information on accessing the next page of data.

** '''href''': A JSON name/value pair, whose value is a URI that can be used to access the next page of this collection.

* '''totalCount''': A JSON int, which indicates the number of objects in the collection.

* '''pageCount_str''': A JSON string, which indicates the total number of pages in this collection.

===Market===

===Industry===

===Other===

=External Resources=

@@ Line 69: / Line 69: @@
 '''Singularity''': {{code | http://public-crest.sisi.testeveonline.com}}
 ==Endpoints==
+===Notes===
+Many of the endpoints available on CREST will give an overview of an entire set of related resources. For example, the ''alliance'' endpoint, with no specification to a particular alliance, will give an overview of all alliances in EVE Online. For the purposes of this guide, we will call these types of endpoints '''collections'''.
+Since there are usually a very large number of items in a collection, it is often split into pages, each with its own array of objects of an arbitrary length. There is no guarantee that the length of the arrays across pages are equal.
+All pages will contain a '''pageCount''' name/value pair that indicates the total number of pages in the collection.
+In addition, each page will always have a '''next''' JSON object, which will contain a name/value pair, named '''href''' whose value is a URI that can be used to reach the next page of data in the collection.
+===Alliances and Corporations===
+'''Function''': Information on all open alliances in EVE Online.
+<br />'''URI''': http://public-crest.eveonline.com/alliances/
+<br />'''Collection?''': Yes.
+<br />'''Structure''':
+* '''totalCount_str''': A JSON string, which indicates the number of objects in the collection.
+* '''pageCount''': A JSON int, which indicates the total number of pages in this collection.
+* '''items''': A JSON array, containing an arbitrary amount of objects. Each object in this array contains limited information on an alliance, shown below.
+** '''href''': A JSON object, which contains the information on this alliance.
+*** '''id_str''': The alliance id, in the form of a JSON string.
+*** '''shortName''': The alliance ticker, in the form of a JSON string.
+*** '''href''': A URI which can be used to access more detailed information on this alliance ''(see the /alliances/allianceid endpoint for more information)''
+*** '''id''': The alliance id, in the form of a JSON number.
+*** '''name''': The name of the alliance, in the form of a JSON string.
+* '''next''': A JSON object, which contains information on accessing the next page of data.
+** '''href''': A JSON name/value pair, whose value is a URI that can be used to access the next page of this collection.
+* '''totalCount''': A JSON int, which indicates the number of objects in the collection.
+* '''pageCount_str''': A JSON string, which indicates the total number of pages in this collection.
 ===Market===
 ===Industry===
+===Other===
 =External Resources=