Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

This document outlines how we approach developing and supporting multiple API endpoint versions.

Phases of life

PhaseDescriptionFeature changesSecurity patches
CurrentThis is the most recent major version of our APIYesYes
DeprecatedOne major version behind "current"NoYes
End of lifeEndpoints that are no longer supported at allNoNo

General philosophy

We would like all of our customers to be using the most current version of our API.  This is the version that we will be updating with features and actively maintaining.

Deprecated endpoints are available for use (their routes work) but are not actively supported with new features.  

Endpoints that are in end of life will be scheduled to be removed from the server, clients making use of them should contact us for help in migrating to more current endpoints.

We will not move an endpoint to "end of life" before consulting with client developers.

Table of Contents


Current version lifecycle

Category

Current
VersionEndpointLifecycleDocumentation
No versionList of categoriesDeprecatedList of Categories

Channel

PlannedChannel index (REST)Metadata: Channels#GetChannelIndex31CurrentCurrent
VersionTitleLifecycleDocumentation
4.0User specified favourite channel lists (REST)CurrentFavourite channel lists
4.0ChannelsPlannedSchedule#/Channels/GetChannelsIndex
4.User specific channels0Channel detailsPlannedSchedule#/Channels/GetChannelById
3.1User specific channelsEnd of LifeUser specific channels (v3.1)
3.1List of channelsEnd of LifeList of Channels (v3.1)
2List of channelsDeprecatedList of Channels (v2)
2Details of channelDeprecatedDetails of Channel (v2)
2Play channelDeprecatedPlayableStream
2.0Mark/unmark channel as favouriteDeprecatedMark/unmark channel as favourite
1.0Play ChannelEnd of LifePlay Channel (deprecated)
1.0Adding Channels to be RecordedEnd of LifeAdding Channels to be Recorded

EPG

VersionTitleLifecycleDocumentation
4.0Broadcast slotsCurrentSchedule#/Broadcast%20Slots/GetBroadcastSlotsIndex
4.0Broadcast slot detailsCurrentSchedule#/Broadcast%20Slots/GetBroadcastSlotById
3.0EPG List V3
Current
DeprecatedEPG List V3
3.0EPG Program Details V3
Current
DeprecatedEPG Program Details V3
No versionEPG List V2
Deprecated
End of LifeEPG List V2
2.0EPG V2 - Program Details
Deprecated
End of LifeEPG V2 - Program Details
2.0List of top recordings
Current
DeprecatedList of top recordings
4Get a list of broadcast slotsPlannedSchedule#/BroadcastSlots/GetBroadcastSlotsIndex
4Get a list of programs with basic metadataPlannedMetadata: Programs#/Programs/GetProgramIndex
4Get details for a specific program including rich metadata relationships
PLanned
PlannedMetadata: Programs#/Programs/GetProgram
4Get a list of genresPlannedMetadata: Genres#/Genres/indexGenres
4Get a list of programs for a particular genrePlannedMetadata: Genres#/Genres/SeeGenrePrograms
4Get list of programs for a credited personPlanned/wiki/spaces/MAPI/pages/49676902


Teletext

VersionTitleLifecycleDocumentation
2.0Teletext Page ItemDeprecatedTeletext Page Item
2.0Teletext SubPage ItemDeprecatedTeletext SubPage Item
2.0TeleText SubPage IndexDeprecatedTeletext SubPage Index
2.0TeleText CreateDeprecatedTeletext Create

Irdeto Integration    

VersionTitleLifecycleDocumentation
2.0Associate User with STBDeviceDeprecatedAssociate User with STBDevice
REST 1.0Entitle a set top box to watch DVB channelsPlanned/wiki/spaces/MAPI/pages/49676635
REST 1.0

Remove entitlement from set top box

Planned/wiki/spaces/MAPI/pages/49676635


Product and Licensing    

Recording    

VersionTitleLifecycleDocumentationREST 1.0User recording playable streamsCurrentPlayableStream related to Recording4.0

Get an index of user recording request entities

Planned/wiki/spaces/MAPI/pages/496764684.0Request that a new recording is madePlanned/wiki/spaces/MAPI/pages/496764684.0Get details of a particular recording requestPlanned/wiki/spaces/MAPI/pages/496764684.0Cancel a recording requestPlanned/wiki/spaces/MAPI/pages/496764684.0Get a list of slots that a device must record (called by STB)Planned/wiki/spaces/MAPI/pages/496764684.0Update the status of a recording slot (called by STB)Planned/wiki/spaces/MAPI/pages/496764684.0

