Speaking Partners Platform API
Comments

Comment

Get Comment
Retrieves a specific comment and includes student details.
GET https://api.speaking-partner.com/v1/comments/{commentId}

URL Parameters

Name Required? Description
CommentId Yes The ID of the comment.

Example Request

GET: https://api.speaking-partner.com/v1/comments/365

Example Response

{
    "CommentId":365,
    "Message":"this is a comment for a student",
    "Commenter":{
        "FirstName":"Walter",
        "LastName":"Bishop"
    }
    "CreationDate":1353089785,
    "Student":{
        "Domain":"massive",
        "Email":"examplestudent@example.com",
        "FirstName":"Jim",
        "LastName":"Barnes",
        "Locale":"en-US",
        "NativeName":null,
        "PrimaryPhone":null,
        "PublicName":"Jim Barnes",
        "SecondaryPhone":null,
        "SkypeName":null,
        "Status":"Active",
        "TimeZone":"Mountain Standard Time",
        "Username":"jim"
    }
}
Update Comment
Updates a comment.
POST https://api.speaking-partner.com/v1/comments/{commentId}

URL Parameters

Name Required? Description
CommentId Yes The ID of the comment.

Request Parameters

Name Required? Description
Message Yes The message for the comment

Example Request

POST: https://api.speaking-partner.com/v1/comments/225
message=this is an updated comment

Example Response

{
    "CommentId":365,
    "Message":"this is an updated comment",
    "Commenter":{
        "FirstName":"Walter",
        "LastName":"Bishop"
    }
    "CreationDate":1353089785,
    "Student":{
        "Domain":"massive",
        "Email":"examplestudent@example.com",
        "FirstName":"Jim",
        "LastName":"Barnes",
        "Locale":"en-US",
        "NativeName":null,
        "PrimaryPhone":null,
        "PublicName":"Jim Barnes",
        "SecondaryPhone":null,
        "SkypeName":null,
        "Status":"Active",
        "TimeZone":"Mountain Standard Time",
        "Username":"jim"
    }
}
Delete Comment
Deletes a comment.
DELETE https://api.speaking-partner.com/v1/comments/{commentId}

URL Parameters

Name Required? Description
CommentId Yes The ID of the comment.

Example Request

DELETE: https://api.speaking-partner.com/v1/comments/5