Locations #
location in v2 the replacement terminology for auth_group in v1
As explained in detail here each vendor should organise their customers into locations or groups, generally 1 for each practice site or business, each linked to a unique ‘MinorID’ or ‘LocationID’. The MinorID looks like SAP12345 and is a unique identifier used in electronic claiming to show where the claim is coming from. The location is our unique reference for the MinorID.
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 location for a vendor
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": 1442,
"name": "Test Location",
"active": false,
"minorID": "SAP01078",
"providers": [
{
"id": 1921,
"providerNumber": "2433411Y",
"name": "test provider",
"active": true
}
]
},
{
"id": 1977,
"name": "Second Test Location",
"active": true,
"minorID": "SAP01609",
"providers": []
}
],
"total": 2,
"offset": 0
}
Headers:
| Header | Value |
|---|---|
| Server | nginx/1.19.3T |
| Date | Tue, 08 Jun 2021 04:49:28 GMT |
| Content-Type | application/json |
| Content-Length | 1792 |
| 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 and UID for this site and return them in the response.
You can use either the Minor ID or the UID to refer to a location in a URL or parameter. We recommend using the actual Minor ID for simplicity.
IMPORTANT - the 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": "My New Location"
}
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": "My New Location"
}'
Example Response:
Body:
{
"id": 2059,
"minorID": "SAP01691",
"keystore": null,
"name": "My New Location",
"providers": [],
"active": true
}
| Header | Value |
|---|---|
| Server | nginx/1.19.3T |
| Date | Tue, 08 Jun 2021 04:49:28 GMT |
| Content-Type | application/json |
| Content-Length | 114 |
| 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.
Endpoint:
{{base_url}}/{{version}}/locations/{{location_id}}
Headers:
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer {{oauth_token}} |
Body:
{
"name": "My Updated Location",
"active": true
}
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 '{
"name": "My Updated Location",
"active": true
}'
Example Response:
Body:
{
"id": 1887,
"minorID": "SAP01519",
"keystore": null,
"name": "My Updated Location",
"providers": [],
"active": true,
"address": null,
"phoneNumber": null
}
| Header | Value |
|---|---|
| Server | nginx/1.19.3T |
| Date | Tue, 08 Jun 2021 04:49:28 GMT |
| Content-Type | application/json |
| Content-Length | 156 |
| Connection | close |
| Access-Control-Allow-Origin | * |
| Access-Control-Allow-Methods | GET, POST, OPTIONS |
| Strict-Transport-Security | max-age=3153600; includeSubDomains; preload |
| X-XSS-Protection | 1; mode=block |
| X-Content-Type-Options | nosniff |
| X-Frame-Options | SAMEORIGIN |