Forms

Types

The Form object

Field Type Description
FormId int Unique id generated by NBS
FormTitle string
FormArea string Describes what area in NBS the form can be used.

“IndividualRecord”, “QualityImprovement”, “EducationRecord”, “EmployeeHealth”, “FormsOnly”

Endpoints

Get Form List

Authorization needed

Request
GET https://api.ninthbrain.com/Form/GetList?api-version=2.0
Example response
HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
[
    {
        "FormId": 123,
        "FormTitle": "Demo Form A",
        "FormArea": "Individual Record"
    },
    {
        "FormId": 1234,
        "FormTitle": "Demo Form B",
        "FormArea": "Forms Only"
    }
]
Errors
  • bad_request (HTTP 400)
  • unauthorized (HTTP 401) - This APIKey is not valid for this service.
  • internal_error (HTTP 500)