GET api/Awards/{id}?pageNumber={pageNumber}&pageSize={pageSize}

Lists awards filtered by the provided id in GUID format. For example class_id will list all awards with that class id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

A GUID (Globally Unique Identifier) in the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

globally unique identifier

Required

pageNumber

integer

None.

pageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Award
NameDescriptionTypeAdditional information
name

string

None.

award

string

None.

bow_class

string

None.

category

string

None.

round

string

None.

achieved

date

None.

class_id

globally unique identifier

None.

category_id

globally unique identifier

None.

round_id

globally unique identifier

None.

season_id

globally unique identifier

None.

class_archived

boolean

None.

round_archived

boolean

None.

category_archived

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "name": "sample string 1",
    "award": "sample string 2",
    "bow_class": "sample string 3",
    "category": "sample string 4",
    "round": "sample string 5",
    "achieved": "2024-10-21T08:46:15.7703242+01:00",
    "class_id": "1660c41d-eb43-4adf-a4cd-a40b370d908c",
    "category_id": "39fb32d0-4437-44d3-bc57-806a5c8a801b",
    "round_id": "911c9575-90cb-4bb1-8eb8-b7f91e08e316",
    "season_id": "2fba7341-59e6-45e5-aab4-cf025debea72",
    "class_archived": true,
    "round_archived": true,
    "category_archived": true
  },
  {
    "name": "sample string 1",
    "award": "sample string 2",
    "bow_class": "sample string 3",
    "category": "sample string 4",
    "round": "sample string 5",
    "achieved": "2024-10-21T08:46:15.7703242+01:00",
    "class_id": "1660c41d-eb43-4adf-a4cd-a40b370d908c",
    "category_id": "39fb32d0-4437-44d3-bc57-806a5c8a801b",
    "round_id": "911c9575-90cb-4bb1-8eb8-b7f91e08e316",
    "season_id": "2fba7341-59e6-45e5-aab4-cf025debea72",
    "class_archived": true,
    "round_archived": true,
    "category_archived": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfAward xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Golden_Records_App">
  <Award>
    <achieved>2024-10-21T08:46:15.7703242+01:00</achieved>
    <award>sample string 2</award>
    <bow_class>sample string 3</bow_class>
    <category>sample string 4</category>
    <category_archived>true</category_archived>
    <category_id>39fb32d0-4437-44d3-bc57-806a5c8a801b</category_id>
    <class_archived>true</class_archived>
    <class_id>1660c41d-eb43-4adf-a4cd-a40b370d908c</class_id>
    <name>sample string 1</name>
    <round>sample string 5</round>
    <round_archived>true</round_archived>
    <round_id>911c9575-90cb-4bb1-8eb8-b7f91e08e316</round_id>
    <season_id>2fba7341-59e6-45e5-aab4-cf025debea72</season_id>
  </Award>
  <Award>
    <achieved>2024-10-21T08:46:15.7703242+01:00</achieved>
    <award>sample string 2</award>
    <bow_class>sample string 3</bow_class>
    <category>sample string 4</category>
    <category_archived>true</category_archived>
    <category_id>39fb32d0-4437-44d3-bc57-806a5c8a801b</category_id>
    <class_archived>true</class_archived>
    <class_id>1660c41d-eb43-4adf-a4cd-a40b370d908c</class_id>
    <name>sample string 1</name>
    <round>sample string 5</round>
    <round_archived>true</round_archived>
    <round_id>911c9575-90cb-4bb1-8eb8-b7f91e08e316</round_id>
    <season_id>2fba7341-59e6-45e5-aab4-cf025debea72</season_id>
  </Award>
</ArrayOfAward>

multipart/form-data

Sample:
<ArrayOfAward xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Golden_Records_App"><Award><achieved>2024-10-21T08:46:15.7703242+01:00</achieved><award>sample string 2</award><bow_class>sample string 3</bow_class><category>sample string 4</category><category_archived>true</category_archived><category_id>39fb32d0-4437-44d3-bc57-806a5c8a801b</category_id><class_archived>true</class_archived><class_id>1660c41d-eb43-4adf-a4cd-a40b370d908c</class_id><name>sample string 1</name><round>sample string 5</round><round_archived>true</round_archived><round_id>911c9575-90cb-4bb1-8eb8-b7f91e08e316</round_id><season_id>2fba7341-59e6-45e5-aab4-cf025debea72</season_id></Award><Award><achieved>2024-10-21T08:46:15.7703242+01:00</achieved><award>sample string 2</award><bow_class>sample string 3</bow_class><category>sample string 4</category><category_archived>true</category_archived><category_id>39fb32d0-4437-44d3-bc57-806a5c8a801b</category_id><class_archived>true</class_archived><class_id>1660c41d-eb43-4adf-a4cd-a40b370d908c</class_id><name>sample string 1</name><round>sample string 5</round><round_archived>true</round_archived><round_id>911c9575-90cb-4bb1-8eb8-b7f91e08e316</round_id><season_id>2fba7341-59e6-45e5-aab4-cf025debea72</season_id></Award></ArrayOfAward>