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

Lists all handicaps filtered by the provided id in GUID format. For example class_id will list all handicaps 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 Handicap
NameDescriptionTypeAdditional information
achieved

date

None.

archer_archived

boolean

None.

archer_id

globally unique identifier

None.

bow_class

string

None.

class_archived

boolean

None.

class_id

globally unique identifier

None.

handicap

integer

None.

handicap_id

globally unique identifier

None.

name

string

None.

season_id

globally unique identifier

None.

type

string

None.

type_id

globally unique identifier

None.

updated

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "achieved": "2024-05-22T02:30:07.3300132+01:00",
    "archer_archived": true,
    "archer_id": "58cc39a4-77bc-4d11-99b2-da6ad76b5ead",
    "bow_class": "sample string 4",
    "class_archived": true,
    "class_id": "dc605cca-a33c-4f94-9660-978dc66e3046",
    "handicap": 7,
    "handicap_id": "61005f30-47c1-4a7b-8706-53d44199ecd9",
    "name": "sample string 9",
    "season_id": "dec76947-63bd-4f0e-ba9e-dd5449c10091",
    "type": "sample string 11",
    "type_id": "4682f652-e8dc-4f17-9c48-5a33fd2b1acb",
    "updated": "2024-05-22T02:30:07.3300132+01:00"
  },
  {
    "achieved": "2024-05-22T02:30:07.3300132+01:00",
    "archer_archived": true,
    "archer_id": "58cc39a4-77bc-4d11-99b2-da6ad76b5ead",
    "bow_class": "sample string 4",
    "class_archived": true,
    "class_id": "dc605cca-a33c-4f94-9660-978dc66e3046",
    "handicap": 7,
    "handicap_id": "61005f30-47c1-4a7b-8706-53d44199ecd9",
    "name": "sample string 9",
    "season_id": "dec76947-63bd-4f0e-ba9e-dd5449c10091",
    "type": "sample string 11",
    "type_id": "4682f652-e8dc-4f17-9c48-5a33fd2b1acb",
    "updated": "2024-05-22T02:30:07.3300132+01:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfHandicap xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Archery_Records_API">
  <Handicap>
    <achieved>2024-05-22T02:30:07.3300132+01:00</achieved>
    <archer_archived>true</archer_archived>
    <archer_id>58cc39a4-77bc-4d11-99b2-da6ad76b5ead</archer_id>
    <bow_class>sample string 4</bow_class>
    <class_archived>true</class_archived>
    <class_id>dc605cca-a33c-4f94-9660-978dc66e3046</class_id>
    <handicap>7</handicap>
    <handicap_id>61005f30-47c1-4a7b-8706-53d44199ecd9</handicap_id>
    <name>sample string 9</name>
    <season_id>dec76947-63bd-4f0e-ba9e-dd5449c10091</season_id>
    <type>sample string 11</type>
    <type_id>4682f652-e8dc-4f17-9c48-5a33fd2b1acb</type_id>
    <updated>2024-05-22T02:30:07.3300132+01:00</updated>
  </Handicap>
  <Handicap>
    <achieved>2024-05-22T02:30:07.3300132+01:00</achieved>
    <archer_archived>true</archer_archived>
    <archer_id>58cc39a4-77bc-4d11-99b2-da6ad76b5ead</archer_id>
    <bow_class>sample string 4</bow_class>
    <class_archived>true</class_archived>
    <class_id>dc605cca-a33c-4f94-9660-978dc66e3046</class_id>
    <handicap>7</handicap>
    <handicap_id>61005f30-47c1-4a7b-8706-53d44199ecd9</handicap_id>
    <name>sample string 9</name>
    <season_id>dec76947-63bd-4f0e-ba9e-dd5449c10091</season_id>
    <type>sample string 11</type>
    <type_id>4682f652-e8dc-4f17-9c48-5a33fd2b1acb</type_id>
    <updated>2024-05-22T02:30:07.3300132+01:00</updated>
  </Handicap>
</ArrayOfHandicap>