KIP.Public.People.Versions

Query Parameters

searchstring

pageinteger(int16)

Default:1

pageSizeinteger(int8)

Default:20

<= 100

Response

application/json

The request has succeeded.

dataarray[object]required

Show Child Parameters

metaobject

Show Child Parameters

linksarray[object]required

Show Child Parameters

get/metadata/users/school-options

Authentication

Client ID

Client Secret

Scopes

KIP.People.Users.Me.Items.Read -

KIP.People.Users.Me.Items.Tickets.Read -

KIP.People.Users.Me.Items.Vouchers.Read -

KIP.People.Users.Me.Items.LoyaltyCards.Read -

KIP.People.Users.Me.Items.Transactions.Read -

KIP.People.Users.Me.Items.SupportTickets.Read -

KIP.People.Users.Me.Profile.Delete -

KIP.People.Users.Me.Profile.Read -

KIP.People.Users.Me.Profile.Basic.Read -

KIP.People.Users.Me.Profile.Write -

KIP.People.Users.Me.Profile.Basic.Write -

KIP.People.Users.Me.Profile.Extended.Read -

KIP.People.Users.Me.Profile.Extended.Write -

KIP.People.Users.Me.Profile.Preferences.Read -

KIP.People.Users.Me.Profile.Preferences.Write -

KIP.People.Users.Me.Profile.Addresses.Read -

KIP.People.Users.Me.Profile.Addresses.Write -

KIP.People.Users.Me.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Write -

KIP.People.Users.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.Membership.Write -

KIP.People.Users.Me.Movies.Read -

KIP.People.Users.Me.Movies.History.Read -

KIP.People.Users.Me.Movies.Write -

KIP.People.Users.Me.Movies.History.Write -

KIP.People.Users.Me.Movies.Recommendations.Read -

KIP.People.Users.Me.Movies.Recommendations.Write -

KIP.People.Users.Me.Movies.Wishlist.Read -

KIP.People.Users.Me.Movies.Wishlist.Write -

KIP.People.Users.Me.Exports.Read -

KIP.People.Users.Me.Exports.GDPR.Read -

KIP.People.Companies.Write -

KIP.People.Users.Items.Read -

KIP.People.Users.Items.Tickets.Read -

KIP.People.Users.Items.Vouchers.Read -

KIP.People.Users.Items.LoyaltyCards.Read -

KIP.People.Users.Items.Transactions.Read -

KIP.People.Users.Items.SupportTickets.Read -

KIP.People.Users.Profile.Delete -

KIP.People.Users.Profile.Read -

KIP.People.Users.Profile.Basic.Read -

KIP.People.Users.Profile.Basic.Write -

KIP.People.Users.Profile.Extended.Read -

KIP.People.Users.Profile.Extended.Write -

KIP.People.Users.Profile.Preferences.Read -

KIP.People.Users.Profile.Preferences.Write -

KIP.People.Users.Profile.Addresses.Read -

KIP.People.Users.Profile.Addresses.Write -

KIP.People.Users.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Membership.Write -

KIP.People.Users.Movies.Read -

KIP.People.Users.Movies.History.Read -

KIP.People.Users.Movies.Write -

KIP.People.Users.Movies.History.Write -

KIP.People.Users.Movies.Recommendations.Read -

KIP.People.Users.Movies.Recommendations.Write -

KIP.People.Users.Movies.Wishlist.Read -

KIP.People.Users.Movies.Wishlist.Write -

KIP.People.Users.Exports.GDPR.Read -

KIP.People.Metadata.Read -

KIP.People.Metadata.Preferences.Read -

KIP.People.Metadata.Schools.Read -

KIP.People.Metadata.StudyLevels.Read -

Path Parameters

Query Parameters

Headers

Body

application/json

Allowed values:v0v1

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4).

statusnumberrequired

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

Allowed values:400

detailstringrequired

A human-readable explanation specific to this occurrence of the problem.

typestringrequired

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be “about:blank”.

Example

titlestringrequired

Default:Forbidden.

statusnumberrequired

Allowed values:403

Example

GetSchoolOptions

Query Parameters

Response

Authentication

Path Parameters

Query Parameters

Headers

Body

GetStudyLevelOptions

Query Parameters

Response

Authentication

Path Parameters

Query Parameters

Headers

Body

KIP.Shared.Models.BaseErrorModel

KIP.Shared.Models.ForbiddenError