NAV
shell

Introduction

Welcome to the VisualCare public API documentation.

Authentication

To authorize, use this code:

Copy to Clipboard
# With shell, you can just pass the correct header with each request
curl "https://publicapi.visualcare.com.au"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

Make sure to replace user-uuid, key, secret with your API credentials provided.

The Visual Care API uses three credentials provided directly by Visual Care. If you do not have your crednetials please contact us here.

All requests to the API must have the following headers:

User: user-uuid Key: key Secret: Secret

Agreemeents

Get All Client Agreements

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/agreements"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "AgreementId": 1,
        "AgreementType": "Brokerage",
        "ClientId": 1,
        "PayerId": 5,
        "ChargeLevel": 1,
        "AgreementCode": "C000001",
        "Reference": "test 3",
        "Reference2": "",
        "Reference3": "",
        "StartDate": "2018-07-07",
        "EndDate": "2020-03-31",
        "AlertDate": "2018-12-31",
        "Current": 1,
        "GST": 1,
        "Area": "4",
        "ZoneId": 1,
        "IncomeType": 0,
        "conDVAZone": "",
        "conDVAServicePlanNo": 0,
        "conHeadContractId": 0,
        "DVASXNo": "",
        "Status": "",
        "AllowAdHoc": 1,
        "RatesOverride": 0,
        "RatesOverrideCharge": 0,
        "Budget": "500.0000",
        "BudgetPeriod": "WEEKLY",
        "BudgetHour": 40,
        "KmPayer": 0,
        "KmPayerId": 11,
        "_LastModTime": "0000-00-00 00:00:00",
        "_LastModUser": "",
        "_CreateTime": "0000-00-00 00:00:00",
        "_CreateUser": "",
        "AgreementItems": [
            {
                "AgreementItemId": 30,
                "AgreementId": 1,
                "ServiceId": 1,
                "ChargeRate": 300,
                "PayRate": 200,
                "CHSPRate": 2000,
                "CHSPType": "SHIFT",
                "CHSPPayrollCode": "",
                "Quantity": 0,
                "Unit": "HR",
                "Period": null,
                "PeriodTotal": 0,
                "BudgetAmount": 0,
                "BudgetHours": 0,
                "Comments": "",
                "Timestamp": null,
                "GST": 0
            },
            {
                "AgreementItemId": 67,
                "AgreementId": 1,
                "ServiceId": 2,
                "ChargeRate": 50,
                "PayRate": 25,
                "CHSPRate": 0,
                "CHSPType": "UNIT",
                "CHSPPayrollCode": null,
                "Quantity": 0,
                "Unit": "Hr",
                "Period": null,
                "PeriodTotal": 0,
                "BudgetAmount": 0,
                "BudgetHours": 0,
                "Comments": null,
                "Timestamp": null,
                "GST": 0
            }
        ]
    }
]

This endpoint retrieves all client agreements.

HTTP Request

GET https://publicapi.visualcare.com.au/agreements

Query Parameters

Query paramaters are in the format

GET https://publicapi.visualcare.com.au/agreements?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100&includeItems=TRUE

Parameter Default Description
limit 200 If not set, 200 items are returned by default
fromDate If set, returns agreements with a start date equal or greater than specified date. Must be in format YYYY-MM-DD
toDate If set, returns agreements with an end date equal or less than specified date. Must be in format YYYY-MM-DD
payerId If set, returns agreements matching a payer Id
clientId If set, returns agreements for a client Id
area If set, returns agreements for an area
includeItems If set to 'TRUE', will return all items for a given agreement

Areas

Get All Areas

Copy to Clipboard
curl "https://publicapi.visualcare.com/areas"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "AreaId": 1,
        "AreaCode": "EAST",
        "Area": "Eastern Suburbs",
        "Status": ""
    },
    {
        "AreaId": 2,
        "AreaCode": "South",
        "Area": "Southern Suburbs",
        "Status": ""
    }
]

This endpoint retrieves all areas.

HTTP Request

GET https://publicapi.visualcare.com.au/areas

Categories - Documents

