API docs by Redocly

Repzo API - Visit (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Visit endpoints.

Find visits

query Parameters
params
object

Query parameters for filtering visits

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": { }
}

Create a visit

Request Body schema: application/json
client
string
rep
string
plannedDate
string <date-time>
actualDate
string <date-time>
status
string
Enum: "planned" "completed" "cancelled"
notes
string
location
object

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "plannedDate": "2019-08-24T14:15:22Z",
  • "actualDate": "2019-08-24T14:15:22Z",
  • "status": "planned",
  • "notes": "string",
  • "location": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a visit by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a visit

path Parameters
id
required
string
Request Body schema: application/json
client
string
rep
string
plannedDate
string <date-time>
actualDate
string <date-time>
status
string
Enum: "planned" "completed" "cancelled"
notes
string
location
object

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "plannedDate": "2019-08-24T14:15:22Z",
  • "actualDate": "2019-08-24T14:15:22Z",
  • "status": "planned",
  • "notes": "string",
  • "location": { }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}