The User Endpoint handles all User-related Functionalities within a valid Frontend Session. It does not handle User Interaction, you can find those Endpoints here:
This Endpoint registers a User. All User entered Details must be valid POST Attributes (like username, firstname etc).
Request Body
Name
Type
Description
provider
string
[facebook, google, twitter, aad, external] The User was registered via a Social Connector
vouchercode
string
if given, the Voucher will be consumed automatically after successfull Registration.
affiliatepartner
string
in Case the User originally came from an Affilaite Session but decided to register in a later Session, this Parameter will be the Code an (existing) Affiliate Partner for this User Registration.
affiliateparam
string
in Case of a given Affilate Partner ID, this is a Partner Specific Code, which may be used later in Payment Transactions.
connectedForm
integer
if the Registration Form was built with a nexxOMNIA Form, the Form ID should be sent here. This will ensude automatic Validation based on the Form Rules.
paymentRegistrationService
string
if set and equals a valid 3Q nexx Payment Subscriber Code, the User will be connected to this Service internally.
skipLogin
boolean
if set to 1 and Login would be possible afterwards (=automatic Authorization), the User will not be logged in. Instead, the API will return an itemupdate Object.
isPreRegister
boolean
if set to 1 and Login would be possible afterwards, the User will not be logged in (like "skipLogin" Parameter). In this Case though, the User will also receive a different Confirmation Email for his Login, as the target Platform is not live yet.
updates a User Notification Preferences for new Media in a given Channel.
Query Parameters
Name
Type
Description
channel
integer
the target Channel
viamail
boolean
set to 1, if the User wants to be informed via Email
viapush
boolean
set to 1, if ths User wants to be informed via Push
/updatedata
PUThttps://api.nexx.cloud/v3.1/user/updatedata
will update all User Details (except Password, Username and Status). All given User Details must be sent via PUT Parameters as in the /register Endpoint.
Request Body
Name
Type
Description
connectedForm
integer
if handled via a nexxOMNIA Form, Auto Validation will take Place based on the Rules for the given Form ID
will remove the User completey. This Operation cannot be undone, so use with extreme Care.
Media Item Lists
Media Item List Endpoints return Lists of Media Items, that the User interacted in any Way.
Parameter
Values
Description
forUserID
valid User ID
if omitted, the currently loggedin User is the target User. If coming from a Backend Process with the "eternal Session", this Parameter can be set for querying for statistical Purposes.
mediaDataLevel
[flat, null]
as the returned Lists can become very long, set this Parameter to "flat" in order to only retrieve minimal Media Informations
This special Endpoint is designed for History Synchronization on Login. It only returnes the Media IDs and will always return ALL of them - Paging is not supported in this Case.
Query Parameters
Name
Type
Description
streamtypes
string
a Comma seperated List of Streamtypes to be included in the Result Set
includeProgress
boolean
if set to 1, the Result Set will contain a maximally reached Progress for each Media Item (for Streamtypes, that have a Time Dimension)
excludeCompleted
boolean
dont include fully watched Items
maxDays
integer
if set, include only Items, watched during the last maxDays Days.
