get-summary.md

Get Summary

Get a summary of the submissions.

GET {baseUrl}/v1/submissions/{board}/summary

With optional parameters.

GET {baseUrl}/v1/submissions/{board}/summary?fid={fid}&fromDate={fromDate}&toDate={toDate}

URI Parameters

Name	In	Required	Type	Description
baseUrl	path	True	string	The API URL.
board	path	True	string	The board code or me.
fid	query	False	string	The optional FID of the practitioner to filter by.
fromDate	query	False	DateTime (format: yyyy-mm-dd)	The optional start date for submissions.
toDate	query	False	DateTime (format: yyyy-mm-dd)	The optional end date for submissions.

This resource supports paging and sorting. The following fields can be ordered.

• Fid
• Id
• SubmitDate

Note: If there are many submissions then the results will be paged.

Responses

Name	Type	Description
200 OK	SubmissionSummary[]	Success
204 No Content		No submissions found
404 Not Found		Board code is missing or invalid

Security

Scopes

Scope	Description
ua.read	Grants the ability to read UA information.

Examples

Get Summary Of Submissions For One Day

---

Get Summary Of Submissions For One Day

Get a summary of the submissions for 4 Jan 2019.

Sample Request

GET {baseUrl}/v1/submissions/me/summary?fromDate=01/04/2019&toDate=01/05/2019

Sample Response

Status code: 200

[
    {
        "id": 123,
        "fid": "999999956",
        "name": {
            "firstName": "Jess",
            "middleName": "Chris",
            "lastName": "Samphone",
            "suffix": ""
        },
        "submitDate": "2018-01-23T16:13:17.98"
    },
    {
        "id": 789,
        "fid": "999999915",
        "name": {
            "firstName": "Philip",
            "middleName": "James",
            "lastName": "Testman",
            "suffix": ""
        },
        "submitDate": "2018-01-04T11:02:58.587"
    }
]

For more examples go to samples.