API
⌘K
My Developer Account

SchoolOption

A school option represents a school name, school type, grades, etc. and can be selected for a person.

Example Request 

curl https://api.planningcenteronline.com/people/v2/school_options

View in API Explorer →

Example Object 

{
  "type": "SchoolOption",
  "id": "1",
  "attributes": {
    "beginning_grade": "string",
    "ending_grade": "string",
    "school_types": [],
    "sequence": 1,
    "value": "string"
  },
  "relationships": {}
}

Attributes

Name Type Description
beginning_grade string
ending_grade string
id primary_key
school_types array
sequence integer
value string

Order By

Parameter Value Type Description
order beginning_grade string

prefix with a hyphen (-beginning_grade) to reverse the order
order ending_grade string

prefix with a hyphen (-ending_grade) to reverse the order
order sequence string

prefix with a hyphen (-sequence) to reverse the order
order value string

prefix with a hyphen (-value) to reverse the order

Query By

Name Parameter Type Description Example
beginning_grade where[beginning_grade] string

Query on a specific beginning_grade

 ?where[beginning_grade]=string
ending_grade where[ending_grade] string

Query on a specific ending_grade

 ?where[ending_grade]=string
school_types where[school_types] array

Query on a specific school_types

 ?where[school_types]=[]
sequence where[sequence] integer

Query on a specific sequence

 ?where[sequence]=1
value where[value] string

Query on a specific value

 ?where[value]=string

Pagination

Name Parameter Type Description
per_page per_page integer

how many records to return per page (min=1, max=100, default=25)
offset offset integer

get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /people/v2/school_options

Reading

HTTP Method Endpoint
GET /people/v2/school_options/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/school_options
  • value
  • sequence
  • beginning_grade
  • ending_grade
  • school_types

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/school_options/{id}
  • value
  • sequence
  • beginning_grade
  • ending_grade
  • school_types

Deleting

HTTP Method Endpoint
DELETE /people/v2/school_options/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/school_options/{school_option_id}/promotes_to_school SchoolOption

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/school_options Organization
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/school Person
GET https://api.planningcenteronline.com/people/v2/school_options/{school_option_id}/promotes_to_school SchoolOption