Get an index of user recording entities

Planned/wiki/spaces/MAPI/pages/496764684.0Update the status of a recording, for example to update how much time the user has watched.Planned/wiki/spaces/MAPI/pages/496764684.0Delete a recordingPlanned/wiki/spaces/MAPI/pages/496764684.0Get a list of tags that have been created for recording requestsPlanned/wiki/spaces/MAPI/pages/496764684.0Get a list of recordings that are in a recording groupPlanned/wiki/spaces/MAPI/pages/49676468REST 1.0

Update one or more attributes of an existing entity

Deprecated/wiki/spaces/MAPI/pages/49676468REST 1.0Get a list of recordings that have previously been startedDeprecated/wiki/spaces/MAPI/pages/496764682.0

Recording item

CurrentRecording item2.3Add Program for RecordingCurrentAdd Program for Recording2.3Play user recordingDeprecatedPlay user recording in favour of PlayableStream related to Recording2.0Logging User PlaybackCurrentLogging User Playback2.3Update Recorded ContentCurrentUpdate Recorded Content2.3Delete Recorded ContentCurrentDelete Recorded Content2.3Search Recorded ContentCurrentSearch Recorded Content2.0Get list of playheadsCurrentGet list of playheads2.0Get specific playheadCurrentGet specific playhead2.0Update Recording Playback positionCurrentUpdate Recording Playback position2.0List of Favorite RecordingsCurrentList of Favorite Recordings2.0Update multiple user favouritesCurrentUpdate multiple user favourites2.2Delete Grouped Recorded ContentCurrentDelete Grouped Recorded Content1.0List Programs in a Recording Group V1DeprecatedList Programs in a Recording Group V11.0List Recording Groups and Single Programs V1DeprecatedList Recording Groups and Single Programs V12.1List Recording Groups and Single Programs V2CurrentList Recording Groups and Single Programs V2No versionList Programs in a Recording Group V2CurrentList Programs in a Recording Group V22.0Catchup ProgramCurrentCatchup Program2.0Catchup Groups collectionCurrentCatchup Groups collection2.0Catchup Group itemCurrentCatchup Group item2.1Logging Catchup PlaybackCurrentLogging Catchup Playback1.2Patch User RecordingsCurrentPatch User Recordings1.1Get Continue Watching RecordingsCurrentGet Continue Watching Recordings1.1Get User RecordingsDeprecatedGet User Recordings2.0User Recording StorageCurrentUser Recording Storage an index of the licenses that a user has for channels Channel License#/Channels/GetUserChannelLicensesAdd channel to a Channel License#/Channels/addUserChannelLicensesChannel License#/Channels/DeleteUserChannelLicenses
VersionTitleLifecycleDocumentation
4.0Get Plannedlist of user's active licensesCurrentUser licenses v4#/License/GetUserLicenses
4.0Purchase a new license for the userPlannedCurrentUser licenses v4#/License/PurchaseUserLicense
4.0

Remove a channel license from a user.

PlannedGet a list of products visible to the userCurrentUser licenses v4#/Product/GetAllProducts
4.0Fetch a list of recording devices that are available to the userPlanned/wiki/spaces/MAPI/pages/49676828
2.0List of ProductsCurrentList of Products
1.1List of external VOD ProductsCurrentList of external VOD Products
2.0Details of ProductsCurrentDetails of Products
2.0Product Buy OptionsCurrentProduct Buy Options
2.0Buy a ProductCurrentBuy a Product
2.0List of LicensesCurrentList of Licenses
2.0Details of LicenseCurrentDetails of License
2.0Update LicenseCurrentUpdate License
No versionCheck License StatusCurrentCheck License Status
No versionVerify App-Store PaymentCurrentVerify App-Store Payment
2.0Verify Credit CardCurrentVerify Credit Card
2.0Booxmedia Product DetailsCurrentBooxmedia Product Details
2.2JWT token for VOD provider product licenseCurrentJWT token for VOD provider product license
2.0SilverHD licenseCurrentSilverHD license
2.0Activate Gameleo licenseCurrentActivate Gameleo license

