KIP People API (Public)

ExportUserData

Create an export job for exporting a user’s data

post

Path Parameters

userIdstring(uuid)required

Response

application/json

The request has been accepted for processing, but processing has not yet completed.

Models.Responses.GdprExportResponse

The request has been accepted for processing, but processing has not yet completed.

dataobjectrequired
Show Child Parameters
linksarray[object]required
Show Child Parameters
post/users/{userId}/exports/data
 
application/json

Metadata

GetPreferenceOptions

Get the preference options filtered on type

get

Query Parameters

searchstring
pageinteger(int16)

Default:1

pageSizeinteger(int8)

Default:20

<= 100

Path Parameters

typestringrequired

Allowed values:NewsletterMovieGenreMovieBasedOnMovieTechnologyMovieVersionMovieCinemanieMovieCountryMovieActorMovieDirectorMovieAwardPersonalProfessionPersonalStudyLevelPersonalFamilySizeCinemaVisitFrequencyOtherMusicGenreOtherSportOtherAlternativeContent

Response

application/json

The request has succeeded.

The request has succeeded.

dataarray[object]required
Show Child Parameters
metaobject
Show Child Parameters
linksarray[object]required
Show Child Parameters
get/metadata/users/preference-options/{type}
 
application/json

GetSchoolOptions

Get the school options

get

Query Parameters

searchstring
pageinteger(int16)

Default:1

pageSizeinteger(int8)

Default:20

<= 100

Response

application/json

The request has succeeded.

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
 
application/json

GetStudyLevelOptions

Get the possible study levels

get

Query Parameters

searchstring
pageinteger(int16)

Default:1

pageSizeinteger(int8)

Default:20

<= 100

Response

application/json

The request has succeeded.

The request has succeeded.

dataarray[object]required
Show Child Parameters
metaobject
Show Child Parameters
linksarray[object]required
Show Child Parameters
get/metadata/users/study-level-options
 
application/json