Membership rewards

The rewards that belongs to a membership.

get
Get membership rewards

https://api.petje.af/v1/memberships/:membershipId/rewards
Scope: memberships.read
Request
Response
Request
Path Parameters
membershipId
optional
string
ID of the membership
Headers
Authorization
required
string
Access token using the Bearer method
Query Parameters
limit
optional
integer
The number of rewards to return
from
optional
string
Offset the result after the reward with this ID
Response
200: OK
Cake successfully retrieved.
{
"count": 3,
"_embedded": {
"rewards": [
{
"resource": "rewards",
"id": "i3DMlxfiU7bzqLtYmFUS",
"name": "Sticker",
"description": "Schitterende sticker!",
"active": true,
"user": {},
"type": "parcel",
"_links": {
"self": {
"href": "https://api.petje.af/memberships/HVogpphHSabylpg2gBYL/rewards/i3DMlxfiU7bzqLtYmFUS",
"type": "application/hal+json"
},
"membership": {
"href": "https://api.petje.af/memberships/HVogpphHSabylpg2gBYL",
"type": "application/hal+json"
}
}
},
...
]
},
"_links": {
"self": {
"href": "https://api.petje.af/rewards",
"type": "application/hal+json"
},
"next": null
}
}

get
Get membership reward detail

https://api.petje.af/v1/memberships/:membershipId/rewards/:id
Scope: memberships.read
Request
Response
Request
Path Parameters
id
optional
string
ID of the membership reward
membershipId
optional
string
ID of the membership
Headers
Authorization
required
string
Access token using the Bearer method
Response
200: OK
{
"resource": "rewards",
"id": "i3DMlxfiU7bzqLtYmFUS",
"name": "Sticker",
"description": "Schitterende sticker!",
"active": true,
"user": {},
"type": "parcel",
"_links": {
"self": {
"href": "https://api.petje.af/memberships/HVogpphHSabylpg2gBYL/rewards/i3DMlxfiU7bzqLtYmFUS",
"type": "application/hal+json"
},
"membership": {
"href": "https://api.petje.af/memberships/HVogpphHSabylpg2gBYL",
"type": "application/hal+json"
}
}
}
404: Not Found
{
"status": 404,
"title": "Not Found",
"detail": "Membership Reward is not found",
"_links": {
"documentation": {
"href": "https://docs.petje.af",
"type": "text/html"
}
}
}