Submit Comment or Checkin

POST/comment

Submit a user comment or checkin for a specific charging location

Body ParametersJSONExpand Collapse

chargePointID: number

This must be a valid POI ID

checkinStatusTypeID: optional number

Optional valid CheckStatusTypeID to indicate overall catgeory and success/failure to use equipment e.g. 10 = Charged Successfully.

comment: optional string

This is an optional comment to describe the charging experience, may include guidance for future users.

minLength1

maxLength4000

commentTypeID: optional number

This must be a valid Comment Type ID as per UserCommentTypes found in Core Reference Data. If left as null then General Comment will be used.

rating: optional number

Optional integer rating between 1 = Worst, 5 = Best.

relatedURL: optional string

Optional website URL for related information

minLength1

maxLength500

userName: optional string

This is an optional name to associate with the submission, for authenticated users their profile username is used.

minLength1

maxLength100

ReturnsExpand Collapse

description: string

minLength1

status: string

minLength1

Submit Comment or Checkin

curl https://api.openchargemap.io/v3/comment \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OCM_USERNAME" \
    -d '{
          "chargePointID": 0,
          "rating": 3
        }'

{
  "status": "OK",
  "description": "OK"
}

Returns Examples

{
  "status": "OK",
  "description": "OK"
}