User Management    

VersionTitleLifecycleDocumentation4.0Get an index of Users.PlannedUsers#/Users/indexUsers4.0Create a userPlannedUsers#/Users/createUser4.0

Get the details for a particular user.

PlannedUsers#/Users/getUserREST 1.0User Market segmentation (REST)CurrentUsers2.0User LoginCurrentUser Login2.0User LogoutCurrentUser Logout2.0List of UsersCurrentList of Users2.0Add New User AccountCurrentAdd New User Account2.0Edit Existing User AccountCurrentEdit Existing User Account2.0Delete User AccountCurrentDelete User Account2.0Request Account Password ResetCurrentRequest Account Password Reset2.0Confirm Account Password ResetCurrentConfirm Account Password Reset2.0Delete User AccountCurrentDelete User Account2.0Add User AliasCurrentAdd User Alias2.0Change User AliasCurrentChange User Alias2.0Delete User AliasCurrentDelete User Alias2.0Link User with User AliasCurrentLink User with User Alias2.0Associate Package with User AliasCurrentAssociate Package with User Alias2.0Change Associated PackageCurrentChange Associated Package2.0Add Additional ServiceCurrentAdd Additional Service2.0Get Service StatusCurrentGet Service Status2.0Logged In User's Service StatusCurrentLogged In User's Service Status2.0Update User Service SettingsCurrentUpdate User Service Settings2.0Get User Service DetailsCurrentGet User Service Details2.0Delete Additional ServiceCurrentDelete Additional Service2.0Player Consume MinutesCurrentPlayer Consume Minutes2.0Get Consumed MinutesCurrentGet Consumed Minutes2.0Add STBCurrentAdd STB2.0Link STB to UserCurrentLink STB to User2.0Remove STB Ownership from an UserCurrentRemove STB Ownership from an User2.0OAuth2 User Login (Delta)CurrentOAuth2 User Login (Delta)

Market segment (client API, not mananagement)

VersionTitleLifecycleDocumentationREST 1.0Get the market segments for a particular user CurrentMarket segmentation#/Market%20Segmentation/getUserMarketSegments

Recommendation    

VersionTitleLifecycleDocumentation4.0Get a list of populare recordingsPlanned/wiki/spaces/MAPI/pages/496768454.0Get a personal recommendationPlanned/wiki/spaces/MAPI/pages/496768454.0Get a personal recommendation from a specific genrePlanned/wiki/spaces/MAPI/pages/496768454.0Send a user event data point to the recommendation enginePlanned/wiki/spaces/MAPI/pages/496768452.0List of RecommendationsCurrentList of Recommendations2.0List of Recommendations for MoviesCurrentList of Recommendations for Movies2.0List of Recommendations for SeasonCurrentList of Recommendations for Season2.0List of Recommendations for SeriesCurrentList of Recommendations for Series2.0List of Recommendations for EpisodeCurrentList of Recommendations for Episode2.0List of Recommendations for RecordingCurrentList of Recommendations for Recording

Get licenses with a filter (management)

CurrentManagement Licenses v4#/License/GetLicenses
4.0Create a new license (management)CurrentManagement Licenses v4#/License/CreateLicense
4.0Get a license (management)CurrentManagement Licenses v4#/License/GetLicenseById
4.0Delete a license (management)CurrentManagement Licenses v4#/License/DeleteLicenseById
4.0Batch create licenses (management)CurrentManagement Licenses v4#/License/BatchCreateLicenses
4.0Batch delete licenses (management)CurrentManagement Licenses v4#/License/BatchDeleteLicenses
4.0Delete all user's licenses (management)CurrentManagement Licenses v4#/License/BatchDeleteAllUserLicenses
4.0Get all user's licenses (management)CurrentManagement Licenses v4#/License/GetLicensesByUser
4.0Get all products (management)CurrentManagement Licenses v4#/Product/GetAllProducts
4.0Create a new product (management)CurrentManagement Licenses v4#/Product/CreateProduct
4.0Get product details (management)CurrentManagement Licenses v4#/Product/GetProductById
4.0Update product (management)CurrentManagement Licenses v4#/Product/UpdateProduct
4.0Delete a product (management)CurrentManagement Licenses v4#/Product/DeleteProductById
2.0List of ProductsDeprecatedList of Products
1.1List of external VOD ProductsDeprecatedList of external VOD Products
2.0Details of ProductsDeprecatedDetails of Products
2.0Product Buy OptionsDeprecatedProduct Buy Options
2.0Buy a ProductDeprecatedBuy a Product
2.0List of LicensesDeprecatedList of Licenses
2.0Details of LicenseDeprecatedDetails of License
2.0Update LicenseDeprecatedUpdate License
No versionCheck License StatusDeprecatedCheck License Status
No versionVerify App-Store PaymentDeprecatedVerify App-Store Payment
2.0Verify Credit CardDeprecatedVerify Credit Card
2.0Booxmedia Product DetailsDeprecatedBooxmedia Product Details
2.2JWT token for VOD provider product licenseDeprecatedJWT token for VOD provider product license
2.0SilverHD licenseDeprecatedSilverHD license
2.0Activate Gameleo licenseDeprecatedActivate Gameleo license


