Practitioners

Get current practitioner

Retrieves the current practitioner's information based on the practitioner's token provided.

GET /practitioners

curl "https://partner-staging.i-screen.com.au/v1/practitioners" \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"

Response

{
  "_id": "5cc8e2a92d350f000f054db6",
  "companyName": "Practitioner A",
  "defaultEmail": "hello@practitioner-a.com",
  "accreditationBody": "AHPRA",
  "accreditationNumber": "CHI12341231",
  "phone": "0412234234",
  "address": {
    "line1": "Unit 6/12",
    "line2": "3 Pipeclay Road",
    "city": "Cairncross",
    "state": "New South Wales",
    "country": "Australia",
    "zip": "2446"
  },
  "createdAt": "2019-05-01T00:04:57.581Z",
  "updatedAt": "2020-07-09T11:03:15.055Z"
}

---

Create a new practitioner

Creates a new practitioner and generates a new practitioner's token.

POST /practitioners

note

Only the partner's token is required for this endpoint.

note

Once the new practitioner is created, the provided email will be used to send an invitation to join i-screen's practitioner portal.

Payload

Parameter	Required	Description
companyName string	Yes	The practitioner's name
defaultEmail string	Yes	The practitioner's email address. Must be a valid email address.
accreditationBody string	No	The practitioner's accreditation body (e.g. AHPRA, ATMS, NHAA, ANTA, CMA, ANPA)
accreditationNumber string	No	The practitioner's accreditation membership or registration number
phone string	No	The practitioner's phone number. Must start with a 0.
address.line1 string	No	Address line 1
address.line2 string	No	Address line 2
address.city string	No	City
address.state string	No	State
address.country string	No	Country
address.zip string	No	Postcode

curl -X POST https://partner-staging.i-screen.com.au/v1/practitioners \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-"

Payload

{
  "companyName": "Practitioner B",
  "defaultEmail": "contactus@practitionerb.com.au",
  "accreditationBody": "AHPRA",
  "accreditationNumber": "CHI12341231",
  "phone": "0412234234",
  "address": {
    "line1": "Unit 6/12",
    "line2": "3 Pipeclay Road",
    "city": "Cairncross",
    "state": "New South Wales",
    "country": "Australia",
    "zip": "2446"
  }
}

Response

{
  "_id": "5cc8e2a92d350f000f054db6",
  "companyName": "Practitioner B",
  "defaultEmail": "contactus@practitionerb.com.au",
  "accreditationBody": "AHPRA",
  "accreditationNumber": "CHI12341231",
  "phone": "0412234234",
  "address": {
    "line1": "Unit 6/12",
    "line2": "3 Pipeclay Road",
    "city": "Cairncross",
    "state": "New South Wales",
    "country": "Australia",
    "zip": "2446"
  },
  "createdAt": "2019-05-01T00:04:57.581Z",
  "updatedAt": "2020-07-09T11:03:15.055Z",
  "accessToken": "5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"
}

---

Patch current practitioner

Updates the current practitioner's details.

PATCH /practitioners/:practitionerId

URL Parameters

Parameter	Description
practitionerId	The practitioner's record ID

note

Please contact i-screen directly to change a practitioner's email and/or company name.

Payload

Parameter	Required	Description
accreditationBody string	No	The practitioner's accreditation body (e.g. AHPRA, ATMS, NHAA, ANTA, CMA, ANPA)
accreditationNumber string	No	The practitioner's accreditation membership or registration number
phone string	No	The practitioner's phone number
address.line1 string	No	Address line 1
address.line2 string	No	Address line 2
address.city string	No	City
address.state string	No	State
address.country string	No	Country
address.zip string	No	Postcode

curl -X PATCH https://partner-staging.i-screen.com.au/v1/practitioners/5cc8e2a92d350f000f054db6 \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"

Payload

{
  "accreditationBody": "AHPRA",
  "accreditationNumber": "CHI12341231",
  "phone": "0412234234",
  "address": {
    "line1": "Unit 6/12",
    "line2": "3 Pipeclay Road",
    "city": "Cairncross",
    "state": "New South Wales",
    "country": "Australia",
    "zip": "2446"
  }
}

Response

{
  "_id": "5cc8e2a92d350f000f054db6",
  "companyName": "Practitioner C",
  "defaultEmail": "contactus@practitionerc.com.au",
  "accreditationBody": "AHPRA",
  "accreditationNumber": "CHI12341231",
  "phone": "0412234234",
  "address": {
    "line1": "Unit 6/12",
    "line2": "3 Pipeclay Road",
    "city": "Cairncross",
    "state": "New South Wales",
    "country": "Australia",
    "zip": "2446"
  },
  "createdAt": "2019-05-01T00:04:57.581Z",
  "updatedAt": "2020-07-09T11:03:15.055Z"
}