List

Resource: /api/v2/certifications

HTTPS Request Method: GET

Description: A list of certifications that match the specified parameters. If no optional parameters are specified, the full list of certifications associated with the account is returned.

Results are limited to 5000 records.

Required Parameters:

  • api_key

Optional Parameters:

The following optional parameters must be within the certification key:

  • active (boolean)
  • name (string)
  • description (text, limited to 500 characters)
  • expiry_period (integer)

Dates and datetimes should be in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format and can be given as ranges if separated by a comma.

Note: String parameters are limited to 255 characters.

Example Requests and Responses:

Simple Request:

curl "https://academy.exceedlms-staging.com/api/v2/certifications?api_key=123&per_page=1" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json'

Response:

[
  {
    "id": 6,
    "name": "Completion Degree",
    "active": true,
    "description": "This degree is awarded for successfully completing all 4 lessons.",
    "expiry_period": 12,
    "certification_type": null,
    "celebration_type": "Confetti"
  }
]



Request with Optional Parameters:

curl "https://academy.exceedlms-staging.com/api/v2/certifications?api_key=123&per_page=1&certification%5Bexpiry_period%5D=24" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json'

Response:

[
  {
    "id": 205,
    "name": "Sales Certification",
    "active": true,
    "description": "You know how to sell.",
    "expiry_period": 24,
    "certification_type": "Certifications",
    "celebration_type": "Fireworks"
  }
]



Read

Resource: /api/v2/certifications/id_of_resource

HTTPS Request Method: GET

Description: A single certification that matches the id passed in.

Required Parameters:

  • api_key
  • id of certification

Example Request:

curl "https://academy.exceedlms-staging.com/api/v2/certifications/6?api_key=123" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json'

Response:

{
  "id": 6,
  "name": "Completion Degree",
  "active": true,
  "description": "This degree is awarded for successfully completing all 4 lessons.",
  "expiry_period": 12,
  "certification_type": null,
  "celebration_type": "Confetti"
}



Create

Resource: /api/v2/certifications

HTTPS Request Method: POST

Description: Creates a new certification object.

Required Parameters:

  • api_key
  • Either course[code] or course[id

Optional Parameters:

The following optional parameters must be within the certification key:

  • active (boolean)
  • name (string)
  • description (text, limited to 500 characters)
  • expiry_period (integer, representing months)
  • certification_type (string)
  • celebration_type (string, possible values: None, Confetti, Fireworks)

Note: String parameters are limited to 255 characters.

Example Request:

curl -X "POST" "https://academy.exceedlms-staging.com/api/v2/certifications" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -d $'{
  "api_key": "123",
  "certification": {
    "celebration_type": "Fireworks",
    "active": "true",
    "certification_type": "My first type",
    "name": "Test Certification",
    "description": "My description",
    "expiry_period": "6"
  },
  "course": {
    "id": "11935"
  }
}'

Response:

{
  "id": 2199,
  "name": "Test Certification",
  "active": true,
  "description": "My description",
  "expiry_period": 6,
  "certification_type": "My first type",
  "celebration_type": "Fireworks",
  "course": {
    "id": 11935,
    "name": "Test Post for API"
  }
}



Update

Resource: /api/v2/certifications/id_of_resource

HTTPS Request Method: PATCH or PUT

Description: Updates a certification object.

Required Parameters:

  • api_key
  • id of certification

Optional Parameters:

The following optional parameters must be within the certification key:

  • active (boolean)
  • name (string)
  • description (text, limited to 500 characters)
  • expiry_period (integer, representing months)
  • certification_type (string)
  • celebration_type (string, possible values: None, Confetti, Fireworks)

Note: String parameters are limited to 255 characters.

Example Request:

curl -X "PUT" "https://academy.exceedlms-staging.com/api/v2/certifications/2199" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -d $'{
  "api_key": "123",
  "certification": {
    "celebration_type": "Confetti",
    "expiry_period": "12",
    "description": "Another description"
  }
}'

Response:

{
  "id": 2199,
  "name": "Test Certification",
  "active": true,
  "description": "Another description",
  "expiry_period": 12,
  "certification_type": "My first type",
  "celebration_type": "Confetti",
  "course": {
    "id": 11935,
    "name": "Test Post for API"
  }
}



Delete

Resource: /api/v2/certifications/id_of_resource

HTTPS Request Method: DELETE

Description: Destroys a certification object.

Required Parameters:

  • api_key
  • id of resource

WARNING: Deleting this object will also destroy all related:

  • user_certifications

Example Request:

curl -X "DELETE" "https://academy.exceedlms-staging.com/api/v2/certifications/2199" \
     -H 'Content-Type: application/json' \
     -H 'Accept: application/json' \
     -d $'{
  "api_key": "123"
}'

Response:

{
  "id": 2199,
  "name": "Test Certification",
  "active": true,
  "description": "Another description",
  "expiry_period": 12,
  "certification_type": "My first type",
  "celebration_type": "Confetti",
  "course": {
    "id": 11935,
    "name": "Test Post for API"
  }
}