User Management

VersionTitleLifecycleDocumentation
4.0Get an index of Users (management)PlannedUsers#/Users/indexUsers
4.0Create a user (management)PlannedUsers#/Users/createUser
4.0

Get the details for a particular user (management)

PlannedUsers#/Users/getUser
4.0Add user flag (management)CurrentUsers#/User%20Flags/addUserFlag
4.0Remove user flag (management)CurrentUsers#/User%20Flags/deleteUserFlag
4.0User market segmentation (management)CurrentUsers#/Market%20Segmentation/getUserMarketSegments
4.0Update user's market segmentation (management)CurrentUsers#/Market%20Segmentation/createUserMarketSegments
4.0User market segmentationCurrentMarket segmentation#/Market%20Segmentation/getUserMarketSegments
4.0User login and access tokensCurrentUser Authentication#/Account%20Authentication/createAccessToken
4.0Device AuthorizationPlannedUser Authentication#/Device%20Authorization/createUserCode
4.0Device Authorization verificationPlannedUser Authentication#/Device%20Authorization/verifyUserCode
2.0User LoginDeprecatedUser Login
2.0User LogoutDeprecatedUser Logout
2.0List of UsersDeprecatedList of Users
2.0Add New User AccountDeprecatedAdd New User Account
2.0Edit Existing User AccountDeprecatedEdit Existing User Account
2.0Delete User AccountDeprecatedDelete User Account
2.0Request Account Password ResetDeprecatedRequest Account Password Reset
2.0Confirm Account Password ResetDeprecatedConfirm Account Password Reset
2.0Delete User AccountDeprecatedDelete User Account
2.0Add User AliasEnd of LifeAdd User Alias
2.0Change User AliasEnd of LifeChange User Alias
2.0Delete User AliasEnd of LifeDelete User Alias
2.0Link User with User AliasEnd of LifeLink User with User Alias
2.0Associate Package with User AliasEnd of LifeAssociate Package with User Alias
2.0Change Associated PackageEnd of LifeChange Associated Package
2.0Add Additional ServiceDeprecatedAdd Additional Service
2.0Get Service StatusDeprecatedGet Service Status
2.0Logged In User's Service StatusEnd of LifeLogged In User's Service Status
2.0Update User Service SettingsEnd of Life
Update User Service Settings
2.0Get User Service DetailsEnd of LifeGet User Service Details
2.0Delete Additional ServiceDeprecatedDelete Additional Service
2.0Player Consume MinutesDeprecatedPlayer Consume Minutes
2.0Get Consumed MinutesDeprecatedGet Consumed Minutes
2.0Add STBDeprecatedAdd STB
2.0Link STB to UserDeprecatedLink STB to User
2.0Remove STB Ownership from an UserDeprecatedRemove STB Ownership from an User
2.0OAuth2 User Login (Delta)DeprecatedOAuth2 User Login (Delta)

Recording    

VersionTitleLifecycleDocumentation
4.0Get a list of popular recordingsCurrentRecordings v4#/Recordings/getMostPopularBroadcastSlots
4.0

Search for recordings of a given user profile

CurrentRecordings v4#/Recordings/searchRecordedSlots
4.0Create a recordingCurrentRecordings v4#/Recordings/createRecordedSlot
4.0Update a recordingCurrentRecordings v4#/Recordings/updateRecordedSlot
4.0Delete a recordingCurrentRecordings v4#/Recordings/deleteRecordedSlot
4.0Batch delete recordingsCurrentRecordings v4#/Recordings/batchDeleteRecordedSlots
4.0List all recorded broadcast slotsCurrentRecordings v4#/Recordings/recordedBroadcastSlots
4.0