Get All Document Categories

Copy to Clipboard
curl "https://publicapi.visualcare.com/category-documents"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
    {
        "CategoryId": 18,
        "CategoryCode": "Category 1",
        "Description": "Category 1 Description",
        "Status": ""
    }
]

This endpoint retrieves all categories for documents.

HTTP Request

GET https://publicapi.visualcare.com.au/category-documents

Categories - Incidents

Get All Incident Categories

Copy to Clipboard
curl "https://publicapi.visualcare.com/category-incidents"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
    {
        "CategoryId": 18,
        "CategoryCode": "Category 1",
        "Description": "Category 1 Description",
        "HelpText": "Category 1 HelpText a",
        "Status": ""
    }
]

This endpoint retrieves all categories for incidents.

HTTP Request

GET https://publicapi.visualcare.com.au/category-incidents

Categories - Payers

Get All Payer Categories

Copy to Clipboard
curl "https://publicapi.visualcare.com/category-payers"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
    {
        "CategoryId": 1,
        "CategoryCode": "CHSP",
        "Description": "Community and Home Support",
        "Status": ""
    }
]

This endpoint retrieves all categories for payers.

HTTP Request

GET https://publicapi.visualcare.com.au/category-payers

Categories - Roster Items

Get All Roster Item Categories

Copy to Clipboard
curl "https://publicapi.visualcare.com/category-rosteritems"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
   {
        "CategoryId": 7,
        "CategoryCode": "CatA",
        "Description": "Category A",
        "Status": ""
    }
]

This endpoint retrieves all categories for roster items.

HTTP Request

GET https://publicapi.visualcare.com.au/category-rosteritems

Categories - Services

Get All Services Categories

Copy to Clipboard
curl "https://publicapi.visualcare.com/category-services"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
   {
        "CategoryId": 9,
        "CategoryCode": "Assistance with Daily Li",
        "Description": "Assistance with Daily Life",
        "Status": ""
    }
]

This endpoint retrieves all categories for services.

HTTP Request

GET https://publicapi.visualcare.com.au/category-services

Clients

Get All Clients

Copy to Clipboard
curl "https://publicapi.visualcare.com/clients"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "ClientId": 1,
        "ClientCode": "THOMALIS",
        "FirstName": "Andre",
        "MiddleName": "",
        "LastName": "Box",
        "PreferredName": "Andre",
        "Gender": "M",
        "Address1": "25 Rochester Drive ",
        "Address2": "",
        "Suburb": "Thomastown",
        "State": "VIC",
        "PostCode": "3074",
        "Longitude": "145.031881",
        "Email": "-37.684424",
        "Phone1": "",
        "Phone2": "",
        "Fax": "",
        "DateOfBirth": "1957-06-27",
        "PayerId": -1,
        "Area": "MM1NSA"
    }
]

This endpoint retrieves all clients.

HTTP Request

GET https://publicapi.visualcare.com.au/clients

Query Parameters

Query paramaters are in the format

GET https://publicapi.visualcare.com.au/clients?includeDeleted=TRUE&serviceStatus=Current&includeNotes=TRUE

Parameter Default Description
clientId If set, returns a single client
includeDeleted If set, returns a deleted clients. By default these are excluded
includeNonCurrent If set, returns a non-current clients. By default these are excluded
serviceStatus If set, returns clients that match this status
serviceStart If set, returns clients with a service start date greater than or equal to this value
serviceEnd If set, returns clients with a service start date less than or equal to this value
includeNotes If set, returns the notes for the clients. By default these are excluded

Documents - Clients

Get All Client Documents

Copy to Clipboard
curl "https://publicapi.visualcare.com/documents-clients"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "DocId": 1705,
        "ClientId": 4472,
        "DocumentName": "MyCareConnect_User Guide Mob April 2020.pdf",
        "Note": "",
        "Protected": 0,
        "VisibleCarerMobile": 0,
        "VisibleClientMobile": 0,
        "CreatedBy": "train3@visualdatasolutions.com.au"
    }
]

This endpoint retrieves all client documents.

HTTP Request

