Create a new station review

To improve the user experience of routes you can include reviews as described in query station reviews. To collect reviews and allow users to write one, you will need to use the following mutation.

Mutation

To be able to write a review you will need a stationId and carId. After that you can use various review arguments like rating, message and tags to collect the appropriate data. Keep in mind, the stationId and rating are both required when submitting a review.

Arguments

  • review non_null ReviewAdd
    Required
  • Other fields

  • id non_null

    ID of a review

  • station object Station

    Station for which a review was provided

  • user object ReviewUser

    User who added a review. If a review was added by an anonymous user, this will be null

  • rating int

    Rating of a review

  • message string

    Message of a review

  • locale string

    Locale of a message

  • ev object Car

    Car that was provided/selected by a user

  • plugType enum OCPIConnectorType

    Plug type that was provided/selected by a user

  • properties json

    Optional object where you can store custom data you need in your application. This extends the current functionalities we offer

  • tags object ReviewTags

    Boolean tags for a station review

  • createdAt string

    Date and time when a review was created

  • updatedAt string

    Date and time when a review was updated

  • Response

    If successful, the HTTP status code in the response header is 200 and the response body contains the attributes you requested.

    If unsuccessful, the header status code is an error code and the response body contains an error response object. The error response object can be any of the ones below.

    Errors & warnings

    • Error
      CAR_NOT_FOUND

      No car was found with the provided ID

    • Error
      MISSING_REQUIRED_PARAMETERS

      Missing required parameter(s): $PARAMETERS

    • Error
      REVIEW_MESSAGE_LENGTH_EXCEEDED

      The message provided is too long. The maximum number of characters is 10000

    • Error
      REVIEW_RATING_NOT_IN_RANGE

      The rating provided is not valid. The value must be between 0 and 5