User's recording storage quota

CurrentRecordings v4#/Recordings/storageQuota
4.0List all automated recordings requests for a given user profileCurrentRecordings v4#/Automated%20Recording%20Requests/indexRecordingRequests
4.0Create an automated recording requestCurrentRecordings v4#/Automated%20Recording%20Requests/createRecordingRequest
4.0Update an automated recording requestCurrentRecordings v4#/Automated%20Recording%20Requests/updateRecordingRequests
4.0Delete an automated recording requestCurrentRecordings v4#/Automated%20Recording%20Requests/deleteRecordingRequests
4.0List all recording groups for a given user profileCurrentRecordings v4#/Recording%20Groups/indexRecordingGroups
4.0List all recordings for a specific recording groupCurrentRecordings v4#/Recording%20Groups/getRecordingsForGroup
4.0List all recording which do not belong to a groupCurrentRecordings v4#/Recording%20Groups/indexUngroupedRecordingGroupRecordings
REST 1.0

Update one or more attributes of an existing entity

Deprecated/wiki/spaces/MAPI/pages/49676468
REST 1.0Get a list of recordings that have previously been startedDeprecated/wiki/spaces/MAPI/pages/49676468
2.0

Recording item

DeprecatedRecording item
2.3Add Program for RecordingDeprecatedAdd Program for Recording
2.3Play user recordingDeprecatedPlay user recording in favour of PlayableStream related to Recording
2.0Logging User PlaybackDeprecatedLogging User Playback
2.3Update Recorded ContentDeprecatedUpdate Recorded Content
2.3Delete Recorded ContentDeprecatedDelete Recorded Content
2.3Search Recorded ContentDeprecatedSearch Recorded Content
2.0Get list of playheadsDeprecatedGet list of playheads
2.0Get specific playheadDeprecatedGet specific playhead
2.0Update Recording Playback positionDeprecatedUpdate Recording Playback position
2.0List of Favorite RecordingsDeprecatedList of Favorite Recordings
2.0Update multiple user favouritesDeprecatedUpdate multiple user favourites
2.2Delete Grouped Recorded ContentDeprecatedDelete Grouped Recorded Content
1.0List Programs in a Recording Group V1DeprecatedList Programs in a Recording Group V1
1.0List Recording Groups and Single Programs V1DeprecatedList Recording Groups and Single Programs V1
2.1List Recording Groups and Single Programs V2DeprecatedList Recording Groups and Single Programs V2
No versionList Programs in a Recording Group V2DeprecatedList Programs in a Recording Group V2
2.0Catchup ProgramDeprecatedCatchup Program
2.0Catchup Groups collectionDeprecatedCatchup Groups collection
2.0Catchup Group itemDeprecatedCatchup Group item
2.1Logging Catchup PlaybackDeprecatedLogging Catchup Playback
1.2Patch User RecordingsDeprecatedPatch User Recordings
1.1Get Continue Watching RecordingsDeprecatedGet Continue Watching Recordings
1.1Get User RecordingsDeprecatedGet User Recordings
2.0User Recording StorageDeprecatedUser Recording Storage

Catchup

VersionTitleLifecycleDocumentation
4.0Live streamsCurrent
4.0Recordings streamsCurrent
4.0Catchup streamsCurrent

Playable streams

VersionTitleLifecycleDocumentation
4.0Live streamsCurrent
4.0Recordings streamsCurrent
4.0Catchup streamsCurrent

Ruutu APIs    

VersionTitleLifecycleDocumentation
2.1Get a Ruutu session for the userCurrentGet a Ruutu session for the user
2.0Verify Ruutu AgreementCurrentVerify Ruutu Agreement
2.0Get user's Ruutu LicensesCurrentGet user's Ruutu Licenses

Server    

VersionTitleLifecycleDocumentation
2.0Get Server TimeCurrentGet Server Time
2.0TranslationCurrentTranslation
2.0Get Site ImagesCurrentGet Site Images
2.0Application Languages ListCurrentApplication Languages List
2.0Configuration Option ListCurrentConfiguration Option List
2.0Detail of Configuration OptionCurrentDetail of Configuration Option
2.0GEO BlockingCurrentGEO Blocking
2.0VAST AdsCurrentVAST Ads
2.0Get server healthCurrentGet server health