GET https://publicapi.visualcare.com.au/documents-clients

Parameter Default Description
fromDate If set, returns time sheets from a certain date. Must be in format YYYY-MM-DD
toDate If set, returns time sheets before a certain date. Must be in format YYYY-MM-DD
clientId If set, returns time sheets for a client Id
categoryId If set, returns time sheets with a matching Category Id (categories can be retreived from /category-documents)

Incidents

Get All Clients Incidents

Copy to Clipboard
curl "https://publicapi.visualcare.com/incidents"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        {
        "IncidentId": 213589,
        "CategoryId": 0,
        "Note": "note 2",
        "Reason": "",
        "Comment": "",
        "Action": "",
        "Outcome": "",
        "Response": null,
        "Location": "",
        "Occurrence": "",
        "Performance": "",
        "NoteDate": "2020-04-14 00:00:00",
        "NotifiedDate": "0000-00-00 00:00:00",
        "AlertDate": "2020-04-14 00:00:00",
        "CloseDate": "0000-00-00 00:00:00",
        "TaskClosedDate": "0000-00-00 00:00:00",
        "AssignedTo": "",
        "AssignedToSecond": "",
        "Closed": 0,
        "TaskClosed": 0,
        "RequiresFollowUp": 0,
        "VisibleClientApp": 0,
        "VisibleWorkerApp": 0,
        "CreatedBy": "ivan@visualdatasolutions.com.au"
    }
]

This endpoint retrieves all client incidents.

HTTP Request

GET https://publicapi.visualcare.com.au/incidents

Query Parameters

Query paramaters are in the format

GET https://publicapi.visualcare.com/incidents?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100

Parameter Default Description
limit 200 If not set, 200 items are returned by default
fromDate If set, returns incidents with a date equal or greater than specified date. Must be in format YYYY-MM-DD
toDate If set, returns incidents with an date equal or less than specified date. Must be in format YYYY-MM-DD
clientId If set, returns incidents for a client Id
assignedTo If set, returns incidents assigned to a user
closed If set, returns incidents that are closed or open (true or false)
taskClosed If set, returns incidents that are marked as task closed or open (true or false)

Locations

Get All Clients Incidents

Copy to Clipboard
curl "https://publicapi.visualcare.com/locations"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
    {
        "LocationId": 1,
        "Code": "MLB NTH",
        "AccountingCode": "",
        "Description": "Northern Melbourne",
        "Address1": "",
        "Address2": "",
        "Suburb": "",
        "Postcode": 0,
        "State": "",
        "Area": "",
        "Status": ""
    }
]

This endpoint retrieves all locations.

HTTP Request

GET https://publicapi.visualcare.com.au/locations

Notes - Client

Get All Client Notes

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/notes-client"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard

This endpoint retrieves all client notes.

HTTP Request

GET https://publicapi.visualcare.com.au/notes-client

Query Parameters

Query paramaters are in the format

GET https://publicapi.visualcare.com.au/notes-client?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100&includeItems=TRUE

Parameter Default Description
limit 200 If not set, 200 items are returned by default
fromDate If set, returns quotes with a quote date equal or greater than specified date. Must be in format YYYY-MM-DD
toDate If set, returns quotes with an quote date equal or less than specified date. Must be in format YYYY-MM-DD
assignedTo If set, returns items assigned to an email address
closed If set to '1', will return closed items
taskClosed If set to '1', will return items with closed tasks
ClientId If set, returns notes for a specific client

Payers

Get All payers

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/payers"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "PayerId": 3,
        "PayerCode": "NDIS",
        "PayerName": "NDIS",
        "ContactName": "Sarah Smith",
        "Salutation": "",
        "Address1": "Add1",
        "Address2": "Add2",
        "Suburb": "Unley",
        "PostCode": "5061",
        "State": "SA",
        "Phone": "123",
        "Mobile": "246",
        "Email": "example@example.com",
        "AccountingCode": "ANZ",
        "ABN": "",
        "Category": "NDIS",
        "Active": 1,
        "Status": ""
    }
]

This endpoint retrieves all payers.

