Methods
(inner) getAllianceFromCollection(collectionId, allianceId)
Retrieves the PssAlliance (fleet) with the given allianceId from the Collection with the given collectionId, including its members.
Parameters:
| Name | Type | Description |
|---|---|---|
collectionId |
integer | The CollectionId of the Collection to retrieve the PssAlliance (fleet) from. |
allianceId |
integer | The AllianceId of the PssAlliance (fleet) to retrieve. |
Returns:
CollectionAllianceResponse - The parsed and converted response from the PSS Fleet Data API.
(inner) getAllianceHistory(allianceId, fromDateopt, toDateopt, intervalopt, descopt, skipopt, takeopt)
Retrieves the history of an PssAlliance (fleet) from the given parameters.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
allianceId |
integer | The AllianceId of the PssAlliance to retrieve the history for. |
|
fromDate |
Date |
<optional> |
The earliest date for which data shall be returned. Must be Jan 6th, 2016 or later. Must be earlier than parameter toDate, if that's specified. |
toDate |
Date |
<optional> |
The latest date for which data shall be returned. Must be Jan 6th, 2016 or later. Must be later than parameter fromDate, if that's specified. |
interval |
Interval | string |
<optional> |
Return the data from the specified time frame in hourly (value: hour), daily (value: day, last Collection of a day) or monthly (value: month, last Collection of a month, default) interval. |
desc |
boolean |
<optional> |
Return the results in descending order by timestamp. |
skip |
integer |
<optional> |
Skip this number of results from the result set. |
take |
integer |
<optional> |
Limit the number of results returned. |
Returns:
AllianceHistoryResponse - The parsed and converted response from the PSS Fleet Data API.
(inner) getAlliancesFromCollection(collectionId)
Retrieves the PssAlliances (fleets) from the Collection with the given collectionId.
Parameters:
| Name | Type | Description |
|---|---|---|
collectionId |
integer | The CollectionId of the Collection to retrieve the PssAlliances (fleets) from. |
Returns:
CollectionAlliancesResponse - The parsed and converted response from the PSS Fleet Data API.
(inner) getCollection(collectionId)
Retrieves the Collection with the given collectionId.
Parameters:
| Name | Type | Description |
|---|---|---|
collectionId |
integer | The CollectionId of the Collection to retrieve. |
Returns:
CollectionResponse - The parsed and converted response from the PSS Fleet Data API.
(inner) getCollections(fromDateopt, toDateopt, intervalopt, descopt, skipopt, takeopt)
Retrieves the metadatas of Collections meeting the given parameters.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
fromDate |
Date |
<optional> |
The earliest date for which data shall be returned. Must be Jan 6th, 2016 or later. Must be earlier than parameter toDate, if that's specified. |
toDate |
Date |
<optional> |
The latest date for which data shall be returned. Must be Jan 6th, 2016 or later. Must be later than parameter fromDate, if that's specified. |
interval |
Interval | string |
<optional> |
Return the data from the specified time frame in hourly (value: hour), daily (value: day, last Collection of a day) or monthly (value: month, last Collection of a month, default) interval. |
desc |
boolean |
<optional> |
Return the results in descending order by timestamp. |
skip |
integer |
<optional> |
Skip this number of results from the result set. |
take |
integer |
<optional> |
Limit the number of results returned. |
Returns:
CollectionMetadatasResponse - The parsed and converted response from the PSS Fleet Data API.
(inner) getTop100UsersFromCollection(collectionId)
Retrieves the PssUsers (players) from the Collection with the given collectionId.
Parameters:
| Name | Type | Description |
|---|---|---|
collectionId |
integer | The CollectionId of the Collection to retrieve the PssUsers (players) from. |
Returns:
CollectionUsersResponse - The parsed and converted response from the PSS Fleet Data API.
(inner) getUserFromCollection(collectionId, userId)
Retrieves the PssUser (player) with the given userId from the Collection with the given collectionId, including its PssAlliance (fleet), if applicable.
Parameters:
| Name | Type | Description |
|---|---|---|
collectionId |
integer | The CollectionId of the Collection to retrieve the PssUser (player) from. |
userId |
integer | The Id of the PssUser (player) to retrieve. |
Returns:
CollectionUserResponse - The parsed and converted response from the PSS Fleet Data API.
(inner) getUserHistory(userId, fromDateopt, toDateopt, intervalopt, descopt, skipopt, takeopt)
Retrieves the history of a PssUser (player) from the given parameters.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
userId |
integer | The Id of the PssUser to retrieve the history for. |
|
fromDate |
Date |
<optional> |
The earliest date for which data shall be returned. Must be Jan 6th, 2016 or later. Must be earlier than parameter toDate, if that's specified. |
toDate |
Date |
<optional> |
The latest date for which data shall be returned. Must be Jan 6th, 2016 or later. Must be later than parameter fromDate, if that's specified. |
interval |
Interval | string |
<optional> |
Return the data from the specified time frame in hourly (value: hour), daily (value: day, last Collection of a day) or monthly (value: month, last Collection of a month, default) interval. |
desc |
boolean |
<optional> |
Return the results in descending order by timestamp. |
skip |
integer |
<optional> |
Skip this number of results from the result set. |
take |
integer |
<optional> |
Limit the number of results returned. |
Returns:
UserHistoryResponse - The parsed and converted response from the PSS Fleet Data API.
(inner) getUsersFromCollection(collectionId)
Retrieves the PssUsers (players) from the Collection with the given collectionId.
Parameters:
| Name | Type | Description |
|---|---|---|
collectionId |
integer | The CollectionId of the Collection to retrieve the PssUsers (players) from. |
Returns:
CollectionUsersResponse - The parsed and converted response from the PSS Fleet Data API.