Social Media    

VersionTitleLifecycleDocumentation
2.0LoginEnd of LifeLogin
No versionLogoutEnd of LifeLogout
2.0Proxy LoginEnd of LifeProxy Login
2.0TwitterEnd of LifeTwitter

Stats    

VersionTitleLifecycleDocumentation
2.0Create Playback stats logCurrentCreate Playback stats log


STB authentication and functionality    

VersionTitleLifecycleDocumentation
2.1STB AuthenticationCurrentSTB Authentication
2.0Refresh TokenCurrentRefresh Token
2.0Link STB to UserCurrentLink STB to User
2.0Remove STB Ownership from an UserCurrentRemove STB Ownership from an User
2.0Logout STBCurrentLogout STB


User favourite channels


User    

VersionTitleLifecycleDocumentation
REST 1.0

Get the details for a particular user (accepts id or email as identifier)

CurrentUser information v1#/Users/getUser
2.0User RegistrationCurrentUser Registration
1.0Get UsersCurrentGet Users
1.0Get User By IDCurrentGet User By ID
2.0PIN Code VerificationCurrentPIN Code Verification
2.0PIN Code Reset RequestCurrentPIN Code Reset Request
2.0PIN Code Reset/UpdateCurrentPIN Code Reset/Update
2.0Parental PIN Code Reset/UpdateCurrentParental PIN Code Reset/Update
2.0Verify Parental PIN CodeCurrentVerify Parental PIN Code
2.0Parental PIN code reset requestCurrentParental PIN code reset request
2.0Get age limitCurrentGet age limit
2.0Set age limitCurrentSet age limit


Verimatrix APIs for DRM content    

VersionTitleLifecycleDocumentation
2.0Registers Device player's DRM idCurrentRegisters Device player's DRM id


VoD    

VersionTitleLifecycleDocumentation
4.0Program metadata (REST)CurrentMetadata: Programs
4.0Genres (REST)CurrentMetadata: Genres
4.0Seasons (REST)Current/wiki/spaces/MAPI/pages/49676898
2.0List of ProgramsEnd of LifeList of Programs
2.0Detail of ProgramEnd of LifeDetail of Program
2.0List of GenresEnd of LifeList of Genres
2.0Detail of GenreEnd of LifeDetail of Genre
2.0List of SeasonsEnd of LifeList of Seasons
2.0Detail of SeasonEnd of LifeDetail of Season
2.0Mark/Unmark a VOD Program as FavoriteEnd of LifeMark/Unmark a VOD Program as Favorite
2.0Play VoD ContentEnd of LifePlay VoD Content
2.0Play VOD TrailerEnd of LifePlay VOD Trailer
2.0Import XML of VODEnd of LifeImport XML of VOD


Wallet    

VersionTitleLifecycleDocumentation
2.0List of WalletsEnd of LifeList of Wallets
2.0Details of WalletEnd of LifeDetails of Wallet
2.0Transactions ListEnd of LifeTransactions List
2.0Transaction DetailEnd of LifeTransaction Detail
2.0Charge Product ListEnd of LifeCharge Product List
2.0Charge Product DetailEnd of LifeCharge Product Detail
2.0Buy ProductEnd of LifeBuy Product
2.0Charge Wallet with Credit CardEnd of LifeCharge Wallet with Credit Card
2.0Charge Wallet with VoucherEnd of LifeCharge Wallet with Voucher
2.0Apple Receipt VerificationEnd of LifeApple Receipt Verification


Stream (replaces "play" endpoints)  

VersionTitleLifecycleDocumentation
REST 1.2Stream List of ChannelCurrentStream List of Channel
REST 1.2Stream List of RecordingCurrentStream List of Recording
REST 1.1Stream List of User RecordingCurrentStream List of User Recording

Authentication / Session management

VersionTitleLifecycleDocumentation
4.0Create a user session ("login") in the middleware and receive a session cookiePlannedUser login#/User%20Session/createUserSession
4.0

Delete a user session in the middleware ("logout")

PlannedUser login#/User%20Session/deleteUserSession