GET api/Awards?filter_id={filter_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 |
---|---|---|---|
filter_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 |
---|---|---|---|
achieved | date |
None. |
|
archer_archived | boolean |
None. |
|
archer_id | globally unique identifier |
None. |
|
award | string |
None. |
|
award_id | globally unique identifier |
None. |
|
bow_class | string |
None. |
|
category | string |
None. |
|
category_archived | boolean |
None. |
|
category_id | globally unique identifier |
None. |
|
class_archived | boolean |
None. |
|
class_id | globally unique identifier |
None. |
|
name | string |
None. |
|
round | string |
None. |
|
round_archived | boolean |
None. |
|
round_id | globally unique identifier |
None. |
|
season_id | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "achieved": "2024-05-21T20:19:30.4452178+01:00", "archer_archived": true, "archer_id": "58382310-a1e3-498d-949f-e69969d4042f", "award": "sample string 4", "award_id": "8c439f6d-3a36-4099-a1da-9a93b1fcca4c", "bow_class": "sample string 6", "category": "sample string 7", "category_archived": true, "category_id": "af12d1f2-e6a1-4a3d-9123-01e122b57ba0", "class_archived": true, "class_id": "2ae6261b-8c1e-4d40-b907-74df56bcbb90", "name": "sample string 12", "round": "sample string 13", "round_archived": true, "round_id": "c81a6e0c-ec26-4af3-93d7-6ad10715ead3", "season_id": "bd6dd6b4-6596-4789-b911-b52ea7ad79c0" }, { "achieved": "2024-05-21T20:19:30.4452178+01:00", "archer_archived": true, "archer_id": "58382310-a1e3-498d-949f-e69969d4042f", "award": "sample string 4", "award_id": "8c439f6d-3a36-4099-a1da-9a93b1fcca4c", "bow_class": "sample string 6", "category": "sample string 7", "category_archived": true, "category_id": "af12d1f2-e6a1-4a3d-9123-01e122b57ba0", "class_archived": true, "class_id": "2ae6261b-8c1e-4d40-b907-74df56bcbb90", "name": "sample string 12", "round": "sample string 13", "round_archived": true, "round_id": "c81a6e0c-ec26-4af3-93d7-6ad10715ead3", "season_id": "bd6dd6b4-6596-4789-b911-b52ea7ad79c0" } ]
application/xml, text/xml
Sample:
<ArrayOfAward xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Archery_Records_API"> <Award> <achieved>2024-05-21T20:19:30.4452178+01:00</achieved> <archer_archived>true</archer_archived> <archer_id>58382310-a1e3-498d-949f-e69969d4042f</archer_id> <award>sample string 4</award> <award_id>8c439f6d-3a36-4099-a1da-9a93b1fcca4c</award_id> <bow_class>sample string 6</bow_class> <category>sample string 7</category> <category_archived>true</category_archived> <category_id>af12d1f2-e6a1-4a3d-9123-01e122b57ba0</category_id> <class_archived>true</class_archived> <class_id>2ae6261b-8c1e-4d40-b907-74df56bcbb90</class_id> <name>sample string 12</name> <round>sample string 13</round> <round_archived>true</round_archived> <round_id>c81a6e0c-ec26-4af3-93d7-6ad10715ead3</round_id> <season_id>bd6dd6b4-6596-4789-b911-b52ea7ad79c0</season_id> </Award> <Award> <achieved>2024-05-21T20:19:30.4452178+01:00</achieved> <archer_archived>true</archer_archived> <archer_id>58382310-a1e3-498d-949f-e69969d4042f</archer_id> <award>sample string 4</award> <award_id>8c439f6d-3a36-4099-a1da-9a93b1fcca4c</award_id> <bow_class>sample string 6</bow_class> <category>sample string 7</category> <category_archived>true</category_archived> <category_id>af12d1f2-e6a1-4a3d-9123-01e122b57ba0</category_id> <class_archived>true</class_archived> <class_id>2ae6261b-8c1e-4d40-b907-74df56bcbb90</class_id> <name>sample string 12</name> <round>sample string 13</round> <round_archived>true</round_archived> <round_id>c81a6e0c-ec26-4af3-93d7-6ad10715ead3</round_id> <season_id>bd6dd6b4-6596-4789-b911-b52ea7ad79c0</season_id> </Award> </ArrayOfAward>