Get a single case

Get a single case

curl --request GET \
  --url https://api.splose.com/v1/cases/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.splose.com/v1/cases/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.splose.com/v1/cases/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.splose.com/v1/cases/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.splose.com/v1/cases/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "contactId": 1,
  "issueDate": "2024-06-09T14:30:00.000Z",
  "expiryDate": "2024-06-25T14:29:59.000Z",
  "hours": 32,
  "practitionerId": 1,
  "items": [
    {
      "typeId": 1,
      "type": "Appointment"
    }
  ],
  "organisationId": 1,
  "patientId": 2,
  "caseNumber": "0002",
  "budget": 200,
  "appointmentCount": 12,
  "providerNumber": "1512",
  "referralPeriod": "Standard",
  "notes": "Notes",
  "trackType": "Budget",
  "includeDidNotArrive": true,
  "includeCancelled": true,
  "isOpen": true,
  "hasAlert": true,
  "remindTime": "Time",
  "utilisationAlert": 1,
  "isAlertUtilizationSent": true,
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}

Get a single case

curl --request GET \
  --url https://api.splose.com/v1/cases/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.splose.com/v1/cases/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.splose.com/v1/cases/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.splose.com/v1/cases/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.splose.com/v1/cases/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": 1,
  "contactId": 1,
  "issueDate": "2024-06-09T14:30:00.000Z",
  "expiryDate": "2024-06-25T14:29:59.000Z",
  "hours": 32,
  "practitionerId": 1,
  "items": [
    {
      "typeId": 1,
      "type": "Appointment"
    }
  ],
  "organisationId": 1,
  "patientId": 2,
  "caseNumber": "0002",
  "budget": 200,
  "appointmentCount": 12,
  "providerNumber": "1512",
  "referralPeriod": "Standard",
  "notes": "Notes",
  "trackType": "Budget",
  "includeDidNotArrive": true,
  "includeCancelled": true,
  "isOpen": true,
  "hasAlert": true,
  "remindTime": "Time",
  "utilisationAlert": 1,
  "isAlertUtilizationSent": true,
  "createdAt": "2023-07-30T09:00:00.000Z",
  "updatedAt": "2023-07-30T09:00:00.000Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Required range: x > 0

Example:

1

Response

200 - application/json

Object with case data.

integer

required

Case id

Required range: x > 0

Example:

1

contactId

integer | null

required

Contact Id

Required range: x > 0

Example:

1

issueDate

required

Issued date in YYYY-MM-DD HH:MM:SS format

Example:

"2024-06-09T14:30:00.000Z"

expiryDate

required

Expiry date in YYYY-MM-DD HH:MM:SS format

Example:

"2024-06-25T14:29:59.000Z"

hours

number | null

required

hours

Example:

32

practitionerId

integer | null

required

Practitioner id

Required range: x > 0

Example:

1

items

object[]

required

An array of appointment connections associated with this case

Show child attributes

organisationId

integer

required

Organisation id

Required range: x > 0

Example:

1

patientId

integer

required

Patient id

Required range: x > 0

Example:

2

caseNumber

string

Case number

Example:

"0002"

budget

number | null

Budget

Example:

200

appointmentCount

number | null

Appointment count

Example:

12

providerNumber

string | null

Provider number

Example:

"1512"

referralPeriod

string | null

Referral Period

Example:

"Standard"

notes

string | null

Notes

Example:

"Notes"

trackType

enum<string>

Track type

Available options:

Appointments,

Hours,

Budget

Example:

"Budget"

includeDidNotArrive

boolean | null

Did not arrive

Example:

true

includeCancelled

boolean | null

Include cancelled

Example:

true

isOpen

boolean | null

Is open

Example:

true

hasAlert

boolean | null

Has alert

Example:

true

remindTime

string | null

Remind time

Example:

"Time"

utilisationAlert

number | null

Utilisation alert

Example:

1

isAlertUtilizationSent

boolean | null

Is alert utilization sent

Example:

true

createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"

Get started

API Reference

Authorizations

Path Parameters

Response