HTTP Request

GET https://publicapi.visualcare.com.au/payers

Quotes

Get All Clients Quotes

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/quotes"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "QuoteId": 22,
        "ClientId": -1,
        "PayerId": -1,
        "FundingTypeId": -1,
        "QuoteStatus": "in_progress",
        "Finalised": 1,
        "DateOfQuote": "2020-06-12",
        "FollowUpDate": "2020-06-12",
        "QuoteTotal": 4482,
        "QuoteTotalHours": 4482,
        "QuoteStart": "2020-05-26",
        "QuoteEnd": "2020-07-31",
        "FirstName": "John",
        "LastName": "Sotton",
        "Address1": "44 Fullarton Road",
        "Address2": "",
        "Subrub": "Norwood",
        "Postcode": "5067",
        "State": "SA",
        "Phone1": "",
        "Email": "jon@email.com",
        "DOB": "1930-10-10",
        "NDISNo": "",
        "_CreateUser": "",
        "_UpdateUser": "lisa@visualdatasolutions.com.au",
        "_UpdateComment": "Quote finalised by lisa@visualdatasolutions.com.au",
        "Status": "",
        "QuoteLineItems": [
            {
                "QuoteItemId": 14,
                "QuoteId": 22,
                "LineNo": 1,
                "ServiceId": 19,
                "Description": "",
                "Price": 30,
                "Quantity": 6,
                "TotalQuantity": 144,
                "Total": 4320,
                "Budget": 2000,
                "StartTime": "08:30:00",
                "FreqTye": "weekly",
                "FreqQty": 8,
                "FreqDaysStr": "MO;WE;FR",
                "FreqDays": [
                    "MO",
                    "WE",
                    "FR"
                ]
            },
            {
                "QuoteItemId": 15,
                "QuoteId": 22,
                "LineNo": 2,
                "ServiceId": 21,
                "Description": "",
                "Price": 81,
                "Quantity": 2,
                "TotalQuantity": 2,
                "Total": 162,
                "Budget": 1200,
                "StartTime": "11:00:00",
                "FreqTye": "weekly",
                "FreqQty": 1,
                "FreqDaysStr": "SA",
                "FreqDays": [
                    "SA"
                ]
            }
        ]
    }
]

This endpoint retrieves all client quotes.

HTTP Request

GET https://publicapi.visualcare.com.au/quotes

Query Parameters

Query paramaters are in the format

GET https://publicapi.visualcare.com.au/quotes?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100&includeItems=TRUE

Parameter Default Description
limit 200 If not set, 200 items are returned by default
fromDate If set, returns quotes with a quote date equal or greater than specified date. Must be in format YYYY-MM-DD
toDate If set, returns quotes with an quote date equal or less than specified date. Must be in format YYYY-MM-DD
payerId If set, returns quotes matching a payer Id
clientId If set, returns quotes for a client Id
includeItems If set to 'TRUE', will return all items for a given agreement

Rosters Master List

Get All Rosters Master records

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/roster-master"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "MasterId": 32,
        "ClientId": 1,
        "LocationId": 0,
        "RosterId": "R00001",
        "Reference": "",
        "Complete": 0,
        "DefaultServiceId": -1,
        "DefaultDateOfService": "0000-00-00",
        "IsDraft": 0,
        "RosterTimeZone": "Adelaide",
        "VisibleOnline": 1,
        "Status": ""
    }
]

This endpoint retrieves all rosters master listings. These link directly to the MasterId in the Rosters end point.

HTTP Request

GET https://publicapi.visualcare.com.au/roster-master

Rosters

Get All Rosters

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/rosters"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "ClientId": 32,
        "CarerId": 1,
        "PayerId": 0,
        "ServiceId": 1,
        "DateOfService": "2018-02-19",
        "StartTime": "09:00:00",
        "Minutes": 180,
        "ChargeRate": 45,
        "PayRate": 45,
        "BreakStartTime1": "00:00:00",
        "BreakMinutes1": 0,
        "RecurrenceId": 1,
        "OnHoldType": "",
        "OnHoldNote": "",
        "OnHoldCode": "",
        "TimeSheetId": 11
    }
]

