POST api/notifications/appointment/{id}

Send appointment notifications to org member

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Logged in org member id.

integer

Required

Body Parameters

appointment data.

AppointmentNotifReq
NameDescriptionTypeAdditional information
org_id

org id

integer

None.

org_branch_id

org branch id

integer

None.

org_member_id

org member id

integer

None.

mapping_id

org member id

string

None.

appointment_id

firestore dynamic id

string

None.

display_name

user name

string

None.

new_scheduled_time

new scheduled datetime in case of rescheduled

decimal number

None.

old_scheduled_time

old scheduled datetime in case of rescheduled

decimal number

None.

is_newly_created

appointment is newly created

boolean

None.

is_deleted

appointment is deleted

boolean

None.

is_rescheduled

appointment is rescheduled

boolean

None.

is_processed

appointment is processed

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "org_id": 1,
  "org_branch_id": 2,
  "org_member_id": 3,
  "mapping_id": "sample string 4",
  "appointment_id": "sample string 5",
  "display_name": "sample string 6",
  "new_scheduled_time": 7.1,
  "old_scheduled_time": 8.1,
  "is_newly_created": true,
  "is_deleted": true,
  "is_rescheduled": true,
  "is_processed": true
}

application/xml, text/xml

Sample:
<AppointmentNotifReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LifetronsPhoneApi.Models.v5">
  <appointment_id>sample string 5</appointment_id>
  <display_name>sample string 6</display_name>
  <is_deleted>true</is_deleted>
  <is_newly_created>true</is_newly_created>
  <is_processed>true</is_processed>
  <is_rescheduled>true</is_rescheduled>
  <mapping_id>sample string 4</mapping_id>
  <new_scheduled_time>7.1</new_scheduled_time>
  <old_scheduled_time>8.1</old_scheduled_time>
  <org_branch_id>2</org_branch_id>
  <org_id>1</org_id>
  <org_member_id>3</org_member_id>
</AppointmentNotifReq>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

On success, returns Lifetrons standard responses codes. On failure, return Lifetrons standard responses codes.

Response
NameDescriptionTypeAdditional information
resp_code

Lifetrons response code

string

None.

resp_msg

Lifetrons response message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "resp_code": "sample string 1",
  "resp_msg": "sample string 2"
}

application/xml, text/xml

Sample:
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LifetronsPhoneApi.Models">
  <resp_code>sample string 1</resp_code>
  <resp_msg>sample string 2</resp_msg>
</Response>