StarMeUp OS

StarMeUp

Operations

We expose the following operations listed below:

Organization Values

Send Stars

Send a Star to a user and attach a comment to it.

Resource URL

POST: /starmeup/public-api/v1/stars

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

from

Required

Refers to the sender’s identification of the Star.

to

Required

Refers to the receiver’s identification of the Star.

valueId

Required

Identification of the type of the Star.

comment

Required

Text attached as a comment to the Star.

Request

Example: 

  {
    "from": {
      "identification": "john.doe@qastarmeup.com"
    },
    "to": {
      "identification": "jane.doe@qastarmeup.com"
    },
    "valueId": 14,
    "comment": "Well done"
  }

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": 1595393
  }

Find Stars

Returns a list of all Stars associated with a specific Community.

Resource URL

GET: /starmeup/public-api/v1/stars/values

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "id": 13579,
        "name": "Doe's Company",
        "description": "Community of the Doe's Family.",
        "enabled": true,
        "editable": true,
        "imageId": 2,
        "imageCode": "kihsnlfzpozkgizcckij_png",
        "nameShowed": "Doe's Company",
        "descriptionShowed": "Community of the Doe's Family.",
        "backgroundColor": "#90f819",
        "valuesLang": [
          {
            "id": 135,
            "valueId": 13579,
            "nameShowed": "You Rock",
            "descriptionShowed": "Star for highlighting someone's personality.",
            "language": {
              "id": 2,
              "code": "es",
              "name": "Spanish",
              "nameShowed": "Spanish"
            }
          },
          {
            "id": 246,
            "valueId": 13579,
            "nameShowed": "Nice Job",
            "descriptionShowed": "Star for highlighting someone's good job.",
            "language": {
              "id": 1,
              "code": "en",
              "name": "English",
              "nameShowed": "English"
            }
          },
          {
            "id": 468,
            "valueId": 13579,
            "nameShowed": "Good Mate",
            "descriptionShowed": "Star for highlighting someone's partnership.",
            "language": {
              "id": 9,
              "code": "pt-PT",
              "name": "Portuguese-PT",
              "nameShowed": "Portuguese-PT"
            }
          },
          {
            "id": 579,
            "valueId": 13579,
            "nameShowed": "Committed",
            "descriptionShowed": "Star for highlighting someone's commitment.",
            "language": {
              "id": 8,
              "code": "pl",
              "name": "Polish",
              "nameShowed": "Polish"
            }
          },
          {
            "id": 680,
            "valueId": 13579,
            "nameShowed": "You Did It",
            "descriptionShowed": "Star for highlighting someone's good results.",
            "language": {
              "id": 3,
              "code": "pt",
              "name": "Portuguese-BR",
              "nameShowed": "Portuguese-BR"
            }
          }
        ],
        "language": {
          "id": 1,
          "code": "en",
          "name": "English",
          "nameShowed": "English"
        }
      }
    ]
  }

Send Kudos

Send a Kudo to a group of users and attach a comment to it.

Resource URL

POST: /starmeup/public-api/v1/kudos

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

from

Required

Refers to the sender’s identification of the Kudo.

to

Required

Refers to the receivers' identifications (at least two) of the Kudo.

valueId

Required

Identification of the type of the Star.

comment

Required

Text attached as comment to the Star.

Request

Example: 

  {
    "from": {
      "identification": "jane.doe@qastarmeup.com"
    },
    "to": [
      { "identification": "john.doe@qastarmeup.com" },
      { "identification": "peter.doe@qastarmeup.com" }
    ],
    "valueId": 4018656,
    "comment": "Well done"
  }

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": 1595393
  }

Find Kudos

Returns a list of all Kudos associated with a specific Community.

Resource URL

