Back to top NameCoach Integration API v4 Back to top

NameCoach Integration API v5

NameCoach API v5 Root

https://www.name-coach.com/api/private/v5

Participants

This section describes the ways to retrieve participants.

A Participant object has the following attributes:

  • first_name (string)

  • last_name (string)

  • email (string)

  • recording_url (string) - The participant’s name recording URL

  • event_title (string)

  • event_access_code (string) - The Access Code you may use as an identifier

  • institution_id (string) - The participant’s internal school ID

  • photo (string) - The particiapant’s photo URL (if present)

  • name_badge_link (string) - The link to a NameBadge containing the audio name recording and other cultural information about this individual

  • custom_objects (object) - A key-value pairs of the participant’s custom attributes

    • Key: honorific (string) Field name
    • Value: Mr. (string) The participant’s value for a custom field
  • embed_image (string) An image HTML code which plays the participant’s recording when clicked.

  • embed_iframe (string) An iframe HTML code which results in player button for the participant’s recording.

User latest participant

Retrieve User Latest Participant
GET/participants/latest

Example (cURL)

curl -X GET \
      https://www.name-coach.com/api/private/v5/participants/latest \
      -H 'accept: application/json' \
      -H 'authorization: FjQB7vXvsPK_Ur6swRk7'

Example URI

GET /participants/latest
URI Parameters
HideShow
tokens
array[String] (required) Example: [`[email protected]`]

The user identifier. An email or uid can be used.

include
string (optional) Example: embeddables,custom_attributes

A comma separated set of resources to include into the response.

Choices: custom_attributes

icon_code
number (optional) 

An icon image code for embeddable resource

Choises: 0 for Image, 1 for Image, 3 for Image

play_button_img_url
string (optional) 

An image url for embeddable resource

Request
HideShow
Headers
Accept: application/json
Authorization: Authorization Token
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "participants": [
    {
      "first_name": "Karla",
      "last_name": "Gleichauf",
      "email": "[email protected]",
      "recording_link": "https://namewaves.s3.amazonaws.com/19.mp3?digest=fc6cf60196071e6763ee7e9d9f943acc",
      "recording_date": "2018-10-11T04:09:04.718-07:00",
      "custom_objects_recorded_date": "2018-10-11T04:13:38.593-07:00",
      "event_title": "Example Api Event",
      "event_slug": "example-api-event",
      "event_access_code": "3A0CB",
      "institution_id": null,
      "photo": "https://www.name-coach.com/images/photo-blank.gif",
      "name_badge_link": "https://www.name-coach.com/karlagleichauf"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not Authorized"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not Found"
}

Moodle Courses

This section describes endpoints for working with Moodle Instances.

Synchronize Moodle Course

Synchronize Moodle Course
POST/lti/moodle/courses/synchronize

Example (cURL)

curl -X POST \
      'https://www.name-coach.com/api/private/v5/lti/moodle/courses/synchronize' \
      -H 'accept: application/json' \
      -H 'authorization: auth_token' \
      -H 'content-type: application/json' \
      -d '{
         "api_token": "tool_api_token",
         "external_course_ids": [0]
       }'

Example URI

POST /lti/moodle/courses/synchronize
URI Parameters
HideShow
api_token
string (required) 
external_course_ids
array (required) 
Request
HideShow
Headers
Authorization: AccessToken
Accept: application/json
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "external_courses_ids": [
    "0",
    "1"
  ],
  "message": "Not found in Moodle"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Not Authorized"
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Tool consumer not found"
}
Response  422
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "API integration for tool consumer is disabled"
}