schools

package
v4.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for schools API

func (*Client) GetCoursesForSchool

func (a *Client) GetCoursesForSchool(params *GetCoursesForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetCoursesForSchoolOK, error)

GetCoursesForSchool Returns the courses for a school

func (*Client) GetDistrictForSchool

func (a *Client) GetDistrictForSchool(params *GetDistrictForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetDistrictForSchoolOK, error)

GetDistrictForSchool Returns the district for a school

func (*Client) GetSchool

func (a *Client) GetSchool(params *GetSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetSchoolOK, error)

GetSchool Returns a specific school

func (*Client) GetSchools

func (a *Client) GetSchools(params *GetSchoolsParams, authInfo runtime.ClientAuthInfoWriter) (*GetSchoolsOK, error)

GetSchools Returns a list of schools

func (*Client) GetSectionsForSchool

func (a *Client) GetSectionsForSchool(params *GetSectionsForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetSectionsForSchoolOK, error)

GetSectionsForSchool Returns the sections for a school

func (*Client) GetTermsForSchool

func (a *Client) GetTermsForSchool(params *GetTermsForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetTermsForSchoolOK, error)

GetTermsForSchool Returns the terms for a school

func (*Client) GetUsersForSchool

func (a *Client) GetUsersForSchool(params *GetUsersForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetUsersForSchoolOK, error)

GetUsersForSchool Returns the staff, student, and/or teacher users for a school

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientService

