Skip to content

Latest commit

 

History

History
78 lines (58 loc) · 1.65 KB

get.md

File metadata and controls

78 lines (58 loc) · 1.65 KB

Get

Get a specific submission, by ID, for a practitioner.

GET {baseUrl}/v1/practitioners/{board}/{fid}/{id}

URI Parameters

Name In Required Type Description
baseUrl path True string The API URL.
board path True string The board code or me.
fid path True string The practitioner's FID.
id path True integer The ID of the submission.

Responses

Name Type Description
200 OK Submission Success
404 Not Found Board code is missing or invalid or the submission was not found.

Security

Scopes

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

Examples

Get a Submission for a Practitioner


Get Submission for a Practitioner

Sample Request

GET {baseUrl}/v1/practitioners/me/999999949/1234

Sample Response

Status code: 200

Note: Output is elided. Refer to Submission for a complete example.

{
    "id": 1234,
    "fid": "999999940",
    "submitDate": "2019-01-04T16:13:17",
    "application": {
        "licenseType": "MD",
        "boardName": "Texas Medical Board",
        "licenseSubtypeDetails": {
          "code": "FULL",
          "description": "Permanent Medical License"
        }
    },
    "names": {
        "legalName": {
            "firstName": "Robert",
            "middleName": "More",
            "lastName": "Finaling-Final",
            "suffix": "Jr"
        }
    },
    ...
}

For more examples go to samples.