Locations #
location in v2 the replacement terminology for auth_group in v1
As explained in detail here each vendor should organise their customers into groups, generally 1 location for each practice site or business, each linked to a unique ‘MinorID’ also known as a ‘LocationID’. The MinorID looks like SAP12345 and is a unique identifier used by Services Australia to show where the transmission is coming from.
IMPORTANT - Minor IDs issued in development will not be used in production, do not use the development Minor ID to register providers with Medicare!
GET - List all locations
#
Get a current list of all your registered locations, and the providers linked to those locations.
Endpoint:
{{base_url}}/{{version}}/locations
Headers:
| Header | Value |
|---|---|
| Accept | application/json |
| Authorization | Bearer {{oauth_token}} |
Example Request:
curl --location 'https://sandbox.claiming.com.au/v2/locations' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer '
Example Response:
Body:
{
"status": "OK",
"items": [
{
"id": 1581,
"name": "My Updated Location",
"active": false,
"minorID": "SAP00000",
"providers": [
{
"id": 2195,
"providerNumber": "2433421X",
"name": "IGOR FULLER",
"active": true
},
{
"id": 2196,
"providerNumber": "2433411Y",
"name": "Ethel Boykin",
"active": true
},
{
"id": 2818,
"providerNumber": "2438081F",
"name": "Dmitry Bailey",
"active": true
},
{
"id": 2832,
"providerNumber": "1234560T",
"name": "John Doe",
"active": true
}
]
},
{
"id": 1758,
"name": "My Location",
"active": true,
"minorID": "SAP01391",
"providers": []
},
{
"id": 1784,
"name": "My Auth Group",
"active": true,
"minorID": "SAP01417",
"providers": []
},
{
"id": 1785,
"name": "My Updated Auth Group",
"active": false,
"minorID": "SAP01418",
"providers": []
},
{
"id": 1786,
"name": "Disabled Auth Group",
"active": false,
"minorID": "SAP01419",
"providers": []
},
{
"id": 1787,
"name": "Newtown Clinic",
"active": true,
"minorID": "SAP01420",
"providers": []
},
{
"id": 2051,
"name": "My New Location",
"active": true,
"minorID": "SAP01683",
"providers": []
},
{
"id": 2054,
"name": "My New Location",
"active": true,
"minorID": "SAP01686",
"providers": []
}
],
"total": 8,
"offset": 0
}
Headers:
| Header | Value |
|---|---|
| Server | nginx/1.19.3 |
| Date | Tue, 08 Jun 2021 04:49:28 GMT |
| Content-Type | application/json |
| Content-Length | 1171 |
| Connection | keep-alive |
| Access-Control-Allow-Origin | * |
| Access-Control-Allow-Methods | GET, POST, OPTIONS |
POST - Add a new location
#
When you create a new location, the API will generate a unique Minor ID for this site and return it in the response.
IMPORTANT - Minor IDs issued in development will not be used in production, do not use the development Minor ID to register providers with Medicare!
Endpoint:
{{base_url}}/{{version}}/locations
Headers:
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer {{oauth_token}} |
Body:
{
"name": "Newtown Clinic"
}
Example Request:
curl --location 'https://sandbox.claiming.com.au/v2/locations' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
"name": "Newtown Clinic"
}'
Example Response:
Body:
{
"id": 123,
"minorID": "SAP01234",
"keystore": null,
"name": "Newtown Clinic",
"providers": [],
"active": true
}
| Header | Value |
|---|---|
| Server | nginx/1.19.3 |
| Date | Tue, 08 Jun 2021 04:49:28 GMT |
| Content-Type | application/json |
| Content-Length | 113 |
| Connection | keep-alive |
| Access-Control-Allow-Origin | * |
| Access-Control-Allow-Methods | GET, POST, OPTIONS |
PUT - Update an existing location
#
You can change the name of the location, and toggle its ‘active’ flag.
Specify the Minor ID that is being updated in the JSON body
Endpoint:
{{base_url}}/{{version}}/locations/{{location_id}}
Headers:
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer {{oauth_token}} |
Body:
{
"id": 25,
"name": "Newtown Clinic - INACTIVE",
"active": 0
}
Example Request:
curl --location --request PUT 'https://sandbox.claiming.com.au/v2/locations/25' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ' \
--data '{
"id": {{locationID}},
"name": "Newtown Clinic - INACTIVE",
"active": 0
}'
Example Response:
Body:
{
"id": 1581,
"minorID": "SAP00000",
"keystore": null,
"name": "Newtown Clinic - INACTIVE",
"providers": [],
"active": false
}
| Header | Value |
|---|---|
| Server | nginx/1.19.3 |
| Date | Tue, 08 Jun 2021 04:49:28 GMT |
| Content-Type | application/json |
| Content-Length | 125 |
| Connection | keep-alive |
| Access-Control-Allow-Origin | * |
| Access-Control-Allow-Methods | GET, POST, OPTIONS |