Submit Appointment

This call is executed to create or update appointments.

POST
/accounts/appointments/submit

Request elements

Parameter Type Required Description
account.accountId String Yes Unique ID generated for the customer
account.phone String Yes Phone number of the customer
account.email String Yes Email ID of the customer
account.first String Yes First name of the customer
account.last String Yes Last name of the customer
referenceNumber String Yes Appointment’s unique identity
start Date Yes Appointment’s start time
end Date Yes Appointment’s end time
operatorId String No Operator’s unique identity
operatorName String No Operator’s name
deviceId String No Terminal’s unique identity
deviceName String No Terminal’s name
status Decimal Yes Status of appointment
receipt String No If a receipt is linked
sku String Yes Line item’s unique identifier
name String Yes Line item’s name
price Decimal Yes Line item’s price
consultantId String No Unique Identifier for the consultant
consultantName String No Name of the consultant
duration Decimal Yes Duration of the service

Error messages

Error Code Error Message
1004 The following field is not unique
1006 The following fields are invalid
1002 Fields are empty

 

EXAMPLE REQUEST:

POST http://[subdomain].datanuum.com/accounts/appointments/submit
{
  "account": {   
   "phone": "919562301758",
   "email": "john@gmail.com",
   "first": "John",
   "last": "Walker"
  },
  "referenceNumber": "APPT123456",
  "generated": "2024-12-19 08:30:00",
  "start": "2024-12-19 09:00:00",
  "end": "2024-12-19 09:30:00",
  "operatorId": "OPR9876",
  "operatorName": "John Doe",
  "deviceId": "DEV12345",
  "deviceName": "Tablet A1",
  "status": 1,
  "receipt": "RCPT123456",
  "items": [
    {
      "sku": "SKU987654",
      "name": "General Consultation",
      "price": 100,
      "consultantId": "CONS123",
      "consultantName": "Dr. Sarah Smith",
      "consultantType": "Doctor",
      "duration": 30
    },
    {
      "sku": "SKU123456",
      "name": "Blood Test",
      "price": 50
    }
  ]
}

EXAMPLE RESPONSE:
{
    "status" : "success"
}