Schlager.de

Reward

This module response with the rewards which can be ordered

GET /reward

responses with the list of active rewards

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /reward[/:reward_id]

response with an individual reward item

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Star

handles to which star the content of the app has to be adjusted

GET /star[/:star_id]

response with a list of stars if GET /star?fav=y is set, the list will return a list of stars which are shown in the users edit section for users favorite star

Fields

Field	Type	Description	Required
id	int	the star id	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

POST /star[/:star_id]

POST the star ID which the users chooses to follow

Fields

Field	Type	Description	Required
id	int	the star id	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/hal+json application/json
Content-Type	application/vnd.schlager.v1+json application/json

Body

{
   "id": "the star id"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

CampaignAd

Campaign Ads

POST /campaign/ad

POST the ad id and type which the user clicked (banner, popup, link)

Fields

Field	Type	Description	Required
id	integer	ad id	YES
type	string	the ad type [banner, popup, link]	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Content-Type	application/vnd.schlager.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "id": "ad id",
   "type": "the ad type [banner, popup, link]"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

depending on the posted type, the API will respond with different data to show in the app

POST type = banner
- id (the ad id)
- type = popup (this means, a popup needs to show up and also POST /campaign/ad if the user clicks on it)
- points (amount of points collected)
- image (popup image)
- link (for type = banner this will be null and can be ignored)

POST type = popup
- id (the ad id)
- type = link (this means, a redirect to a url needs to be initiated and also POST /campaign/ad with type = link)
- points (amount of points collected)
- image (for type = popup this will be null because after clicking the link, there is no image to show)
- link (the url to which the user should be redirected)

POST type = link
- there is a response message with validation text

CampaignCode

campaign voucher and qr codes

POST /campaign/code

POST voucher or qr code (the whole url)

Fields

Field	Type	Description	Required
code	string	the voucher or qr code	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Content-Type	application/vnd.schlager.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "code": "the voucher or qr code"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

a response message with collected points, image to show in the popup and link to redirect the user after clicking on the popup image

Contest

POST /contest/jackpot200k

Fields

Field	Type	Required
code	Integer	YES
firstname	String	YES
lastname	String	YES
email	String	YES
telephone	String	YES
zipcode	String	YES
street	String	YES
city	String	YES
salutation	String	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Content-Type	application/vnd.schlager.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

GET /contest/jackpot200k

Fields

Field	Type	Required
code	Integer	YES
firstname	String	YES
lastname	String	YES
email	String	YES
telephone	String	YES
zipcode	String	YES
street	String	YES
city	String	YES
salutation	String	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

FriendsGetFriends

get the users friends code

GET /campaign/friends-get-friends/code

the user can collect points by givong away the personal friends code. If the other user inputs the friends code after registration

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "voucher": "[string] - VOUCHER CODE",
    "points": "[integer] - amount of points the friends get",
    "validTo": "[date] - date on which the voucher code expires in format YYYY-MM-DD"
}

GET /links

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

Navigation

lists the app navigation items

GET /navigation

the navigation is individual to the star selection. Depending on the selection the items with its labels and links can change. There is one default navigation for schlager.de.

