Requests & Response Examples - HomeCEU/certificate-manager GitHub Wiki

POST Certificate Request / Queued Message

{
    "course": {
        "name": "course-name",
        "hours": 4.5,
        "format": "live/webinar/text",
        "author": {
            "summary": "Author 1; Author 2; Author 3"
        }
    },
    "student": {
        "first_name": "First",
        "last_name": "Last",
        "licenses": [
            {
                "state": "TX",
                "type": "PT",
                "number": "PT-12345"
            },
            {
                "state": "FL",
                "type": "SLP",
                "number": "SLP-55423"
            }
        ]
    },
    "approvals": {
        "pt": [
            {
                "state": "TX",
                "category": "category",
                "status": "status",
                "code": "code",
                "statement": "statement",
                "hours": 4.5
            },
            {
                "state": "FL",
                "category": "category",
                "status": "status",
                "code": "code",
                "statement": "statement",
                "hours": 4
            }
        ],
        "ot-cota": {
            "code": "code",
            "status": "status",
            "statement": "statement",
            "category": "category",
            "hours": 3.5
        },
        "slp": {
            "code": "code",
            "status": "status",
            "statement": "statement",
            "category": "category",
            "hours": 1
        },
        "atc": {
            "code": "code",
            "status": "status",
            "statement": "statement",
            "category": "category",
            "hours": 1,
            "category_statement": "Evidence Based Category"
        }
    },
    "completion_method": "none/Inservice/On-site Training/Counseling/Remediation",
    "completion_date": "2019-04-18"
}

Success Response

  {
    "status": "201",
    "id": "5c15efb2-6d58-4619-a4fa-e09264ddb819",
    "message": "certificate created successfully",
    "path": "/certificate/view/5c15efb2-6d58-4619-a4fa-e09264ddb819"
  }

Fail Response

  {
    "status": 400,
    "type": "templateCompilation",
    "error": 215, 
    "message": "there was a problem processing your request",
    "trace_id": "84ce5c56-400a-45ae-9b9b-e3b6ab7b9132",
    "timestamp": "2019-09-16T22:14:45.624+0000",
    "path": "/certificate/create"
  }

Note: These responses are only for the API endpoints. Any requests being made via queue or message service will not receive a response, for obvious reasons. The request message should look the same if it's an API request or a queued message.