Practitioner Reference Number

PractitionerReferenceNumber

	object
created_at	string <date-time>
id	string <int64>
	object
name	string or null
	object
reference_number	string or null
updated_at	string <date-time>

{"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers/1"
},
"name": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"reference_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

List practitioner reference numbers

get/practitioner_reference_numbers

SecuritybasicAuth

Request

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
business_id	int64
created_at	date-time
id	int64
practitioner_id	int64
reference_number	string
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"practitioner_reference_numbers": [{"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers/1"
},
"name": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"reference_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers?page=2",
"previous": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers?page=1",
"next": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers?page=3"
}
}

Create practitioner reference number

post/practitioner_reference_numbers

SecuritybasicAuth

Request

Request Body schema: application/json

business_id	string <int64> business id
name	string or null
practitioner_id	string <int64> practitioner id
reference_number	string or null

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"name": "string",
"reference_number": "string",
"business_id": "1",
"practitioner_id": "1"
}

Response samples

application/json

{"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers/1"
},
"name": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"reference_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Get practitioner reference number

get/practitioner_reference_numbers/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers/1"
},
"name": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"reference_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Update practitioner reference number

patch/practitioner_reference_numbers/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

business_id	string <int64> business id
name	string or null
practitioner_id	string <int64> practitioner id
reference_number	string or null

Responses

200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"name": "string",
"reference_number": "string",
"business_id": "1",
"practitioner_id": "1"
}

Response samples

application/json

{"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers/1"
},
"name": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"reference_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete practitioner reference number

delete/practitioner_reference_numbers/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was deleted successfully

Request samples

curl
JavaScript
Python
Ruby

List practitioner reference numbers for practitionerDeprecated

get/practitioners/{practitioner_id}/practitioner_reference_numbers

SecuritybasicAuth

Request

path Parameters

practitioner_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
business_id	int64
created_at	date-time
id	int64
reference_number	string
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"practitioner_reference_numbers": [{"business": {"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1"
}
},
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioner_reference_numbers/1"
},
"name": "string",
"practitioner": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
}
},
"reference_number": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers?page=2",
"previous": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers?page=1",
"next": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers?page=3"
}
}