Standing Adjustments

Manage the adjustments to existing standings data

Get a list of standing adjustments

get
/football/o/{organizationId}/seasons/{seasonId}/standings/adjustments

Return a list of standing adjustments

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
conferenceIdstring · uuidOptional

The unique identifier of the conference

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
divisionIdstring · uuidOptional

The unique identifier of the division

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
groupingKeystring · max: 100Optional

Grouping Key to allow bulk deletions or listing by the key

Example: KEYA123
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
poolCodestring · max: 30Optional

The pool identifier within a season

Example: P1
roundCodestring · max: 30Optional

The round identifier within a season

Example: RN1
roundNumberstring · max: 30Optional

Round number

Example: 1
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
Responses
200

Successful operation

application/json
get
/football/o/{organizationId}/seasons/{seasonId}/standings/adjustments

Create a new standing adjustment

post
/football/o/{organizationId}/seasons/{seasonId}/standings/adjustments

Insert a new standing adjustment

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
standingAdjustmentIdstring · uuidOptional

The unique identifier of the adjustment

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
entityIdstring · uuidRequired

The unique identifier of the team

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
roundCodestring | nullableOptional

A unique code for the round. (Unique for season)

Example: RN1
roundNumberstring | nullableOptional

The number given to the round

Example: 1
stageCodestring | nullableOptional

A unique code for the stage. (Unique for season)

Example: ST1
poolCodestring | nullableOptional

A unique code for the pool. (Unique for season)

Example: P1
divisionIdstring · uuid | nullableOptional

The unique identifier of the division

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
conferenceIdstring · uuid | nullableOptional

The unique identifier of the conference

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
applyToAllStandingsbooleanOptional

Apply to all generated standing types ?

Example: true
adjustmentGroupstring · enumRequired

Adjustment Group

  • IN_CONFERENCE In Conference
  • IN_DIVISION In Division
  • OUT_CONFERENCE Out Conference
  • OUT_DIVISION Out Division
  • OVERALL Overall
Possible values:
adjustmentTypestring · enumRequired

Adjustment Type

  • ADD_MINUS Add/Subtract Value
  • SET Set Value
Possible values:
adjustmentFieldstring · enumRequired

Adjustment field to calculate standings

  • byes Byes
  • draws Games Drawn
  • drawsAway Games Drawn (Away)
  • drawsHome Games Drawn (Home)
  • forfeitsGiven Forfeits Given
  • forfeitsWonBy Forfeits Won
  • highestScoreAgainst Highest Score Against
  • highestScoreAgainstAway Highest Score Against (Away)
  • highestScoreAgainstHome Highest Score Against (Home)
  • highestScoreFor Highest Score For
  • highestScoreForAway Highest Score For (Away)
  • highestScoreForHome Highest Score For (Home)
  • losses Games Lost
  • lossesAway Games Lost (Away)
  • lossesHome Games Lost (Home)
  • lowestScoreAgainst Lowest Score Against
  • lowestScoreAgainstAway Lowest Score Against (Away)
  • lowestScoreAgainstHome Lowest Score Against (Home)
  • lowestScoreFor Lowest Score For
  • lowestScoreForAway Lowest Score For (Away)
  • lowestScoreForHome Lowest Score For (Home)
  • percentage For versus Against Percentage
  • percentageAway For versus Against Percentage (Away)
  • percentageHome For versus Against Percentage (Home)
  • played Games Played
  • playedAway Games Played (Away)
  • playedHome Games Played (Home)
  • pointDifference Point Difference
  • pointDifferenceAway Point Difference (Away)
  • pointDifferenceHome Point Difference (Home)
  • position Standings Position
  • scoredAgainst Score Against
  • scoredAgainstAway Score Against (Away)
  • scoredAgainstHome Score Against (Home)
  • scoredFor Score For
  • scoredForAway Score For (Away)
  • scoredForHome Score For (Home)
  • standingPoints Standing Points for competitor
  • standingPointsAway Standing Points for competitor (Away)
  • standingPointsGiven Standing Points Given away
  • standingPointsHome Standing Points for competitor (Home)
  • streak Winning Streak for competitor
  • streakAway Winning Streak for competitor (Away)
  • streakHome Winning Streak for competitor (Home)
  • washouts Washouts
  • winPercentage Win Percentage
  • winPercentageAway Win Percentage (Away)
  • winPercentageHome Win Percentage (Home)
  • wins Games Won
  • winsAway Games Won (Away)
  • winsHome Games Won (Home)
Possible values:
adjustmentValuenumber · floatRequired

Value of the adjustment field

Example: 2.3
reasonTypestringRequired

Reason type of the adjustment

Example: DISCIPLINE
reasonDescriptionstring | nullableOptional

Reason for the adjustment

Example: Points lost due to discipline issues
groupingKeystring | nullableOptional

Grouping Key to allow bulk deletions or listing by the key

Example: KEYA123Pattern: ^[0-9A-Za-z/_-]+$
Responses
200

Successful operation

application/json
post
/football/o/{organizationId}/seasons/{seasonId}/standings/adjustments

Delete all standing adjustments for season

delete
/football/o/{organizationId}/seasons/{seasonId}/standings/adjustments

Delete all standing adjustments for season

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
200

Successful operation

application/json
delete
/football/o/{organizationId}/seasons/{seasonId}/standings/adjustments

Get standing adjustment

get
/football/o/{organizationId}/standings/adjustments/{standingAdjustmentId}

