Sign in

Post API v1 college

Changed on
post/api/v1/college

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Request body

$schemastring uri

A URL to the JSON Schema for this object.

academic_rankinteger nullable required

Academic rank of the college

citystring required

City of the college

division_rank1 | 2 | 3 required

NCAA division (1, 2, or 3)

logostring nullable required

Logo of the college

namestring required

Name of the college

statestring required

State of the college

websitestring required

Website of the college

Example request

{
  "$schema": "https://example.com/schemas/CreateCollegeRequest.json",
  "academic_rank": 53,
  "city": "Boston",
  "division_rank": 1,
  "logo": "https://example.com/logo.png",
  "name": "Northeastern University",
  "state": "Massachusetts",
  "website": "https://www.northeastern.edu"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

academic_rankinteger nullable required

Academic rank of the college

citystring required

City of the college

division_rank1 | 2 | 3 required

NCAA division (1, 2, or 3)

idstring required

ID of the college

logostring nullable required

Logo of the college

namestring required

Name of the college

statestring required

State of the college

websitestring required

Website of the college

Example response

{
  "$schema": "https://example.com/schemas/CreateCollegeResponse.json",
  "academic_rank": 53,
  "city": "Boston",
  "division_rank": 1,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "logo": "https://example.com/logo.png",
  "name": "Northeastern University",
  "state": "Massachusetts",
  "website": "https://www.northeastern.edu"
}

Changes

  • 7c613c8946bfRevision changes
    • ▲

      request property was restricted to a list of enum values

    • ▲

      the response property's min was decreased from 1.00 to 0.00 for the response status

    • ▲

      the response's property format changed from int32 to int64 for status

    • ●

      added the new 1.00 enum value to the response property for the response status

    • ●

      added the new 2.00 enum value to the response property for the response status

    • ●

      added the new 3.00 enum value to the response property for the response status

    • ○

      added the new 1.00 enum value to the request property

    • ○

      added the new 2.00 enum value to the request property

    • ○

      added the new 3.00 enum value to the request property

    • ○

      the request property's min was decreased from 1.00 to 0.00

    • ○

      the request property format was generalized from int32 to int64