PATCH api/v1/visits/{id}?domain={domain}&key={key}&provider_unit={provider_unit}&roles={roles}

Update an existing visit. Currently, only start time and end time will be updateable

Request Information

URI Parameters

Name	Description	Type	Additional information
domain	The domain ID. This is the name of the municipality's meta domain that the API is reading writing data to.	string	Required
key	The API license key.	string	Required
provider_unit	Not in use	string	None.
roles	Not in use	string	None.
id	The Gerica internal id for the Visit	string	Required

Body Parameters

The updated Visit object

UpdateVisit

Name	Description	Type	Additional information
Id	Visit's Id	string	None.
StartTime	Start time of visit. Local time.	date	None.
EndTime	End time of visit. Local time	date	None.
AssignedTo	Employee identifier this visit is assigned to. Accepts id, national identity number (fødselsnummer, 11 digits) or username. Use "0" to unassign. The values null or not set will not change the employee.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "StartTime": "2024-11-22T19:44:22.0416666+01:00",
  "EndTime": "2024-11-22T19:44:22.0416666+01:00",
  "AssignedTo": "sample string 4"
}

application/xml, text/xml

Sample:

<UpdateVisit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://lifecare.tieto.com/ec/no/v1">
  <AssignedTo>sample string 4</AssignedTo>
  <EndTime>2024-11-22T19:44:22.0416666+01:00</EndTime>
  <Id>sample string 1</Id>
  <StartTime>2024-11-22T19:44:22.0416666+01:00</StartTime>
</UpdateVisit>

Response Information

Resource Description

Update an existing visit. Currently, only start time and end time will be updateable

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>