GiveSignup: API - Clear Results from Result Set by Registration ID

RunSignup API Documentation

API Overview Getting Started API Keys Documentation API Methods Error Codes Code Examples

Clear Results from Result Set by Registration ID

Remove all results from a result set for an event that match a registration ID in the provided list of registration IDs. Be careful with this method, as it cannot be undone.

For JSON, the request should look like the example below.

xxxxxxxxxx
 
{    "registration_ids": [123,124,125]}

For XML, the request should look like the example below.

xxxxxxxxxx
 
<?xml version="1.0" encoding="utf-8" ?><registration_ids>    <registration_id>123</registration_id>    <registration_id>124</registration_id>    <registration_id>125</registration_id></registration_ids>

For CSV, the request should look like the example below.

xxxxxxxxxx
 
registration_id123124125

URL

https://www.givesignup.org/rest/race/:race_id/results/clear-results-by-reg-id

HTTP Method

POST

Standard Parameters

Parameter	HTTP Method	Default	Description	Datatype
`api_key`	GET		API Key	`string`
`api_secret`	GET		API Secret	`string`
`tmp_key`	GET		Temporary API Key from login API call. This should NOT be used in combination with API Key.	`string`
`tmp_secret`	GET		Temporary API Secret from login API call. This should NOT be used in combination with API Secret.	`string`
`rsu_api_key`	GET		API v2 key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET.	`string`
`sp_api_key`	GET		Super partner API key. If used, you must send the API secret in an HTTP header named X-RSU-API-SECRET.	`string`
`X-RSU-API-SECRET`	HTTP Header		API v2 or super partner secret.	`string`
`format`	GET	xml	Format of response. The default if not sent is `xml`, but `json` is preferred.	`format`

Parameters

Parameter	HTTP Method	Default	Description	Datatype
`race_id` Required	POST		ID of race.	`uint`
`event_id` Required	POST		ID of event.	`uint`
`individual_result_set_id` Required	POST		ID of result set.	`uint`
`request_format`	POST	xml	Format of request. The default if not sent is `xml`, but `json` is preferred.	`format`
`request` Required	POST		Request in proper format.	`string`

Standard Parameters

api_key

api_secret

tmp_key

tmp_secret

rsu_api_key

sp_api_key

X-RSU-API-SECRET

format

Parameters

race_id *

event_id *

individual_result_set_id *

request_format

request *

Request Headers:

↑ Back to Request