The navigation is also seperated into 3 parts. The top: which contains the logo image and label (star name), items: which containing the individual navigation items, bottom: which contain the bottom part of the navigation.

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "header": {
        "image": "IMAGE URL",
        "link": "LINK WHEN CLICKING ON THE IMAGE"
    },
    "top": {
        "image": "https://media.schlager.de/navigation/schlager_de.png",
        "label": "",
        "background": "IMAGE URL"
    },
    "items": [
        {
            "label": "SCHLAGER.DE-NEWS",
            "iconLeft": "https://media.schlager.de/navigation/news.png",
            "iconRight": "",
            "link": "schl://schlager.de/news"
        },
        {
            "label": "TAGESQUIZ",
            "iconLeft": "https://media.schlager.de/navigation/quizIcon.png",
            "iconRight": "",
            "link": "schl://schlager.de/quiz"
        },
        {
            "label": "SCHLAGER.DE FAN FORUM",
            "iconLeft": "https://media.schlager.de/navigation/forumIfon.png",
            "iconRight": "",
            "link": "https://forum.schlager.de/"
        },
        {
            "label": "BELIEBTE SCHLAGERSTARS",
            "iconLeft": "https://media.schlager.de/navigation/starsIcon.png",
            "iconRight": "",
            "link": "https://www.schlager.de/schlagerstars/"
        },
        {
            "label": "DIE BESTEN FOTOS",
            "iconLeft": "https://media.schlager.de/navigation/fotosIcon.png",
            "iconRight": "",
            "link": "https://www.schlager.de/fotogalerie/"
        },
        {
            "label": "DIE BESTEN VIDEOS",
            "iconLeft": "https://media.schlager.de/navigation/videosIcon.png",
            "iconRight": "",
            "link": "https://www.schlager.de/schlagervideos/"
        },
        {
            "label": "HOROSKOPE",
            "iconLeft": "https://media.schlager.de/navigation/horoskoIcon.png",
            "iconRight": "",
            "link": "https://www.schlager.de/horoskop/"
        },
        {
            "label": "FANS-WERBEN-FANS",
            "iconLeft": "https://media.schlager.de/navigation/friendsIcon.png",
            "iconRight": "",
            "link": "schl://schlager.de/friends"
        },
        {
            "label": "PUNKTEN & GEWINNEN",
            "iconLeft": "https://media.schlager.de/navigation/rewardsIcon.png",
            "iconRight": "",
            "link": "schl://schlager.de/rewards"
        },
        {
            "label": "MEIN FANPROFIL",
            "iconLeft": "https://media.schlager.de/navigation/fanprofilIcon.png",
            "iconRight": "",
            "link": "schl://schlager.de/user"
        },
        {
            "label": "SCHLAGER.DE-QR-SCANNER",
            "iconLeft": "https://media.schlager.de/navigation/qrScannerIcon.png",
            "iconRight": "",
            "link": "schl://schlager.de/scanner"
        },
        {
            "label": "IMPRESSUM & DATENSCHUTZ",
            "iconLeft": "https://media.schlager.de/navigation/impressumIcon.png",
            "iconRight": "",
            "link": "https://www.schlager.de/datenschutz/"
        }
    ],
    "bottom": {
        "label": "ZURÜCK ZUR AUSWAHL",
        "iconLeft": "https://media.schalger.de/navigation/mobile.png",
        "iconRight": "",
        "link": "schl://schlager.de/stars"
    }
}

NewsTicker

This module is responsible for returning a list short news for the ticker view

GET /news/ticker

Please GET /news?startResult=x&maxResults=y to filter/limit the result list

Fields

Field	Type	Description	Required
startResult	integer	start result value	NO
maxResults		how many result items should be responded	NO

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

a list of news ticker items

News

This module is responsible for returning a list of new and campaign banner

GET /news

Please GET /news?startResult=x&maxResults=y to filter/limit the result list. Use GET search=USERS-SEARCH-INPUT for searching for a specific news

Fields

Field	Type	Description	Required
startResult	integer	start result value	NO
maxResults	integer	how many result items should be responded	NO
search	string	users input to search after specific news	NO

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

a news list sorted by the news type and poll

the list contaigns:
poll:
if the parameter "isActive" is "true", please show the content of the parameter "url" in an iframe. If is "false" than just show the news items

items:
this contaigns a list of the individual news items

pagination:
contaigns information for filtering the items list by startResult and maxResults and also returns the total amount of news items

Order

With this module is responsible for making reward purchases

POST /reward/order

You will need to POST the users information for delivering address and rewardId

Fields

Field	Type	Description	Required
salutation	string	the users salutation [Herr, Frau, anderes]	YES
lastname	string	string	YES
firstname	string	the users firstname	YES
street	string	users street and number	YES
zipcode	string	the users zipcode	YES
city	string	users city	YES
telephone	string	users telephone number	YES
email	string	users email address	YES
rewardId	int	the reward ID the user wants to buy	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Content-Type	application/vnd.schlager.v1+json application/json

Body

{
   "salutation": "the users salutation [Herr, Frau, anderes]",
   "lastname": "string",
   "firstname": "the users firstname",
   "street": "users street and number",
   "zipcode": "the users zipcode",
   "city": "users city",
   "telephone": "users telephone number",
   "email": "users email address",
   "rewardId": "the reward ID the user wants to buy"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

respons with order number(orderId), spended points(einsatz) and mail type(versandart)

PointsSum

response with the sum of collected points of an user

GET /points/sum

sum of all points which the user collected and spend

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "points": [integer] - amount of points
}