GET: /starmeup/public-api/v1/kudos/values

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "id": 13579,
        "name": "Doe's Company",
        "description": "Community of the Do's Family.",
        "enabled": true,
        "editable": true,
        "imageId": 2,
        "imageCode": "kihsnlfzpozkgizcckij_png",
        "nameShowed": "Doe's Company",
        "descriptionShowed": "Community of the Doe's Family.",
        "backgroundColor": "#90f819",
        "valuesLang": [
          {
            "id": 135,
            "valueId": 13579,
            "nameShowed": "Great Team Work",
            "descriptionShowed": "Congratulations for doing this right.",
            "language": {
              "id": 2,
              "code": "es",
              "name": "Spanish",
              "nameShowed": "Spanish"
            }
          },
          {
            "id": 246,
            "valueId": 13579,
            "nameShowed": "Nice Product Release",
            "descriptionShowed": "We finally did this... We finally are in Production Environment.",
            "language": {
              "id": 1,
              "code": "en",
              "name": "English",
              "nameShowed": "English"
            }
          },
          {
            "id": 468,
            "valueId": 13579,
            "nameShowed": "Nice Soccer Match",
            "descriptionShowed": "We won, we won, we won...",
            "language": {
              "id": 9,
              "code": "pt-PT",
              "name": "Portuguese-PT",
              "nameShowed": "Portuguese-PT"
            }
          },
          {
            "id": 579,
            "valueId": 13579,
            "nameShowed": "Thanks for being here",
            "descriptionShowed": "I really want to thank you guys for everything you have done for me in this team.",
            "language": {
              "id": 8,
              "code": "pl",
              "name": "Polish",
              "nameShowed": "Polish"
            }
          },
          {
            "id": 680,
            "valueId": 13579,
            "nameShowed": "Very nice meeting",
            "descriptionShowed": "We have defined a lot of things for this release.",
            "language": {
              "id": 3,
              "code": "pt",
              "name": "Portuguese-BR",
              "nameShowed": "Portuguese-BR"
            }
          }
        ],
        "language": {
          "id": 1,
          "code": "en",
          "name": "English",
          "nameShowed": "English"
        }
      }
    ]
  }

Customer Mode

Send CM Stars

Send a Customer Mode Star to a user and attach a comment to it.

Customer Mode has to be set with the value: true.

Resource URL

POST: /starmeup/public-api/v1/stars

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

from

Required

Refers to the sender’s identification of the Star. If the parameter is not sent or it is null, then the body field named as firstName is required.

isCustomerMode

Required

Enables the Customer Mode setting the value as true.

to

Required

Refers to the receiver’s identification of the Star.

valueId

Required

Identification of the type of the Star.

comment

Required

Text attached as a comment to the Star.

Request

Example: 

  {
    "from": {
      "identification": "john.doe@qastarmeup.com",
      "firstName": "John",
      "lastName": "Doe",
      "isCustomerMode": true
    },
    "to": {
      "identification": "jane.doe@qastarmeup.com"
    },
    "valueId": 25,
    "comment": "Well done"
  }

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": 1595393
  }

Send CM Kudos

Send a Customer Mode Kudo to a group of users and attach a comment to it.

Customer Mode has to be set with the value: true.

Resource URL

POST: /starmeup/public-api/v1/kudos

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Body Parameters

Parameter Optional/Required Description

from

Required

Refers to the sender’s identification of the Kudo. If the parameter is not sent or it is null, then the body field named as firstName is required.

isCustomerMode

Required

Enables the Customer Mode setting the value as true.

to

Required

Refers to the receivers' identifications (at least two) of the Kudo.

valueId

Required

Identification of the type of the Star.

comment

Required

Text attached as comment to the Star.

Request

Example: 

  {
    "from": {
      "identification": "jane.doe@qastarmeup.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "isCustomerMode": true
    },
    "to": [
      { "identification": "john.doe@qastarmeup.com" },
      { "identification": "peter.doe@qastarmeup.com" }
    ],
    "valueId": 4053744,
    "comment": "Well done"
  }

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": 1595393
  }

Leaderboard

Returns a list of the current StarMeUp user profiles that are leading the top of Star Sender or Star Receiver leaderboard.

Resource URL

GET: /starmeup/public-api/v1/leaderboard

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

URL Parameters

Parameter Optional/Required Description

type

Required

String value that defines which kind of Leaderboard is wanted. For Top Receivers the value is "RECEIVER"; for Top Senders the value is "SENDER".

size

Optional

Integer value that represents the size of 'n' first wanted records in the Leaderboard list. Default 3 records.

from

Required

String that represents the initial day to query in the Leaderboard. The format is: "YYYY-MM-DD".

to

Required

String that represents the final day to query in the Leaderboard. The format is: "YYYY-MM-DD".

valueId

Optional