This endpoint retrieves all rosters.

HTTP Request

GET https://publicapi.visualcare.com.au/rosters

Query Parameters

Query paramaters are in the format

GET https://publicapi.visualcare.com.au/rosters?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100

Parameter Default Description
limit 200 If not set, 200 items are returned by default
fromDate If set, returns time sheets from a certain date. Must be in format YYYY-MM-DD
toDate If set, returns time sheets before a certain date. Must be in format YYYY-MM-DD
rosterItemId If set, returns roster matching an Id
clientId If set, returns rosters for a client Id
carerId If set, returns rosters with a matching Carer Id
serviceId If set, returns rosters with matching Service Id

Services

Get All Services

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/services"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "ServiceId": 1,
        "ServiceCode": "PRIV CARE WKDAY",
        "Description": "Private Care Weekday",
        "Unit": "HR",
        "Area": "",
        "Category": 9,
        "ExpenseCategory": -1,
        "Type": "Private",
        "Reference1": "",
        "Reference2": "",
        "IsSleepover": 0,
        "IsNormalTime": 1,
        "LinkedNormalTime": -1,
        "ChargeRate": 80,
        "ChargeRate2": 90,
        "ChargeRate3": 100,
        "CHSPRate": 0,
        "PayRate1": 25.6,
        "PayRate2": 30,
        "PayRate3": 50.32,
        "PayRate4": 62.9,
        "PayRate5": 90.001,
        "PayRate6": 95.001,
        "PayRate7": 100.001,
        "PayRate8": 85.001,
        "PayRate9": 84,
        "PayRate10": 90,
        "PayRate11": 85,
        "PayRate12": 95,
        "PayRate13": 75,
        "PayRate14": 105,
        "PayRate15": 110,
        "PayRate16": 120,
        "PayRate17": 0.001,
        "PayRate18": 0.001,
        "PayRate19": 0.001,
        "PayRate20": 20,
        "PayRate21": 0.001,
        "PayRate22": 0.001,
        "PayRate23": 0.001,
        "PayRate24": 0.001,
        "AccountingCode": "PRIV Weekday",
        "PayrollCode1": "PRIV WKDAY",
        "PayrollCode2": "Saturday shift",
        "PayrollCode3": "Sunday shift",
        "PayrollCode4": "Public Holiday Shift",
        "PayrollCode5": "",
        "PayrollCode6": "",
        "PayrollCode7": "",
        "PayrollCode8": "",
        "PayrollCode9": "",
        "PayrollCode10": "",
        "PayrollCode11": "",
        "PayrollCode12": "",
        "PayrollCode13": "",
        "PayrollCode14": "",
        "PayrollCode15": "",
        "PayrollCode16": "",
        "PayrollCode17": "",
        "PayrollCode18": "",
        "PayrollCode19": "",
        "PayrollCode20": "",
        "PayrollCode21": "",
        "PayrollCode22": "",
        "PayrollCode23": "",
        "PayrollCode24": "",
        "AllowanceCode": "",
        "GST": 1,
        "NDISSupportNumber": "NDIS SN",
        "NDISGSTCode": "NDIS GST",
        "NDISRegGrpNumber": 118,
        "_LastModTime": "0000-00-00 00:00:00",
        "_LastModUser": "",
        "_CreateTime": "0000-00-00 00:00:00",
        "_CreateUser": "",
        "Active": 1,
        "Status": ""
    }
]

This endpoint retrieves all services.

HTTP Request

GET https://publicapi.visualcare.com.au/services

Time Sheets

