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
Name | Description | Type | Additional 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 AwardName | Description | Type | Additional 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-11-28T08:41:15.1758869+00:00", "class_id": "30ab1bbc-f916-480f-89a9-13c1647db012", "category_id": "ec423d59-a9ce-4c17-a783-65fc2ec31775", "round_id": "16d3cc40-9a2f-4668-9489-b9833cbc9389", "season_id": "f69a192e-5120-4936-a4fd-d96065cfd80a", "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-11-28T08:41:15.1758869+00:00", "class_id": "30ab1bbc-f916-480f-89a9-13c1647db012", "category_id": "ec423d59-a9ce-4c17-a783-65fc2ec31775", "round_id": "16d3cc40-9a2f-4668-9489-b9833cbc9389", "season_id": "f69a192e-5120-4936-a4fd-d96065cfd80a", "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-11-28T08:41:15.1758869+00: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>ec423d59-a9ce-4c17-a783-65fc2ec31775</category_id> <class_archived>true</class_archived> <class_id>30ab1bbc-f916-480f-89a9-13c1647db012</class_id> <name>sample string 1</name> <round>sample string 5</round> <round_archived>true</round_archived> <round_id>16d3cc40-9a2f-4668-9489-b9833cbc9389</round_id> <season_id>f69a192e-5120-4936-a4fd-d96065cfd80a</season_id> </Award> <Award> <achieved>2024-11-28T08:41:15.1758869+00: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>ec423d59-a9ce-4c17-a783-65fc2ec31775</category_id> <class_archived>true</class_archived> <class_id>30ab1bbc-f916-480f-89a9-13c1647db012</class_id> <name>sample string 1</name> <round>sample string 5</round> <round_archived>true</round_archived> <round_id>16d3cc40-9a2f-4668-9489-b9833cbc9389</round_id> <season_id>f69a192e-5120-4936-a4fd-d96065cfd80a</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-11-28T08:41:15.1758869+00: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>ec423d59-a9ce-4c17-a783-65fc2ec31775</category_id><class_archived>true</class_archived><class_id>30ab1bbc-f916-480f-89a9-13c1647db012</class_id><name>sample string 1</name><round>sample string 5</round><round_archived>true</round_archived><round_id>16d3cc40-9a2f-4668-9489-b9833cbc9389</round_id><season_id>f69a192e-5120-4936-a4fd-d96065cfd80a</season_id></Award><Award><achieved>2024-11-28T08:41:15.1758869+00: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>ec423d59-a9ce-4c17-a783-65fc2ec31775</category_id><class_archived>true</class_archived><class_id>30ab1bbc-f916-480f-89a9-13c1647db012</class_id><name>sample string 1</name><round>sample string 5</round><round_archived>true</round_archived><round_id>16d3cc40-9a2f-4668-9489-b9833cbc9389</round_id><season_id>f69a192e-5120-4936-a4fd-d96065cfd80a</season_id></Award></ArrayOfAward>