API Documentation

• User
  • postSign In
  • postSign Up
  • postValidate User Token
  • getGet User Info
  • putUpdate User
  • delDelete User
  • putUpdate Step Count
  • getCheck Step Count
  • putUpdate User's Step Goal
  • getCheck User's Step Goal
  • getReset Daily Step Counter for All Users
  • getReset Weekly Step Counter for All Users
  • postSet User's Birthday
• Pet
  • getGet Pet Name
  • putUpdate Pet Name
  • postCreate a New Pet
  • getGet Pet's Status
  • putUpdate Pet Status
  • putReset the Pet's Status
  • putIncrease the Pet's Mood
  • postReset the Pet's Activities
  • getGet Pet Choice
  • putUpdate Pet Choice
  • putFeed Pet
  • delDelete Pet
  • getCheck Account Activity -- Pet
• Food
  • postRecognize Food
  • postGet Food's Health Rating
  • postGet Food's Nutrition Info
  • getList All Possible Food Options
  • getGet Food's Category
• Leaderboard
  • getList User Leaderboard

API docs by Redocly

Backend Server API

Download OpenAPI specification:Download

User

User Authentication and Management

Sign In

Request Body schema: application/json

username	string
password	string

Responses

https://arpetpals.store/api/signin

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "id": 0,
• "name": "string"

}

Sign Up

Request Body schema: application/json

username	string
password	string

Responses

https://arpetpals.store/api/signup

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "id": 0,
• "name": "string",
• "dailyStepGoal": { }

}

Validate User Token

Request Body schema: application/json

token

string

Responses

https://arpetpals.store/api/token/verify

Request samples

• Payload

Content type

application/json

{

• "token": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "isValid": true

}

Get User Info

Authorizations:

None

Responses

https://arpetpals.store/api/user

Response samples

• 200
• 400

Content type

application/json

{

• "userInfo": {

  • "id": 0,
  • "name": "string"

  }

}

Update User

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

username	string User Name
password	string Password

Responses

https://arpetpals.store/api/user

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Delete User

Authorizations:

None

Responses

https://arpetpals.store/api/user

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Update Step Count

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

userId	number User ID
steps	number Step Count

Responses

https://arpetpals.store/api/user/step-count

Request samples

• Payload

Content type

application/json

{

• "userId": 0,
• "steps": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Check Step Count

Authorizations:

None

Responses

https://arpetpals.store/api/user/step-count

Response samples

• 200
• 400

Content type

application/json

{

• "dailyStepCount": 0,
• "weeklyStepCount": 0

}

Update User's Step Goal

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

dailyStepGoal

number Daily Step Goal

Responses

https://arpetpals.store/api/user/step-goal

Request samples

• Payload

Content type

application/json

{

• "dailyStepGoal": 0

}

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "message": "string"

}

Check User's Step Goal

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

userId	number User ID
steps	number User's Steps

Responses

https://arpetpals.store/api/user/check-step-goal

Request samples

• Payload

Content type

application/json

{

• "userId": 0,
• "steps": 0

}

Response samples

• 200
• 400

Content type

application/json

true

Reset Daily Step Counter for All Users

Responses

https://arpetpals.store/api/user/reset-daily-step-count

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Reset Weekly Step Counter for All Users

Responses

https://arpetpals.store/api/user/reset-weekly-step-count

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Set User's Birthday

Authorizations:

None

Request Body schema: application/json

username	string
birthday	string

Responses

https://arpetpals.store/api/user/savebirthday

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "birthday": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string",
• "userInfo": {

  • "name": "string",
  • "birthday": "string"

  }

}

Pet

Pet Interaction and Management

Get Pet Name

Authorizations:

None

Responses

https://arpetpals.store/api/pet/name

Response samples

• 200
• 400

Content type

application/json

{

• "name": "string"

}

Update Pet Name

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

name	string Updated Pet Name

Responses

https://arpetpals.store/api/pet/name

Request samples

• Payload

Content type

application/json