type ClientService interface {
	GetCoursesForSchool(params *GetCoursesForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetCoursesForSchoolOK, error)

	GetDistrictForSchool(params *GetDistrictForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetDistrictForSchoolOK, error)

	GetSchool(params *GetSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetSchoolOK, error)

	GetSchools(params *GetSchoolsParams, authInfo runtime.ClientAuthInfoWriter) (*GetSchoolsOK, error)

	GetSectionsForSchool(params *GetSectionsForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetSectionsForSchoolOK, error)

	GetTermsForSchool(params *GetTermsForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetTermsForSchoolOK, error)

	GetUsersForSchool(params *GetUsersForSchoolParams, authInfo runtime.ClientAuthInfoWriter) (*GetUsersForSchoolOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new schools API client.

type GetCoursesForSchoolNotFound

type GetCoursesForSchoolNotFound struct {
	Payload *models.NotFound
}
GetCoursesForSchoolNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetCoursesForSchoolNotFound

func NewGetCoursesForSchoolNotFound() *GetCoursesForSchoolNotFound

NewGetCoursesForSchoolNotFound creates a GetCoursesForSchoolNotFound with default headers values

func (*GetCoursesForSchoolNotFound) Error

func (*GetCoursesForSchoolNotFound) GetPayload

func (o *GetCoursesForSchoolNotFound) GetPayload() *models.NotFound

type GetCoursesForSchoolOK

type GetCoursesForSchoolOK struct {
	Payload *models.CoursesResponse
}
GetCoursesForSchoolOK describes a response with status code 200, with default header values.

OK Response

func NewGetCoursesForSchoolOK

func NewGetCoursesForSchoolOK() *GetCoursesForSchoolOK

NewGetCoursesForSchoolOK creates a GetCoursesForSchoolOK with default headers values

func (*GetCoursesForSchoolOK) Error

func (o *GetCoursesForSchoolOK) Error() string

func (*GetCoursesForSchoolOK) GetPayload

func (o *GetCoursesForSchoolOK) GetPayload() *models.CoursesResponse

type GetCoursesForSchoolParams

type GetCoursesForSchoolParams struct {

	// EndingBefore.
	EndingBefore *string

	// ID.
	ID string

	// Limit.
	Limit *int64

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetCoursesForSchoolParams contains all the parameters to send to the API endpoint

for the get courses for school operation.

Typically these are written to a http.Request.

func NewGetCoursesForSchoolParams

func NewGetCoursesForSchoolParams() *GetCoursesForSchoolParams

NewGetCoursesForSchoolParams creates a new GetCoursesForSchoolParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetCoursesForSchoolParamsWithContext

func NewGetCoursesForSchoolParamsWithContext(ctx context.Context) *GetCoursesForSchoolParams

NewGetCoursesForSchoolParamsWithContext creates a new GetCoursesForSchoolParams object with the ability to set a context for a request.

func NewGetCoursesForSchoolParamsWithHTTPClient

func NewGetCoursesForSchoolParamsWithHTTPClient(client *http.Client) *GetCoursesForSchoolParams

NewGetCoursesForSchoolParamsWithHTTPClient creates a new GetCoursesForSchoolParams object with the ability to set a custom HTTPClient for a request.

func NewGetCoursesForSchoolParamsWithTimeout

func NewGetCoursesForSchoolParamsWithTimeout(timeout time.Duration) *GetCoursesForSchoolParams

NewGetCoursesForSchoolParamsWithTimeout creates a new GetCoursesForSchoolParams object with the ability to set a timeout on a request.

func (*GetCoursesForSchoolParams) SetContext

func (o *GetCoursesForSchoolParams) SetContext(ctx context.Context)

SetContext adds the context to the get courses for school params

func (*GetCoursesForSchoolParams) SetDefaults

func (o *GetCoursesForSchoolParams) SetDefaults()

SetDefaults hydrates default values in the get courses for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetCoursesForSchoolParams) SetEndingBefore

func (o *GetCoursesForSchoolParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get courses for school params

func (*GetCoursesForSchoolParams) SetHTTPClient

func (o *GetCoursesForSchoolParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get courses for school params

func (*GetCoursesForSchoolParams) SetID

func (o *GetCoursesForSchoolParams) SetID(id string)

SetID adds the id to the get courses for school params

func (*GetCoursesForSchoolParams) SetLimit

func (o *GetCoursesForSchoolParams) SetLimit(limit *int64)

SetLimit adds the limit to the get courses for school params

func (*GetCoursesForSchoolParams) SetStartingAfter

func (o *GetCoursesForSchoolParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get courses for school params

func (*GetCoursesForSchoolParams) SetTimeout

func (o *GetCoursesForSchoolParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get courses for school params

func (*GetCoursesForSchoolParams) WithContext

WithContext adds the context to the get courses for school params

func (*GetCoursesForSchoolParams) WithDefaults

WithDefaults hydrates default values in the get courses for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetCoursesForSchoolParams) WithEndingBefore

func (o *GetCoursesForSchoolParams) WithEndingBefore(endingBefore *string) *GetCoursesForSchoolParams

WithEndingBefore adds the endingBefore to the get courses for school params

func (*GetCoursesForSchoolParams) WithHTTPClient

func (o *GetCoursesForSchoolParams) WithHTTPClient(client *http.Client) *GetCoursesForSchoolParams

WithHTTPClient adds the HTTPClient to the get courses for school params

func (*GetCoursesForSchoolParams) WithID

WithID adds the id to the get courses for school params

func (*GetCoursesForSchoolParams) WithLimit

WithLimit adds the limit to the get courses for school params

func (*GetCoursesForSchoolParams) WithStartingAfter

func (o *GetCoursesForSchoolParams) WithStartingAfter(startingAfter *string) *GetCoursesForSchoolParams

WithStartingAfter adds the startingAfter to the get courses for school params

func (*GetCoursesForSchoolParams) WithTimeout

WithTimeout adds the timeout to the get courses for school params

func (*GetCoursesForSchoolParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetCoursesForSchoolReader

type GetCoursesForSchoolReader struct {
	// contains filtered or unexported fields
}

GetCoursesForSchoolReader is a Reader for the GetCoursesForSchool structure.

func (*GetCoursesForSchoolReader) ReadResponse

func (o *GetCoursesForSchoolReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetDistrictForSchoolNotFound

type GetDistrictForSchoolNotFound struct {
	Payload *models.NotFound
}
GetDistrictForSchoolNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetDistrictForSchoolNotFound

func NewGetDistrictForSchoolNotFound() *GetDistrictForSchoolNotFound

NewGetDistrictForSchoolNotFound creates a GetDistrictForSchoolNotFound with default headers values

func (*GetDistrictForSchoolNotFound) Error

func (*GetDistrictForSchoolNotFound) GetPayload

func (o *GetDistrictForSchoolNotFound) GetPayload() *models.NotFound

type GetDistrictForSchoolOK

type GetDistrictForSchoolOK struct {
	Payload *models.DistrictResponse
}
GetDistrictForSchoolOK describes a response with status code 200, with default header values.

OK Response

func NewGetDistrictForSchoolOK

func NewGetDistrictForSchoolOK() *GetDistrictForSchoolOK

NewGetDistrictForSchoolOK creates a GetDistrictForSchoolOK with default headers values

func (*GetDistrictForSchoolOK) Error

func (o *GetDistrictForSchoolOK) Error() string

func (*GetDistrictForSchoolOK) GetPayload

type GetDistrictForSchoolParams

type GetDistrictForSchoolParams struct {

	// ID.
	ID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetDistrictForSchoolParams contains all the parameters to send to the API endpoint

for the get district for school operation.

Typically these are written to a http.Request.

func NewGetDistrictForSchoolParams

func NewGetDistrictForSchoolParams() *GetDistrictForSchoolParams

NewGetDistrictForSchoolParams creates a new GetDistrictForSchoolParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetDistrictForSchoolParamsWithContext

func NewGetDistrictForSchoolParamsWithContext(ctx context.Context) *GetDistrictForSchoolParams

NewGetDistrictForSchoolParamsWithContext creates a new GetDistrictForSchoolParams object with the ability to set a context for a request.

func NewGetDistrictForSchoolParamsWithHTTPClient

func NewGetDistrictForSchoolParamsWithHTTPClient(client *http.Client) *GetDistrictForSchoolParams

NewGetDistrictForSchoolParamsWithHTTPClient creates a new GetDistrictForSchoolParams object with the ability to set a custom HTTPClient for a request.

func NewGetDistrictForSchoolParamsWithTimeout

func NewGetDistrictForSchoolParamsWithTimeout(timeout time.Duration) *GetDistrictForSchoolParams

NewGetDistrictForSchoolParamsWithTimeout creates a new GetDistrictForSchoolParams object with the ability to set a timeout on a request.

func (*GetDistrictForSchoolParams) SetContext

func (o *GetDistrictForSchoolParams) SetContext(ctx context.Context)

SetContext adds the context to the get district for school params

func (*GetDistrictForSchoolParams) SetDefaults

func (o *GetDistrictForSchoolParams) SetDefaults()

SetDefaults hydrates default values in the get district for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetDistrictForSchoolParams) SetHTTPClient

func (o *GetDistrictForSchoolParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get district for school params

func (*GetDistrictForSchoolParams) SetID

func (o *GetDistrictForSchoolParams) SetID(id string)

SetID adds the id to the get district for school params

func (*GetDistrictForSchoolParams) SetTimeout

func (o *GetDistrictForSchoolParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get district for school params

func (*GetDistrictForSchoolParams) WithContext

WithContext adds the context to the get district for school params

func (*GetDistrictForSchoolParams) WithDefaults

WithDefaults hydrates default values in the get district for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetDistrictForSchoolParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get district for school params

func (*GetDistrictForSchoolParams) WithID

WithID adds the id to the get district for school params

func (*GetDistrictForSchoolParams) WithTimeout

WithTimeout adds the timeout to the get district for school params

func (*GetDistrictForSchoolParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetDistrictForSchoolReader

type GetDistrictForSchoolReader struct {
	// contains filtered or unexported fields
}

GetDistrictForSchoolReader is a Reader for the GetDistrictForSchool structure.

func (*GetDistrictForSchoolReader) ReadResponse

func (o *GetDistrictForSchoolReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetSchoolNotFound

type GetSchoolNotFound struct {
	Payload *models.NotFound
}
GetSchoolNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetSchoolNotFound

func NewGetSchoolNotFound() *GetSchoolNotFound

NewGetSchoolNotFound creates a GetSchoolNotFound with default headers values

func (*GetSchoolNotFound) Error

func (o *GetSchoolNotFound) Error() string

func (*GetSchoolNotFound) GetPayload

func (o *GetSchoolNotFound) GetPayload() *models.NotFound

type GetSchoolOK

type GetSchoolOK struct {
	Payload *models.SchoolResponse
}
GetSchoolOK describes a response with status code 200, with default header values.

OK Response

func NewGetSchoolOK

func NewGetSchoolOK() *GetSchoolOK

NewGetSchoolOK creates a GetSchoolOK with default headers values

func (*GetSchoolOK) Error

func (o *GetSchoolOK) Error() string

func (*GetSchoolOK) GetPayload

func (o *GetSchoolOK) GetPayload() *models.SchoolResponse

type GetSchoolParams

type GetSchoolParams struct {

	// ID.
	ID string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetSchoolParams contains all the parameters to send to the API endpoint

for the get school operation.

Typically these are written to a http.Request.

func NewGetSchoolParams

func NewGetSchoolParams() *GetSchoolParams

NewGetSchoolParams creates a new GetSchoolParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetSchoolParamsWithContext

func NewGetSchoolParamsWithContext(ctx context.Context) *GetSchoolParams

NewGetSchoolParamsWithContext creates a new GetSchoolParams object with the ability to set a context for a request.

func NewGetSchoolParamsWithHTTPClient

func NewGetSchoolParamsWithHTTPClient(client *http.Client) *GetSchoolParams

NewGetSchoolParamsWithHTTPClient creates a new GetSchoolParams object with the ability to set a custom HTTPClient for a request.

func NewGetSchoolParamsWithTimeout

func NewGetSchoolParamsWithTimeout(timeout time.Duration) *GetSchoolParams

NewGetSchoolParamsWithTimeout creates a new GetSchoolParams object with the ability to set a timeout on a request.

func (*GetSchoolParams) SetContext

func (o *GetSchoolParams) SetContext(ctx context.Context)

SetContext adds the context to the get school params

func (*GetSchoolParams) SetDefaults

func (o *GetSchoolParams) SetDefaults()

SetDefaults hydrates default values in the get school params (not the query body).

All values with no default are reset to their zero value.

func (*GetSchoolParams) SetHTTPClient

func (o *GetSchoolParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get school params

func (*GetSchoolParams) SetID

func (o *GetSchoolParams) SetID(id string)

SetID adds the id to the get school params

func (*GetSchoolParams) SetTimeout

func (o *GetSchoolParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get school params

func (*GetSchoolParams) WithContext

func (o *GetSchoolParams) WithContext(ctx context.Context) *GetSchoolParams

WithContext adds the context to the get school params

func (*GetSchoolParams) WithDefaults

func (o *GetSchoolParams) WithDefaults() *GetSchoolParams

WithDefaults hydrates default values in the get school params (not the query body).

All values with no default are reset to their zero value.

func (*GetSchoolParams) WithHTTPClient

func (o *GetSchoolParams) WithHTTPClient(client *http.Client) *GetSchoolParams

WithHTTPClient adds the HTTPClient to the get school params

func (*GetSchoolParams) WithID

func (o *GetSchoolParams) WithID(id string) *GetSchoolParams

WithID adds the id to the get school params

func (*GetSchoolParams) WithTimeout

func (o *GetSchoolParams) WithTimeout(timeout time.Duration) *GetSchoolParams

WithTimeout adds the timeout to the get school params

func (*GetSchoolParams) WriteToRequest

func (o *GetSchoolParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetSchoolReader

type GetSchoolReader struct {
	// contains filtered or unexported fields
}

GetSchoolReader is a Reader for the GetSchool structure.

func (*GetSchoolReader) ReadResponse

func (o *GetSchoolReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetSchoolsOK

type GetSchoolsOK struct {
	Payload *models.SchoolsResponse
}
GetSchoolsOK describes a response with status code 200, with default header values.

OK Response

func NewGetSchoolsOK

func NewGetSchoolsOK() *GetSchoolsOK

NewGetSchoolsOK creates a GetSchoolsOK with default headers values

func (*GetSchoolsOK) Error

func (o *GetSchoolsOK) Error() string

func (*GetSchoolsOK) GetPayload

func (o *GetSchoolsOK) GetPayload() *models.SchoolsResponse

type GetSchoolsParams

type GetSchoolsParams struct {

	// Count.
	Count *string

	// EndingBefore.
	EndingBefore *string

	// Limit.
	Limit *int64

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetSchoolsParams contains all the parameters to send to the API endpoint

for the get schools operation.

Typically these are written to a http.Request.

func NewGetSchoolsParams

func NewGetSchoolsParams() *GetSchoolsParams

NewGetSchoolsParams creates a new GetSchoolsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetSchoolsParamsWithContext

func NewGetSchoolsParamsWithContext(ctx context.Context) *GetSchoolsParams

NewGetSchoolsParamsWithContext creates a new GetSchoolsParams object with the ability to set a context for a request.

func NewGetSchoolsParamsWithHTTPClient

func NewGetSchoolsParamsWithHTTPClient(client *http.Client) *GetSchoolsParams

NewGetSchoolsParamsWithHTTPClient creates a new GetSchoolsParams object with the ability to set a custom HTTPClient for a request.

func NewGetSchoolsParamsWithTimeout

func NewGetSchoolsParamsWithTimeout(timeout time.Duration) *GetSchoolsParams

NewGetSchoolsParamsWithTimeout creates a new GetSchoolsParams object with the ability to set a timeout on a request.

func (*GetSchoolsParams) SetContext

func (o *GetSchoolsParams) SetContext(ctx context.Context)

SetContext adds the context to the get schools params

func (*GetSchoolsParams) SetCount

func (o *GetSchoolsParams) SetCount(count *string)

SetCount adds the count to the get schools params

func (*GetSchoolsParams) SetDefaults

func (o *GetSchoolsParams) SetDefaults()

SetDefaults hydrates default values in the get schools params (not the query body).

All values with no default are reset to their zero value.

func (*GetSchoolsParams) SetEndingBefore

func (o *GetSchoolsParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get schools params

func (*GetSchoolsParams) SetHTTPClient

func (o *GetSchoolsParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get schools params

func (*GetSchoolsParams) SetLimit

func (o *GetSchoolsParams) SetLimit(limit *int64)

SetLimit adds the limit to the get schools params

func (*GetSchoolsParams) SetStartingAfter

func (o *GetSchoolsParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get schools params

func (*GetSchoolsParams) SetTimeout

func (o *GetSchoolsParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get schools params

func (*GetSchoolsParams) WithContext

func (o *GetSchoolsParams) WithContext(ctx context.Context) *GetSchoolsParams

WithContext adds the context to the get schools params

func (*GetSchoolsParams) WithCount

func (o *GetSchoolsParams) WithCount(count *string) *GetSchoolsParams

WithCount adds the count to the get schools params

func (*GetSchoolsParams) WithDefaults

func (o *GetSchoolsParams) WithDefaults() *GetSchoolsParams

WithDefaults hydrates default values in the get schools params (not the query body).

All values with no default are reset to their zero value.

func (*GetSchoolsParams) WithEndingBefore

func (o *GetSchoolsParams) WithEndingBefore(endingBefore *string) *GetSchoolsParams

WithEndingBefore adds the endingBefore to the get schools params

func (*GetSchoolsParams) WithHTTPClient

func (o *GetSchoolsParams) WithHTTPClient(client *http.Client) *GetSchoolsParams

WithHTTPClient adds the HTTPClient to the get schools params

func (*GetSchoolsParams) WithLimit

func (o *GetSchoolsParams) WithLimit(limit *int64) *GetSchoolsParams

WithLimit adds the limit to the get schools params

func (*GetSchoolsParams) WithStartingAfter

func (o *GetSchoolsParams) WithStartingAfter(startingAfter *string) *GetSchoolsParams

WithStartingAfter adds the startingAfter to the get schools params

func (*GetSchoolsParams) WithTimeout

func (o *GetSchoolsParams) WithTimeout(timeout time.Duration) *GetSchoolsParams

WithTimeout adds the timeout to the get schools params

func (*GetSchoolsParams) WriteToRequest

func (o *GetSchoolsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type GetSchoolsReader

type GetSchoolsReader struct {
	// contains filtered or unexported fields
}

GetSchoolsReader is a Reader for the GetSchools structure.

func (*GetSchoolsReader) ReadResponse

func (o *GetSchoolsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetSectionsForSchoolNotFound

type GetSectionsForSchoolNotFound struct {
	Payload *models.NotFound
}
GetSectionsForSchoolNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetSectionsForSchoolNotFound

func NewGetSectionsForSchoolNotFound() *GetSectionsForSchoolNotFound

NewGetSectionsForSchoolNotFound creates a GetSectionsForSchoolNotFound with default headers values

func (*GetSectionsForSchoolNotFound) Error

func (*GetSectionsForSchoolNotFound) GetPayload

func (o *GetSectionsForSchoolNotFound) GetPayload() *models.NotFound

type GetSectionsForSchoolOK

type GetSectionsForSchoolOK struct {
	Payload *models.SectionsResponse
}
GetSectionsForSchoolOK describes a response with status code 200, with default header values.

OK Response

func NewGetSectionsForSchoolOK

func NewGetSectionsForSchoolOK() *GetSectionsForSchoolOK

NewGetSectionsForSchoolOK creates a GetSectionsForSchoolOK with default headers values

func (*GetSectionsForSchoolOK) Error

func (o *GetSectionsForSchoolOK) Error() string

func (*GetSectionsForSchoolOK) GetPayload

type GetSectionsForSchoolParams

type GetSectionsForSchoolParams struct {

	// EndingBefore.
	EndingBefore *string

	// ID.
	ID string

	// Limit.
	Limit *int64

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetSectionsForSchoolParams contains all the parameters to send to the API endpoint

for the get sections for school operation.

Typically these are written to a http.Request.

func NewGetSectionsForSchoolParams

func NewGetSectionsForSchoolParams() *GetSectionsForSchoolParams

NewGetSectionsForSchoolParams creates a new GetSectionsForSchoolParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetSectionsForSchoolParamsWithContext

func NewGetSectionsForSchoolParamsWithContext(ctx context.Context) *GetSectionsForSchoolParams

NewGetSectionsForSchoolParamsWithContext creates a new GetSectionsForSchoolParams object with the ability to set a context for a request.

func NewGetSectionsForSchoolParamsWithHTTPClient

func NewGetSectionsForSchoolParamsWithHTTPClient(client *http.Client) *GetSectionsForSchoolParams

NewGetSectionsForSchoolParamsWithHTTPClient creates a new GetSectionsForSchoolParams object with the ability to set a custom HTTPClient for a request.

func NewGetSectionsForSchoolParamsWithTimeout

func NewGetSectionsForSchoolParamsWithTimeout(timeout time.Duration) *GetSectionsForSchoolParams

NewGetSectionsForSchoolParamsWithTimeout creates a new GetSectionsForSchoolParams object with the ability to set a timeout on a request.

func (*GetSectionsForSchoolParams) SetContext

func (o *GetSectionsForSchoolParams) SetContext(ctx context.Context)

SetContext adds the context to the get sections for school params

func (*GetSectionsForSchoolParams) SetDefaults

func (o *GetSectionsForSchoolParams) SetDefaults()

SetDefaults hydrates default values in the get sections for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetSectionsForSchoolParams) SetEndingBefore

func (o *GetSectionsForSchoolParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get sections for school params

func (*GetSectionsForSchoolParams) SetHTTPClient

func (o *GetSectionsForSchoolParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get sections for school params

func (*GetSectionsForSchoolParams) SetID

func (o *GetSectionsForSchoolParams) SetID(id string)

SetID adds the id to the get sections for school params

func (*GetSectionsForSchoolParams) SetLimit

func (o *GetSectionsForSchoolParams) SetLimit(limit *int64)

SetLimit adds the limit to the get sections for school params

func (*GetSectionsForSchoolParams) SetStartingAfter

func (o *GetSectionsForSchoolParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get sections for school params

func (*GetSectionsForSchoolParams) SetTimeout

func (o *GetSectionsForSchoolParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get sections for school params

func (*GetSectionsForSchoolParams) WithContext

WithContext adds the context to the get sections for school params

func (*GetSectionsForSchoolParams) WithDefaults

WithDefaults hydrates default values in the get sections for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetSectionsForSchoolParams) WithEndingBefore

func (o *GetSectionsForSchoolParams) WithEndingBefore(endingBefore *string) *GetSectionsForSchoolParams

WithEndingBefore adds the endingBefore to the get sections for school params

func (*GetSectionsForSchoolParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the get sections for school params

func (*GetSectionsForSchoolParams) WithID

WithID adds the id to the get sections for school params

func (*GetSectionsForSchoolParams) WithLimit

WithLimit adds the limit to the get sections for school params

func (*GetSectionsForSchoolParams) WithStartingAfter

func (o *GetSectionsForSchoolParams) WithStartingAfter(startingAfter *string) *GetSectionsForSchoolParams

WithStartingAfter adds the startingAfter to the get sections for school params

func (*GetSectionsForSchoolParams) WithTimeout

WithTimeout adds the timeout to the get sections for school params

func (*GetSectionsForSchoolParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetSectionsForSchoolReader

type GetSectionsForSchoolReader struct {
	// contains filtered or unexported fields
}

GetSectionsForSchoolReader is a Reader for the GetSectionsForSchool structure.

func (*GetSectionsForSchoolReader) ReadResponse

func (o *GetSectionsForSchoolReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetTermsForSchoolNotFound

type GetTermsForSchoolNotFound struct {
	Payload *models.NotFound
}
GetTermsForSchoolNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetTermsForSchoolNotFound

func NewGetTermsForSchoolNotFound() *GetTermsForSchoolNotFound

NewGetTermsForSchoolNotFound creates a GetTermsForSchoolNotFound with default headers values

func (*GetTermsForSchoolNotFound) Error

func (o *GetTermsForSchoolNotFound) Error() string

func (*GetTermsForSchoolNotFound) GetPayload

func (o *GetTermsForSchoolNotFound) GetPayload() *models.NotFound

type GetTermsForSchoolOK

type GetTermsForSchoolOK struct {
	Payload *models.TermsResponse
}
GetTermsForSchoolOK describes a response with status code 200, with default header values.

OK Response

func NewGetTermsForSchoolOK

func NewGetTermsForSchoolOK() *GetTermsForSchoolOK

NewGetTermsForSchoolOK creates a GetTermsForSchoolOK with default headers values

func (*GetTermsForSchoolOK) Error

func (o *GetTermsForSchoolOK) Error() string

func (*GetTermsForSchoolOK) GetPayload

func (o *GetTermsForSchoolOK) GetPayload() *models.TermsResponse

type GetTermsForSchoolParams

type GetTermsForSchoolParams struct {

	// EndingBefore.
	EndingBefore *string

	// ID.
	ID string

	// Limit.
	Limit *int64

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetTermsForSchoolParams contains all the parameters to send to the API endpoint

for the get terms for school operation.

Typically these are written to a http.Request.

func NewGetTermsForSchoolParams

func NewGetTermsForSchoolParams() *GetTermsForSchoolParams

NewGetTermsForSchoolParams creates a new GetTermsForSchoolParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetTermsForSchoolParamsWithContext

func NewGetTermsForSchoolParamsWithContext(ctx context.Context) *GetTermsForSchoolParams

NewGetTermsForSchoolParamsWithContext creates a new GetTermsForSchoolParams object with the ability to set a context for a request.

func NewGetTermsForSchoolParamsWithHTTPClient

func NewGetTermsForSchoolParamsWithHTTPClient(client *http.Client) *GetTermsForSchoolParams

NewGetTermsForSchoolParamsWithHTTPClient creates a new GetTermsForSchoolParams object with the ability to set a custom HTTPClient for a request.

func NewGetTermsForSchoolParamsWithTimeout

func NewGetTermsForSchoolParamsWithTimeout(timeout time.Duration) *GetTermsForSchoolParams

NewGetTermsForSchoolParamsWithTimeout creates a new GetTermsForSchoolParams object with the ability to set a timeout on a request.

func (*GetTermsForSchoolParams) SetContext

func (o *GetTermsForSchoolParams) SetContext(ctx context.Context)

SetContext adds the context to the get terms for school params

func (*GetTermsForSchoolParams) SetDefaults

func (o *GetTermsForSchoolParams) SetDefaults()

SetDefaults hydrates default values in the get terms for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetTermsForSchoolParams) SetEndingBefore

func (o *GetTermsForSchoolParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get terms for school params

func (*GetTermsForSchoolParams) SetHTTPClient

func (o *GetTermsForSchoolParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get terms for school params

func (*GetTermsForSchoolParams) SetID

func (o *GetTermsForSchoolParams) SetID(id string)

SetID adds the id to the get terms for school params

func (*GetTermsForSchoolParams) SetLimit

func (o *GetTermsForSchoolParams) SetLimit(limit *int64)

SetLimit adds the limit to the get terms for school params

func (*GetTermsForSchoolParams) SetStartingAfter

func (o *GetTermsForSchoolParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get terms for school params

func (*GetTermsForSchoolParams) SetTimeout

func (o *GetTermsForSchoolParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get terms for school params

func (*GetTermsForSchoolParams) WithContext

WithContext adds the context to the get terms for school params

func (*GetTermsForSchoolParams) WithDefaults

WithDefaults hydrates default values in the get terms for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetTermsForSchoolParams) WithEndingBefore

func (o *GetTermsForSchoolParams) WithEndingBefore(endingBefore *string) *GetTermsForSchoolParams

WithEndingBefore adds the endingBefore to the get terms for school params

func (*GetTermsForSchoolParams) WithHTTPClient

func (o *GetTermsForSchoolParams) WithHTTPClient(client *http.Client) *GetTermsForSchoolParams

WithHTTPClient adds the HTTPClient to the get terms for school params

func (*GetTermsForSchoolParams) WithID

WithID adds the id to the get terms for school params

func (*GetTermsForSchoolParams) WithLimit

WithLimit adds the limit to the get terms for school params

func (*GetTermsForSchoolParams) WithStartingAfter

func (o *GetTermsForSchoolParams) WithStartingAfter(startingAfter *string) *GetTermsForSchoolParams

WithStartingAfter adds the startingAfter to the get terms for school params

func (*GetTermsForSchoolParams) WithTimeout

WithTimeout adds the timeout to the get terms for school params

func (*GetTermsForSchoolParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetTermsForSchoolReader

type GetTermsForSchoolReader struct {
	// contains filtered or unexported fields
}

GetTermsForSchoolReader is a Reader for the GetTermsForSchool structure.

func (*GetTermsForSchoolReader) ReadResponse

func (o *GetTermsForSchoolReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type GetUsersForSchoolNotFound

type GetUsersForSchoolNotFound struct {
	Payload *models.NotFound
}
GetUsersForSchoolNotFound describes a response with status code 404, with default header values.

Entity Not Found

func NewGetUsersForSchoolNotFound

func NewGetUsersForSchoolNotFound() *GetUsersForSchoolNotFound

NewGetUsersForSchoolNotFound creates a GetUsersForSchoolNotFound with default headers values

func (*GetUsersForSchoolNotFound) Error

func (o *GetUsersForSchoolNotFound) Error() string

func (*GetUsersForSchoolNotFound) GetPayload

func (o *GetUsersForSchoolNotFound) GetPayload() *models.NotFound

type GetUsersForSchoolOK

type GetUsersForSchoolOK struct {
	Payload *models.UsersResponse
}
GetUsersForSchoolOK describes a response with status code 200, with default header values.

OK Response

func NewGetUsersForSchoolOK

func NewGetUsersForSchoolOK() *GetUsersForSchoolOK

NewGetUsersForSchoolOK creates a GetUsersForSchoolOK with default headers values

func (*GetUsersForSchoolOK) Error

func (o *GetUsersForSchoolOK) Error() string

func (*GetUsersForSchoolOK) GetPayload

func (o *GetUsersForSchoolOK) GetPayload() *models.UsersResponse

type GetUsersForSchoolParams

type GetUsersForSchoolParams struct {

	// EndingBefore.
	EndingBefore *string

	// ID.
	ID string

	// Limit.
	Limit *int64

	// Primary.
	Primary *string

	// Role.
	Role *string

	// StartingAfter.
	StartingAfter *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetUsersForSchoolParams contains all the parameters to send to the API endpoint

for the get users for school operation.

Typically these are written to a http.Request.

func NewGetUsersForSchoolParams

func NewGetUsersForSchoolParams() *GetUsersForSchoolParams

NewGetUsersForSchoolParams creates a new GetUsersForSchoolParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetUsersForSchoolParamsWithContext

func NewGetUsersForSchoolParamsWithContext(ctx context.Context) *GetUsersForSchoolParams

NewGetUsersForSchoolParamsWithContext creates a new GetUsersForSchoolParams object with the ability to set a context for a request.

func NewGetUsersForSchoolParamsWithHTTPClient

func NewGetUsersForSchoolParamsWithHTTPClient(client *http.Client) *GetUsersForSchoolParams

NewGetUsersForSchoolParamsWithHTTPClient creates a new GetUsersForSchoolParams object with the ability to set a custom HTTPClient for a request.

func NewGetUsersForSchoolParamsWithTimeout

func NewGetUsersForSchoolParamsWithTimeout(timeout time.Duration) *GetUsersForSchoolParams

NewGetUsersForSchoolParamsWithTimeout creates a new GetUsersForSchoolParams object with the ability to set a timeout on a request.

func (*GetUsersForSchoolParams) SetContext

func (o *GetUsersForSchoolParams) SetContext(ctx context.Context)

SetContext adds the context to the get users for school params

func (*GetUsersForSchoolParams) SetDefaults

func (o *GetUsersForSchoolParams) SetDefaults()

SetDefaults hydrates default values in the get users for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetUsersForSchoolParams) SetEndingBefore

func (o *GetUsersForSchoolParams) SetEndingBefore(endingBefore *string)

SetEndingBefore adds the endingBefore to the get users for school params

func (*GetUsersForSchoolParams) SetHTTPClient

func (o *GetUsersForSchoolParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the get users for school params

func (*GetUsersForSchoolParams) SetID

func (o *GetUsersForSchoolParams) SetID(id string)

SetID adds the id to the get users for school params

func (*GetUsersForSchoolParams) SetLimit

func (o *GetUsersForSchoolParams) SetLimit(limit *int64)

SetLimit adds the limit to the get users for school params

func (*GetUsersForSchoolParams) SetPrimary

func (o *GetUsersForSchoolParams) SetPrimary(primary *string)

SetPrimary adds the primary to the get users for school params

func (*GetUsersForSchoolParams) SetRole

func (o *GetUsersForSchoolParams) SetRole(role *string)

SetRole adds the role to the get users for school params

func (*GetUsersForSchoolParams) SetStartingAfter

func (o *GetUsersForSchoolParams) SetStartingAfter(startingAfter *string)

SetStartingAfter adds the startingAfter to the get users for school params

func (*GetUsersForSchoolParams) SetTimeout

func (o *GetUsersForSchoolParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the get users for school params

func (*GetUsersForSchoolParams) WithContext

WithContext adds the context to the get users for school params

func (*GetUsersForSchoolParams) WithDefaults

WithDefaults hydrates default values in the get users for school params (not the query body).

All values with no default are reset to their zero value.

func (*GetUsersForSchoolParams) WithEndingBefore

func (o *GetUsersForSchoolParams) WithEndingBefore(endingBefore *string) *GetUsersForSchoolParams

WithEndingBefore adds the endingBefore to the get users for school params

func (*GetUsersForSchoolParams) WithHTTPClient

func (o *GetUsersForSchoolParams) WithHTTPClient(client *http.Client) *GetUsersForSchoolParams

WithHTTPClient adds the HTTPClient to the get users for school params

func (*GetUsersForSchoolParams) WithID

WithID adds the id to the get users for school params

func (*GetUsersForSchoolParams) WithLimit

WithLimit adds the limit to the get users for school params

func (*GetUsersForSchoolParams) WithPrimary

func (o *GetUsersForSchoolParams) WithPrimary(primary *string) *GetUsersForSchoolParams

WithPrimary adds the primary to the get users for school params

func (*GetUsersForSchoolParams) WithRole

WithRole adds the role to the get users for school params

func (*GetUsersForSchoolParams) WithStartingAfter

func (o *GetUsersForSchoolParams) WithStartingAfter(startingAfter *string) *GetUsersForSchoolParams

WithStartingAfter adds the startingAfter to the get users for school params

func (*GetUsersForSchoolParams) WithTimeout

WithTimeout adds the timeout to the get users for school params

func (*GetUsersForSchoolParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type GetUsersForSchoolReader

type GetUsersForSchoolReader struct {
	// contains filtered or unexported fields
}

GetUsersForSchoolReader is a Reader for the GetUsersForSchool structure.

func (*GetUsersForSchoolReader) ReadResponse

func (o *GetUsersForSchoolReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址