Points

total points amount the user currently has and the history items of collected and spend points

GET /points

Please GET /points?startResult=x&maxResults=y to filter/limit the result list

Fields

Field	Type	Description	Required
startResult	integer	start result value	NO
maxResults	integer	how many result items should be responded	NO

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

a list with totalPoints (total amount of points) and items (a list of collected and spend points items)

PollAnswer

POST /poll/answer

Fields

Field	Type	Description	Required
qestionId	integer	question id	YES
answer	String	users answer to the poll	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Content-Type	application/vnd.schlager.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

Poll

GET /poll

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

QuizAnswer

answer a quiz

POST /quiz/answer

answer a quiz question

Fields

Field	Type	Description	Required
questionId	integer	the questions id the user wants to answer	YES
answerId	integer	the answer id the user wants to answer	YES

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Content-Type	application/vnd.schlager.v1+json application/json

Body

{
   "questionId": "the questions id the user wants to answer",
   "answerId": "the answer id the user wants to answer"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "points": "amount of points the user gets for answering the question",
    "correctAnswerId": "id from correct answer",
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html ",
    "title": "Short title / description about response status",
    "status": STATUS CODE,
    "detail": "A more detailed description"
}

Quiz

get a quiz question

GET /quiz

get a quiz question with info about wether or not it was already answered and how much points a user can get

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

[
    {
      "id": "[integer] - question id",
       "question": "[string] - the quiz question",
       "answers": [
        {
            "id": "[integer] - answer id",
            "answer": "[string] - answer 1"
        },
        {
            "id": "[integer] - answer id",
            "answer": "[string] - answer 2"
        },
        {
            "id": "[integer] - answer id",
            "answer": "[string] - answer 3"
        },
        {
            "id": "[integer] - answer id",
            "answer": "[string] - answer 4"
        },
        {
            "id": "[integer] - answer id",
            "answer": "[string] - answer 5"
        },
        {
            "id": "[integer] - answer id",
            "answer": "[string] - answer 1"
        }
    ],
       "sponsorName": "[string] - who sponsored this quiz item",
       "sponsorLink": "[string] - web link to quiz sponsor",
       "sponsorImage": "[string] - url path to sponsor image",
       "points": "[integer] - amount of points for correct answer",
       "bannerImage": "[string] - url path to quiz banner image",
       "publicDate": "[string] - when to publish this quiz item in format: JJJJ:MM:DD HH:ii:ss",
       "answerHistory": {
           "isAnswered": [enum] - true or false,
           "answeredDate": "[date] - in format: YYYY-MM-DD or NULL if isAnswered value is false",
           "correctAnswered": "[enum] - true or false or NULL if isAnswered value is false"
        }
    }
]

Radio

Resturns the radio inforamtion

GET /radio

Resturns the radio inforamtion

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "title": "[string] - radio title",
    "song: "[string] - name of current song",
    "path": "[string] - path to radio audio file"
}

StarDashboard

Dashboard information for star home screen

GET /star/dashboard

Dashboard information for star home screen

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
    "default": { (object as first item (schlager.de) in the view)
        "id": 1,
        "name": "ZUR SCHLAGER.DE-APP",
        "image": "https://media.schlager.de/star/Schlager.png"
    },
    "defaultTitle": "Ich liebe alle Schlagerstars", (Title of the first item)
    "starTitle": "Ich möchte in die Fanwelt von:", (Title above the stars items)
    "info": { (object for info content in the popup)
        "title": "Was ist die Fanwelt?",
        "content": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt. Ut enim ad minim veniam, quis nostrud exercitation ullamco lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et. dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem."
    },
    "poll": {
        "type": "poll",
        "isActive": true,
        "title": "TITLE",
        "url": "URL TO LOAD IN THE INAPP BROWSER"
    }
}

User

Handles the user data. It returns, updates and deletes all information regarding the user

GET /user

Fields

