API:2/stories/seasons

From Guild Wars 2 Wiki
< API:2‎ | stories
Jump to: navigation, search

/v2/stories/seasons

HTTP method
GET
Format
json
API version
version 2
Release date
2016-04-29
Scope
none
Optional
none

This resource returns information about the Story Journal story seasons; including the personal story and Living World.

Endpoints

  • None - Request the list of all available season ids when the root endpoint (v2/stories/seasons) has been accessed.
  • id - (Optional) Request the season for the specificed id when accessing the endpoint (v2/stories/seasons/id). Cannot be used when specifying the id or ids parameters.

Parameters

  • lang – (Optional) Request localized information.
  • page - (Optional; integer)
  • page_size - (Optional; integer)
  • id - (Optional) Request the season for the specified id. Cannot be used when specifying the id endpoint or ids parameter.
  • ids - (Optional; Comma Delimited List|all) Request an array of seasons for the specified ids or all seasons. Cannot be used when using the id endpoint or id parameter.

Response

For each requested Story Journal story season id, an object with the following properties is returned:

  • id (string) - The id of the season.
  • name (string) - The name of the season.
  • order (integer) - The order in which this season is displayed in the Story Journal.
  • stories (array of integers) - An array of story ids for the stories that belong to this season.

Example

https://api.guildwars2.com/v2/stories/seasons

[
 "002C2D90-69B5-41A2-A422-8DB6F2EFC53E",
 "A515A1D3-4BD7-4594-AE30-2C5D05FF5960",
 "B8901E58-DC9D-4525-ADB2-79C93593291E",
 "09766A86-D88D-4DF2-9385-259E9A8CA583",
 "215AAA0F-CDAC-4F93-86DA-C155A99B5784"
]

https://api.guildwars2.com/v2/stories/seasons/002C2D90-69B5-41A2-A422-8DB6F2EFC53E

{
 "id":"002C2D90-69B5-41A2-A422-8DB6F2EFC53E",
 "name":"Scarlet's War",
 "order":1001,
 "stories":[39]
}

https://api.guildwars2.com/v2/stories/seasons?ids=09766A86-D88D-4DF2-9385-259E9A8CA583

[
 {
  "id":"09766A86-D88D-4DF2-9385-259E9A8CA583",
  "name":"Living World Season 3",
  "order":3000,
  "stories":[46]
 }
]

https://api.guildwars2.com/v2/stories/seasons?id=215AAA0F-CDAC-4F93-86DA-C155A99B5784

{
 "id":"215AAA0F-CDAC-4F93-86DA-C155A99B5784",
 "name":"My Story",
 "order":1,
 "stories":[
  2,
  8,
  1,
  10,
  7,
  9,
  3
 ]
}