Return detailed information about a specific standing adjustment

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
standingAdjustmentIdstring · uuidRequired

The unique identifier of the standing_adjustment

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
Responses
200

Successful operation

application/json
get
/football/o/{organizationId}/standings/adjustments/{standingAdjustmentId}

Update standing adjustment

put
/football/o/{organizationId}/standings/adjustments/{standingAdjustmentId}

Change the information of a specific standing adjustment

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
standingAdjustmentIdstring · uuidRequired

The unique identifier of the standing_adjustment

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
entityIdstring · uuidOptional

The unique identifier of the team

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
roundCodestring | nullableOptional

A unique code for the round. (Unique for season)

Example: RN1
roundNumberstring | nullableOptional

The number given to the round

Example: 1
stageCodestring | nullableOptional

A unique code for the stage. (Unique for season)

Example: ST1
poolCodestring | nullableOptional

A unique code for the pool. (Unique for season)

Example: P1
divisionIdstring · uuid | nullableOptional

The unique identifier of the division

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
conferenceIdstring · uuid | nullableOptional

The unique identifier of the conference

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
applyToAllStandingsbooleanOptional

Apply to all generated standing types ?

Example: true
adjustmentGroupstring · enumOptional

Adjustment Group

  • IN_CONFERENCE In Conference
  • IN_DIVISION In Division
  • OUT_CONFERENCE Out Conference
  • OUT_DIVISION Out Division
  • OVERALL Overall
Possible values:
adjustmentTypestring · enumOptional

Adjustment Type

  • ADD_MINUS Add/Subtract Value
  • SET Set Value
Possible values:
adjustmentFieldstring · enumOptional

Adjustment field to calculate standings

  • byes Byes
  • draws Games Drawn
  • drawsAway Games Drawn (Away)
  • drawsHome Games Drawn (Home)
  • forfeitsGiven Forfeits Given
  • forfeitsWonBy Forfeits Won
  • highestScoreAgainst Highest Score Against
  • highestScoreAgainstAway Highest Score Against (Away)
  • highestScoreAgainstHome Highest Score Against (Home)
  • highestScoreFor Highest Score For
  • highestScoreForAway Highest Score For (Away)
  • highestScoreForHome Highest Score For (Home)
  • losses Games Lost
  • lossesAway Games Lost (Away)
  • lossesHome Games Lost (Home)
  • lowestScoreAgainst Lowest Score Against
  • lowestScoreAgainstAway Lowest Score Against (Away)
  • lowestScoreAgainstHome Lowest Score Against (Home)
  • lowestScoreFor Lowest Score For
  • lowestScoreForAway Lowest Score For (Away)
  • lowestScoreForHome Lowest Score For (Home)
  • percentage For versus Against Percentage
  • percentageAway For versus Against Percentage (Away)
  • percentageHome For versus Against Percentage (Home)
  • played Games Played
  • playedAway Games Played (Away)
  • playedHome Games Played (Home)
  • pointDifference Point Difference
  • pointDifferenceAway Point Difference (Away)
  • pointDifferenceHome Point Difference (Home)
  • position Standings Position
  • scoredAgainst Score Against
  • scoredAgainstAway Score Against (Away)
  • scoredAgainstHome Score Against (Home)
  • scoredFor Score For
  • scoredForAway Score For (Away)
  • scoredForHome Score For (Home)
  • standingPoints Standing Points for competitor
  • standingPointsAway Standing Points for competitor (Away)
  • standingPointsGiven Standing Points Given away
  • standingPointsHome Standing Points for competitor (Home)
  • streak Winning Streak for competitor
  • streakAway Winning Streak for competitor (Away)
  • streakHome Winning Streak for competitor (Home)
  • washouts Washouts
  • winPercentage Win Percentage
  • winPercentageAway Win Percentage (Away)
  • winPercentageHome Win Percentage (Home)
  • wins Games Won
  • winsAway Games Won (Away)
  • winsHome Games Won (Home)
Possible values:
adjustmentValuenumber · floatOptional

Value of the adjustment field

Example: 2.3
reasonTypestringOptional

Reason type of the adjustment

Example: DISCIPLINE
reasonDescriptionstring | nullableOptional

Reason for the adjustment

Example: Points lost due to discipline issues
groupingKeystring | nullableOptional

Grouping Key to allow bulk deletions or listing by the key

Example: KEYA123Pattern: ^[0-9A-Za-z/_-]+$
Responses
200

Successful operation

application/json
put
/football/o/{organizationId}/standings/adjustments/{standingAdjustmentId}

Delete standing adjustment

delete
/football/o/{organizationId}/standings/adjustments/{standingAdjustmentId}

Delete a specific standing adjustment

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
standingAdjustmentIdstring · uuidRequired

The unique identifier of the standing_adjustment

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
200

Successful operation

application/json
delete
/football/o/{organizationId}/standings/adjustments/{standingAdjustmentId}

Delete standing adjustments based on groupingKey

delete
/football/o/{organizationId}/seasons/{seasonId}/standings/adjustments/groupingKey/{groupingKey}

Delete all standing adjustments for a groupingKey

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
groupingKeystring · max: 100Required

Grouping Key to allow bulk deletions or listing by the key

Example: KEYA123
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
200

Successful operation

application/json
delete
/football/o/{organizationId}/seasons/{seasonId}/standings/adjustments/groupingKey/{groupingKey}

Last updated

Was this helpful?