{

• "name": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Create a New Pet

Authorizations:

None

Responses

https://arpetpals.store/api/pet/create

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string",
• "petInfo": {

  • "id": 0,
  • "name": "string",
  • "status": {

    • "health": 0,
    • "mood": 0

    }

  }

}

Get Pet's Status

Authorizations:

None

Responses

https://arpetpals.store/api/pet/status

Response samples

• 200
• 400

Content type

application/json

{

• "health": 0,
• "mood": 0,
• "extra": {

  • "minutes_since_last_feeding": 0,
  • "minutes_since_last_activity": 0

  },
• "activities": [ ]

}

Update Pet Status

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

health	number
mood	number

Responses

https://arpetpals.store/api/pet/status

Request samples

• Payload

Content type

application/json

{

• "health": 0,
• "mood": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string",
• "health": 0,
• "mood": 0

}

Reset the Pet's Status

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

reset_type

number ENUM - 0: ALL, 1: HEALTH, 2: MOOD

Responses

https://arpetpals.store/api/pet/status/reset

Request samples

• Payload

Content type

application/json

{

• "reset_type": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Increase the Pet's Mood

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

type	string Activity Type

Responses

https://arpetpals.store/api/pet/status/increaseMood

Request samples

• Payload

Content type

application/json

{

• "type": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string",
• "mood": 0,
• "activities": [ ]

}

Reset the Pet's Activities

Run as a Cron Job.

Authorizations:

None

Responses

https://arpetpals.store/api/pet/activities/reset

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string",
• "matchedCount": 0,
• "modifiedCount": 0

}

Get Pet Choice

Authorizations:

None

Responses

https://arpetpals.store/api/pet/choice

Response samples

• 200
• 400

Content type

application/json

{

• "choice": "string"

}

Update Pet Choice

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

choice

string Choice

Responses

https://arpetpals.store/api/pet/choice

Request samples

• Payload

Content type

application/json

{

• "choice": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Feed Pet

Authorizations:

None

Request Body schema: application/json

User ID is provided in the request headers.

food	string Food

Responses

https://arpetpals.store/api/pet/feed

Request samples

• Payload

Content type

application/json

{

• "food": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Delete Pet

Authorizations:

None

Responses

https://arpetpals.store/api/pet

Response samples

• 200
• 400

Content type

application/json

{

• "message": "string"

}

Check Account Activity -- Pet

Authorizations:

None

Responses

https://arpetpals.store/api/checkAccountActivity

Response samples

• 400

Content type

application/json

{

• "message": "string"

}

Food

Food Recognition and Analytics

Recognize Food

Authorizations:

None

Responses

https://arpetpals.store/api/food/recognize

Response samples

• 200
• 400

Content type

application/json

{

• "topMatches": [ ]

}

Get Food's Health Rating

Authorizations:

None

Request Body schema: application/json

food	string Food Name

Responses

https://arpetpals.store/api/food/healthRating

Request samples

• Payload

Content type

application/json

{

• "food": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "food": "string",
• "healthRating": 0

}

Get Food's Nutrition Info

Authorizations:

None

Request Body schema: application/json

food	string Food Name

Responses

https://arpetpals.store/api/food/nutritionInfo

Request samples

• Payload

Content type

application/json

{

• "food": "string"

}

Response samples

• 200
• 400

Content type

application/json

{

• "food": "string",
• "nutritionInfo": "string"

}

List All Possible Food Options

Authorizations:

None

Responses

https://arpetpals.store/api/food/listFoodOptions

Response samples

• 200
• 400

Content type

application/json

{

• "foodOptions": [ ]

}

Get Food's Category

Authorizations:

None

Responses

https://arpetpals.store/api/food/categoryInfo

Response samples

• 200
• 400

Content type

application/json

{

• "food": "string",
• "categoryInfo": "string"

}

Leaderboard

Configuring the User Leaderboard

List User Leaderboard

Authorizations:

None

Responses

https://arpetpals.store/api/leaderboard/list

Response samples

• 200
• 400

Content type

application/json

{

• "leaderboardList": [ ],
• "top5Users": [ ]

}