Field	Type	Description	Required
company	string	the users company	NO
firstname	string	the users firstname	NO
lastname	string	the users lastname	NO
birthday	date [YYYY-mm-dd]	the users birthday	NO
mobile	string	users mobile number	NO
street	string	users street	NO
zipcode	string	users postal zipcode	NO
city	string	users city	NO
country	string	users country	NO
image	file	users profile image	NO
email	string	users email address	NO
fanOf	int	star ID which the user is fan of	NO
gender	char	users gender [f,m,o]	NO
advertising	boolean [true, false]	users consent for advertising	NO
telephone	string	the users telephone number	NO
star		the star ID from the star which the user choose at the home screen	NO
pushNotificationToken	string	users push notification token	NO
osSystem	String	the users OS System [iOS, Android, Web]	NO
pushNotification	boolean	users push notification token	NO

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "company": "the users company",
   "firstname": "the users firstname",
   "lastname": "the users lastname",
   "birthday": "the users birthday",
   "mobile": "users mobile number",
   "street": "users street",
   "zipcode": "users postal zipcode",
   "city": "users city",
   "country": "users country",
   "advertising": "users consent for advertising",
   "pushNotification": "users consent to push notifications",
   "image": "users profile image",
   "email": "users email address",
   "fanOf": "star ID which the user is fan of",
   "gender": "users gender [f,m,o]"
}

PUT /user

Fields

Field	Type	Description	Required
company	string	the users company	NO
firstname	string	the users firstname	NO
lastname	string	the users lastname	NO
birthday	date [YYYY-mm-dd]	the users birthday	NO
mobile	string	users mobile number	NO
street	string	users street	NO
zipcode	string	users postal zipcode	NO
city	string	users city	NO
country	string	users country	NO
image	file	users profile image	NO
email	string	users email address	NO
fanOf	int	star ID which the user is fan of	NO
gender	char	users gender [f,m,o]	NO
advertising	boolean [true, false]	users consent for advertising	NO
telephone	string	the users telephone number	NO
star		the star ID from the star which the user choose at the home screen	NO
pushNotificationToken	string	users push notification token	NO
osSystem	String	the users OS System [iOS, Android, Web]	NO
pushNotification	boolean	users push notification token	NO

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json
Content-Type	application/vnd.schlager.v1+json application/json multipart/form-data
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "company": "the users company",
   "firstname": "the users firstname",
   "lastname": "the users lastname",
   "birthday": "the users birthday",
   "mobile": "users mobile number",
   "street": "users street",
   "zipcode": "users postal zipcode",
   "city": "users city",
   "country": "users country",
   "image": "users profile image",
   "email": "users email address",
   "fanOf": "star ID which the user is fan of",
   "gender": "users gender [f,m,o]",
   "advertising": "users consent for advertising",
   "telephone": "the users telephone number",
   "star": "the star ID from the star which the user choose at the home screen",
   "pushNotificationToken": "users push notification token",
   "osSystem": "the users OS System [iOS, Android, Web]",
   "pushNotification": "users push notification token"
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Body

DELETE /user

deletes the user account

Fields

Field	Type	Description	Required
company	string	the users company	NO
firstname	string	the users firstname	NO
lastname	string	the users lastname	NO
birthday	date [YYYY-mm-dd]	the users birthday	NO
mobile	string	users mobile number	NO
street	string	users street	NO
zipcode	string	users postal zipcode	NO
city	string	users city	NO
country	string	users country	NO
image	file	users profile image	NO
email	string	users email address	NO
fanOf	int	star ID which the user is fan of	NO
gender	char	users gender [f,m,o]	NO
advertising	boolean [true, false]	users consent for advertising	NO
telephone	string	the users telephone number	NO
star		the star ID from the star which the user choose at the home screen	NO
pushNotificationToken	string	users push notification token	NO
osSystem	String	the users OS System [iOS, Android, Web]	NO
pushNotification	boolean	users push notification token	NO

Request

Headers

Header	Value
Accept	application/vnd.schlager.v1+json application/json application/*+json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
204: No Content
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.schlager.v1+json application/json application/*+json
Allow	Comma-separated list of all HTTP methods allowed

Documentation

Schlager (v1)

Reward

GET /reward

Request

Headers

Response

Status Codes

Headers

Body

GET /reward[/:reward_id]

Request

Headers

Response

Status Codes

Headers

Body

Star

GET /star[/:star_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

POST /star[/:star_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

CampaignAd

POST /campaign/ad

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

CampaignCode

POST /campaign/code

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

Contest

POST /contest/jackpot200k

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

GET /contest/jackpot200k

Fields

Request

Headers

Response

Status Codes

Headers

Body

FriendsGetFriends

GET /campaign/friends-get-friends/code

Request

Headers

Response

Status Codes

Headers