Netsmart Fetch providers

POSThttps://preview.ontross.com/api/integrations/netsmart/fetch-providers

input.site_id

string

required

Scheduling site whose calendar is queried, from fetch-sites.

Example

"14"

input.system

string

Which Compass NX deployment to call, live or test.

Example

"PROD"

Default

"PROD"

Accepted values

PRODUAT

auth_id

string

required

Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.

Example

"00000000-0000-4000-8000-000000000000"

providers

array

Staff calendars at that site, their ids split out.

providers[].id

string

Practitioner identifier used when requesting calendar appointments.

Example

"9876"

providers[].label

string

Display text for a selectable practitioner calendar.

Example

"Morgan, Avery"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/netsmart/fetch-providers \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"system":"PROD","site_id":"14"},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "system": "PROD",
    "site_id": "14"
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "providers": [
      {
        "id": "9876",
        "label": "Morgan, Avery"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}