Retrieve Staff Details (Transactional)

Overview

This endpoint retrieves information about an individual staff member stored on the Medicus tenant.

Making a Request

HTTP method: GET

URL: https://{{medicusTenant}}.{{medicusBaseURL}}/transactional-api/v1/staff/details/{{staffId}}

Request Headers

Header	Value	Description
`Authorization`	`Bearer [token]`	The JWT token provided by the Consumer

URL Parameters

Parameter

Description

Validation Rules

staffId

The Medicus Staff ID

e.g. cfe96780-ccdc-4256-a372-df034ebe878b

Mandatory

UUID

Example Request

JSON

GET /transactional-api/v1/staff/details/d031bae7-28d9-11eb-adc1-a5e678b1cd43
Authorization: Bearer [token]

Response Details

Specific Response Codes

HTTP Code	Error Code	Detail
`200`		Successful retrieval
`404`	`STAFF_NOT_FOUND`	A member of staff with this ID could not be found.

Properties

Field	Type	Description
`name`	string	The name of the staff member. Object structure: JSON `{ "prefix": "Dr", "givenName": "Laura", "middleNames": "Ashley", "familyName": "Lincoln", "suffix": "MD" }`
`gmcReferenceNumber`	string (optional)	If set, this references the staff member’s GMC Number.
`nmcRegistrationPin`	string (optional)	If set, this references the staff member’s NMC PIN.
`gphcRegistrationNumber`	string (optional)	If set, this references the staff member’s GPhC Registration Number.
`hcpcRegistrationNumber`	string (optional)	If set, this references the staff member’s HCPC Number.

Example Responses

Example Response (Association Exists Error):

JSON

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "errors": [
    {
      "code": "STAFF_NOT_FOUND",
      "title": "Staff Member Not Found",
      "detail": "A member of staff with this ID could not be found."
    }
  ]

Example Response (Successful Retrieval)

JSON

{
    "name": {
        "prefix": "Dr",
        "givenName": "Ashley",
        "middleNames": "Natasha",
        "familyName": "Palmer",
        "suffix": "MD"
    },
    "gmcReferenceNumber": "7556756"
}