Logo
Submit a request
Follow

Appointments

Adding an Appointment

URL

https://app.bluefolder.com/api/1.0/appointments/add.aspx

Request

<request>
   <appointmentAdd>
       <subject></subject>
       <dateTimeStart></dateTimeStart>
       <dateTimeEnd></dateTimeEnd>
       <allDayEvent></allDayEvent>
       <assignedTo>
           <userID></userID>
           ...
       </assignedTo>
       <customerID></customerID>
       <serviceRequestID></serviceRequestID>
       <description></description>
       <notifyCustomer></notifyCustomer>
   </appointmentAdd>
</request>
            
  • subject - (required) string (100 char limit)
  • dateTimeStart - (required) datetime, must be in the format YYYY.MM.DD HH:MM AM
  • dateTimeEnd - (required) datetime, must be in the format YYYY.MM.DD HH:MM AM
  • allDayEvent - boolean, indicates if appointment is an all-day appointment
  • assignedTo - designates the userIDs that are to be assigned to the appointment
    • userID - numeric, must match an existing User ID in your user list
  • customerID - numeric, must match an existing Customer ID from your customer list, not necessary if "serviceRequestID" is specified
  • serviceRequestID - numeric, must match an existing Service Request. If included, you do not need to specify a "customerID".
  • description - string (no char limit)
  • notifyCustomer - boolean, indicates if customer should receive an email notification of the appointment

Response

<response status="ok">
    <apptID>xxxxxx</apptID>
</response>
            

Editing an Appointment

URL

https://app.bluefolder.com/api/1.0/appointments/edit.aspx

Request

<request>
   <appointmentEdit>
       <apptID></apptID>
       <subject></subject>
       <dateTimeStart></dateTimeStart>
       <dateTimeEnd></dateTimeEnd>
       <allDayEvent></allDayEvent>
       <assignedTo>
           <userID></userID>
           ...
       </assignedTo>
       <customerID></customerID>
       <serviceRequestID></serviceRequestID>
       <description></description>
       <notifyCustomer></notifyCustomer>
   </appointmentEdit>
</request>
            
  • apptID - (required) numeric, the ID of the appointment to be edited
  • subject - string (100 char limit)
  • dateTimeStart - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • dateTimeEnd - datetime, must be in the format YYYY.MM.DD HH:MM AM
  • allDayEvent - boolean, indicates if appointment is an all-day appointment
  • assignedTo - designates the userIDs that are to be assigned to the appointment, will replace any existing assignees
    • userID - numeric, must match an existing User ID in your user list
  • userID - numeric, must match an existing User ID from your user list, must be within the "assignedTo" element
  • customerID - numeric, must match an existing Customer ID from your customer list, not necessary if "serviceRequestID" is specified. Can only be modified if existing customerID is 0.
  • serviceRequestID - numeric, must match an existing Service Request. If included, you do not need to specify a "customerID". If included and is 0, the "customerID" value will also be changed to 0 for the appointment.
  • description - string (no char limit)
  • notifyCustomer - boolean, indicates if customer should receive an email notification of the appointment

Response

<response status="ok">
    <apptID>xxxxxx</apptID>
</response>
            

Retrieving a Single Appointment

URL

https://app.bluefolder.com/api/1.0/appointments/get.aspx

Request

<request>
    <appointmentGet>
        <apptID>xxxxxx</apptID>
    </appointmentGet>
</request>
            

Response

<response status="ok">
    <appointment>
        <id></id>
        <allDayEvent></allDayEvent>
        <createdByUserID></createdByUserID>
        <customerID></customerID>
        <dateTime></dateTime>
        <dateTimeEnd></dateTimeEnd>
        <description></description>
        <duration></duration>
        <isRecurring></isRecurring>
        <subject></subject>
        <serviceRequestID></serviceRequestID>
        <assignedTo>
            <userID></userID>
            ...
        </assignedTo>
    </appointment>
</response>
            

Retrieving a List of Appointments

URL

https://app.bluefolder.com/api/1.0/appointments/list.aspx

Request

<request>
    <appointmentList>
        <dateRangeStart></dateRangeStart>
        <dateRangeEnd></dateRangeEnd>
        <userID></userID>
    </appointmentList>
</request>
            
  • dateTimeStart - (required) datetime, must be in the format YYYY.MM.DD HH:MM AM
  • dateTimeEnd - (required) datetime, must be in the format YYYY.MM.DD HH:MM AM
  • userID - filter appointment list to only show appointments for specified userID

Response

<response status="ok">
    <appointment>
        <id></id>
        <allDayEvent></allDayEvent>
        <createdByUserID></createdByUserID>
        <customerID></customerID>
        <dateTimeStart></dateTimeStart>
        <dateTimeEnd></dateTimeEnd>
        <description></description>
        <duration></duration>
        <isMultiDay></isMultiDay>
        <isRecurring></isRecurring>
        <subject></subject>
        <serviceRequestID></serviceRequestID>
        <taskID></taskID>
        <assignedTo>
            <userID></userID>
            ...
        </assignedTo>
    </appointment>
</response>
            
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request