Integer value corresponding to the id of the organization value.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": [
      {
        "firstName": "John",
        "lastName": "Doe",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "profileUrl": "https://qa.starmeup.com/profile/40fy24b284c69f48z59da91fe658c8ed",
        "position": 1,
        "starsCount": 8
      },
      {
        "firstName": "Jane",
        "lastName": "Doe",
        "profileImage": {
          "code": "zwlerlxnyjquznxboagx_png",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/zwlerlxnyjquznxboagx_png/80/80/1"
        },
        "profileUrl": "https://qa.starmeup.com/profile/840f24be284669f4a85da91fe65u88ed",
        "position": 2,
        "starsCount": 7
      },
      {
        "firstName": "Peter",
        "lastName": "Doe",
        "profileImage": {
          "code": "tdstjgeoqowriusiqhow_jpg",
          "baseUrl": "https://qa.starmeup.com/starmeup-api/v2/image/",
          "suggestedUrl": "https://qa.starmeup.com/starmeup-api/v2/image/tdstjgeoqowriusiqhow_jpg/80/80/1"
        },
        "profileUrl": "https://qa.starmeup.com/profile/65a840f24b28469f485da91fze6588ed",
        "position": 3,
        "starsCount": 5
      }
    ]
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "There was an unexpected error.",
    "type": "uri=/starmeup/public-api/v1/leaderboard",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Remaining Stars

Returns the amount of Stars that the User could send in the current period.

Resource URL

GET: /starmeup/public-api/v1/users/{identification}/stars

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Path Parameters

Parameter Optional/Required Description

identification

Required

String value that defines the unique identification of the user.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": 123
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "For input string: \"john.doe@qastarmeup.com\"",
    "type": "uri=/starmeup/public-api/v1/users/john.doe@qastarmeup.com/stars",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Interactions Stars Summary

Returns the amount of Sent Stars, Received Stars and Remaining Stars since a User has been activated in the organization.

Resource URL

GET: /starmeup/public-api/v1/communities/users/{identification}/interactions/stars/summary

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

Path Parameters

Parameter Optional/Required Description

identification

Required

String value that defines the unique identification of the user.

Response

HTTP/1.1 200 OK

Example: 

  {
    "result": {
      "sentStars": 29,
      "receivedStars": 50,
      "remainingStars": 15
    }
  }

Errors

HTTP/1.1 400 Bad Request, HTTP/1.1 403 Forbidden, 406 Not Acceptable

Example: 

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "For input string: \"john.doe@qastarmeup.com\"",
    "type": "uri=/starmeup/public-api/v1/users/john.doe@qastarmeup.com/stars",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

HTTP/1.1 401 Unauthorized

Example: 

  {
      "title": "Unauthorized",
      "detail": "No token found in the request scope. Maybe it is missing from headers."
  }
  {
      "title": "Unauthorized",
      "detail": "Invalid JWT signature"
  }

HTTP/1.1 404 Not Found

Example: 

  {
      "timestamp": "2021-01-20",
      "message": "Resource not found",
      "details": "Member [john.doe@qastarmeup.com] doesn't exist or it is disabled",
      "type": "uri=/starmeup/public-api/v1/users/john.doe@qastarmeup.com/stars/summary",
  }

HTTP/1.1 500 Internal Server Error

Example: 

  {
      "timestamp": "2021-01-20",
      "message": "Internal Server Error",
      "details": "Finding Stars Summary was not successfully.",
      "type": "uri=/starmeup/public-api/v1/users/john.doe@qastarmeup.com/stars/summary",
  }

Congratulations

Returns a list of organization congratulations filter by different parameters.

Resource URL

GET: /starmeup/public-api/v1/community/members/congratulations

Header Parameters

Parameter Optional/Required Description

Authorization

Required

Community Token (You can get information on Authentication).

URL Parameters

Parameter Optional/Required Description

type

Required

String value can be birthday or anniversary.

month

Required

Int value month.

day

Required

Int value day.

page

Optional

Page to find the records. It starts at 0. Default 0.

size

Optional

The amount of records wanted to be returned in the page. Default 10.

application

Optional

Field name used for filter by application. Default value is SMU".

Response

HTTP/1.1 200 OK

Example: 

  {
      "result": [
          {
              "id": 1134080,
              "email": "Jeremy.Maynard@automation-qa",
              "firstName": "Jeremy",
              "lastName": "Maynard",
              "fullName": "Jeremy Maynard",
              "identification": "",
              "profileImageCode": "jetayhulnmfrrsgwyzhk",
              "officeName": "",
              "uid": "871724899e16ef3b4bb3d2eb2e07a58f",
              "enabled": true
          }
      ],
      "page": {
          "totalElements": 1
      }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Back to index