/appointments

Action : GET
Description: Obtains the upcoming appointments for the passed user. To obtain complete information on each appointment see the /appointment call.

Parameter	Description	Data Type
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String
allInspectors	By default only apppointments assigned to the inspector passed are returned. Set this parameter to true if you would like appointments for all inspectors returned. The passed inspector must be an admin or account owner to get all inspector appointments	String

/appointmentsbystatus

Action : GET
Description: Returns appoints with the specified status and within the specified date range. Only 200 results can be returned at a time. Use the firstResult parameter to return additional results beyond 200. For example, by default, results 0 - 199 are returned. To view results 200 - 399, set firstResult to 200. To view results 400 - 599, set firstResult to 400, and so on.

Parameter	Description	Data Type
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String
appointmentStatus	The Appointment Status	String
allInspectors	By default only apppointments assigned to the inspector passed are returned. Set this parameter to true if you would like appointments for all inspectors returned. The passed inspector must be an admin or account owner to get all inspector appointments	String
appointmentStartDate	The appointment date time is expressed as a range. Use this parameter to specify the start of that range in the format YYYY-MM-DD HH:MM:SS. All dates will be read in the UTC timezone	Date
appointmentEndDate	The appointment date time is expressed as a range. Use this parameter to specify the end of that range in the format YYYY-MM-DD HH:MM:SS. All dates will be read in the UTC timezone	Date
firstResult	Use this parameter to retrieve results beyond the initial 200 returned, results 0 - 199. If you want to view results 200 - 399, set firstResult to 200.	String

/appointment/{id}

Action : GET
Description: Obtains the appointment info for the passed appointment id. A user must own the appointment or have the proper permissions in order to access the appointment data. To pull additional information on Inspector or Agent records utilize the /inspector and /realtor API calls and pass the respective id provided in the /appointment data.

Parameter	Description	Data Type
id	The Appointment ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/appointment/uploadreport/{id}

Action : POST
EncType: multipart/form-data
Description: Upload a report for the passed appointment id. A user must own the appointment or have the proper permissions in order to upload the report. Upon success the appointment status will be changed to completed.

Parameter	Description	Data Type
id	The Appointment ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String
reportFile	The Report File	File
reportType	The type of report being uploaded. Reference /reporttypes for options.	String
sendReport	Set this parameter to 'false' if you do not want to trigger an email when you upload the report. An email will only be sent if the client has an email setup for report delivery and all conditions are met to send the email. i.e. Inspection Paid, Agreement Signed, etc	String

/appointment/uploadreportaslink/{id}

Action : GET
Description: Upload a report as a link for the passed appointment id. Link should start with http:// or https:// and will be provided without alteration whenever referenced. A user must own the appointment or have the proper permissions in order to upload the report link. Upon success the appointment status will be changed to completed.

Parameter	Description	Data Type
id	The Appointment ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String
reportFileLink	The Link to Report File starting with http:// or https://	String
reportType	The type of report being uploaded. Reference /reporttypes for options.	String
reportFilefileName	The filename assocatiated with the linked file	String
sendReport	Set this parameter to 'false' if you do not want to trigger an email when you upload the report. An email will only be sent if the client has an email setup for report delivery and all conditions are met to send the email. i.e. Inspection Paid, Agreement Signed, etc	String

/appointment/listreports/{id}

Action : GET
Description: Retrieive a list of reports associated with the passed appointment id. A user must own the appointment or have the proper permissions in order to view the reports.

Parameter	Description	Data Type
id	The Appointment ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/appointment/getreport/{id}

Action : GET
Description: Retrieive the report associated with the passed image id. A user must own the appointment or have the proper permissions in order to download the report.

Parameter	Description	Data Type
id	The Image ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/appointment/uploadimage/{id}

Action : POST
EncType: multipart/form-data
Description: Upload an image to the passed appointment id. A user must own the appointment or have the proper permissions in order to upload the image.

Parameter	Description	Data Type
id	The Appointment ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String
imageFile	The Image File in jpg, png, or gif fomat	File
imageCaption	A caption for the image to be displayed when viewing the uploaded images for the appointment. Must be 255 characters or less	String

/appointment/listimages/{id}

Action : GET
Description: Retrieive a list of image descriptions associated with the passed appointment id. A user must own the appointment or have the proper permissions in order to view the image descriptions.

Parameter	Description	Data Type
id	The Appointment ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/appointment/getimage/{id}

Action : GET
Description: Retrieive the image file associated with the passed image id. A user must own the appointment or have the proper permissions in order to download the image.

Parameter	Description	Data Type
id	The Image ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/client/{id}

Action : GET
Description: Obtains the client data for the passed client id.

Parameter	Description	Data Type
id	The Client ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/inspector/{id}

Action : GET
Description: Obtains the inspector data for the passed inspector id. A user must own the inspector account or have the proper permissions in order to access the inspector data.

Parameter	Description	Data Type
id	The Inspector ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/realtor/{id}

Action : GET
Description: Obtains the Realtor data for the passed realtor id.

Parameter	Description	Data Type
id	The Realtor ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/realtor/image/{id}

Action : GET
Description: Obtains the Realtor Image for the passed realtor id. If the image does not exist an appropriate response will be received.

Parameter	Description	Data Type
id	The Realtor ID	String
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/inspectiontypes

Action : GET
Description: Obtain the possible inspection types for the designated inspector.

Parameter	Description	Data Type
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/appointmentstatuses

Action : GET
Description: Obtain the possible appointment status options for the designated inspector.

Parameter	Description	Data Type
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/propertyaccesstypes

Action : GET
Description: Obtain the property access type options for the designated inspector.

Parameter	Description	Data Type
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/propertyfoundations

Action : GET
Description: Obtain the property foundation options for the designated inspector.

Parameter	Description	Data Type
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/propertytypes

Action : GET
Description: Obtain the property type options for the designated inspector.

Parameter	Description	Data Type
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

/reporttypes

Action : GET
Description: Obtain the report type options for the designated inspector.

Parameter	Description	Data Type
integrationID	Integration ID	String
inspectorUsername	Inspector Username	String
inspectorPassword	Inspector Password	String

NXTInspekt RESTful API Documentation

Overview

API Endpoint

Integration ID

Inspector Username/Password