Get All Time Sheets

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/timesheets"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "ClientId": 50,
        "CarerId": 5,
        "ServiceId": 5,
        "DateOfService": "2019-08-01",
        "StartTime": "09:00:00",
        "Minutes": 120,
        "ChargeRate": 75,
        "PayRate": 50,
        "KM": 0,
        "KMCharge": 0,
        "Variation": 0,
        "VariationQty": 0,
        "VariationComment": "",
        "VariationApproved": 0,
        "ExtraChargeClient": 0,
        "BreakStartTime1": "00:00:00",
        "BreakMinutes1": 0,
        "RecurrenceId": 651,
        "OnHoldType": "",
        "OnHoldNote": "",
        "OnHoldCode": "",
        "RosterItemId": 94335,
        "APP_IP": "",
        "APP_StartTime": "0000-00-00 00:00:00",
        "APP_FinishTime": "0000-00-00 00:00:00"
    },
    {
        "ClientId": 50,
        "CarerId": 5,
        "ServiceId": 5,
        "DateOfService": "2019-08-01",
        "StartTime": "09:00:00",
        "Minutes": 120,
        "ChargeRate": 75,
        "PayRate": 50,
        "KM": 0,
        "KMCharge": 0,
        "Variation": 0,
        "VariationQty": 0,
        "VariationComment": "",
        "VariationApproved": 0,
        "ExtraChargeClient": 0,
        "BreakStartTime1": "00:00:00",
        "BreakMinutes1": 0,
        "RecurrenceId": 651,
        "OnHoldType": "",
        "OnHoldNote": "",
        "OnHoldCode": "",
        "RosterItemId": 94335,
        "APP_IP": "",
        "APP_StartTime": "0000-00-00 00:00:00",
        "APP_FinishTime": "0000-00-00 00:00:00"
    }
]

This endpoint retrieves all timesheets.

HTTP Request

GET https://publicapi.visualcare.com.au/timesheets

Query Parameters

Query paramaters are in the format

GET https://publicapi.visualcare.com.au/timesheets?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100

Parameter Default Description
limit 200 If not set, 200 items are returned by default
fromDate If set, returns time sheets from a certain date. Must be in format YYYY-MM-DD
toDate If set, returns time sheets before a certain date. Must be in format YYYY-MM-DD
timesheetId If set, returns time sheet matching an Id
clientId If set, returns time sheets for a client Id
carerId If set, returns time sheets with a matching Carer Id
serviceId If set, returns time sheets with matching Service Id
includeNotes If set, returns the app notes associated with the time sheet

Workers

Get All Workers

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/workers"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
  {
        "CarerId": 1,
        "CarerCode": "BRIB01",
        "FirstName": "Alusine",
        "LastName": "Bah",
        "PreferredName": "Brian",
        "Address1": "10/62 Jumbuck Circuit",
        "Address2": "",
        "Suburb": "Wollert",
        "State": "VIC",
        "PostCode": "3750",
        "Longitude": "145.0320807",
        "Email": "-37.6161024",
        "Phone1": "",
        "Phone2": "61403665334",
        "DateOfBirth": "1981-03-19",Current": 0,
        "Status": ""
    }
]

This endpoint retrieves all workers.

HTTP Request

GET https://publicapi.visualcare.com.au/workers

Query Parameters

Query paramaters are in the format

GET https://publicapi.visualcare.com.au/workers?includeSkills=TRUE

Parameter Default Description
includeSkills FALSE If set to TRUE, the skills associated with the worker will also be returned
includeNonCurrent FALSE If set to TRUE, non-current workers also be returned
includeDeleted FALSE If set to TRUE, deleted workers will also be returned

Skills

Get All Skills

Copy to Clipboard
curl "https://publicapi.visualcare.com.au/skills"
  -H "User: user-uuid"
  -H "Key: key"
  -H "Secret: secret"

The above command returns JSON structured like this:

Copy to Clipboard
[
    {
        "SkillId": 1,
        "SkillCode": "DC",
        "Description": "Domestic Care",
        "Status": ""
    },
    {
        "SkillId": 2,
        "SkillCode": "PC",
        "Description": "Personal Care",
        "Status": ""
    }
]

This endpoint retrieves all skills.

HTTP Request

GET https://publicapi.visualcare.com.au/skills

Errors

The Kittn API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The kitten requested is hidden for administrators only.
404 Not Found -- The specified kitten could not be found.
405 Method Not Allowed -- You tried to access a kitten with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The kitten requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many kittens! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
shell