Addresses
API for interacting with Addresses. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Addresses | Deletes the addresses for the associated sync session. |
| POST api/Addresses | Applies the exclusions to the existing |
| GET api/Addresses?pageSize={pageSize}&pageNum={pageNum} | Gets the addresses for the associated sync session. |
ClientCustomFields
API for interacting with ClientCustomField. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/ClientCustomFields | Deletes the ClientCustomField for the associated sync session. |
| POST api/ClientCustomFields | Applies the exclusions to the existing |
| GET api/ClientCustomFields?pageSize={pageSize}&pageNum={pageNum} | Gets the ClientCustomFields for the associated sync session. |
ClientPatientRelationships
API for interacting with ClientPatientRelationship. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/ClientPatientRelationships | Deletes the ClientPatientRelationship for the associated sync session. |
| POST api/ClientPatientRelationships | Applies the exclusions to the existing |
| GET api/ClientPatientRelationships?pageSize={pageSize}&pageNum={pageNum} | Gets the ClientPatientRelationships for the associated sync session. |
Clients
API for interacting with Clients. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Clients | Deletes the addresses for the associated sync session. |
| POST api/Clients | Applies the exclusions to the existing |
| GET api/Clients?pageSize={pageSize}&pageNum={pageNum} | Gets the Clients for the associated sync session. |
CodeEntities
API for interacting with CodeEntities. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/CodeEntities | Deletes the CodeEntities for the associated sync session. |
| POST api/CodeEntities | Applies the exclusions to the existing |
| GET api/CodeEntities?pageSize={pageSize}&pageNum={pageNum} | Gets the CodeEntities for the associated sync session. |
Reports
Methods
| API | Description |
|---|---|
| POST api/CustomSyncReport | |
| DELETE api/Reports/{customerNumber}/{reportNumber} | Deletes the report, including all of the associated data. |
| GET api/Reports/{reportNumber}/Addresses?pageSize={pageSize}&pageNum={pageNum} | Gets the addresses for the requested report. |
| GET api/Reports/{reportNumber}/ClientCustomFieldEntities?pageSize={pageSize}&pageNum={pageNum} | Gets the ClientCustomFieldEntities for the requested report. |
| GET api/Reports/{reportNumber}/ClientPatientRelationships?pageSize={pageSize}&pageNum={pageNum} | Gets the ClientPatientRelationships for the requested report. |
| GET api/Reports/{reportNumber}/Clients?pageSize={pageSize}&pageNum={pageNum} | Gets the Clients for the requested report. |
| GET api/Reports/{reportNumber}/Codes?pageSize={pageSize}&pageNum={pageNum} | Gets the Codes for the requested report. |
| GET api/Reports/{reportNumber}/Emails?pageSize={pageSize}&pageNum={pageNum} | Gets the Emails for the requested report. |
| GET api/Reports/{reportNumber}/Invoices?pageSize={pageSize}&pageNum={pageNum} | Gets the Invoices for the requested report. |
| GET api/Reports/{reportNumber}/LabPanels?pageSize={pageSize}&pageNum={pageNum} | Gets the LabPanels for the requested report. |
| GET api/Reports/{reportNumber}/LabTestResults?pageSize={pageSize}&pageNum={pageNum} | Gets the LabTestResults for the requested report. |
| GET api/Reports/{reportNumber}/MedicalHistories?pageSize={pageSize}&pageNum={pageNum} | Gets the MedicalHistories for the requested report. |
| GET api/Reports/{reportNumber}/PatientCustomFields?pageSize={pageSize}&pageNum={pageNum} | Gets the PatientCustomFields for the requested report. |
| GET api/Reports/{reportNumber}/PatientIdentifiers?pageSize={pageSize}&pageNum={pageNum} | Gets the PatientIdentifiers for the requested report. |
| GET api/Reports/{reportNumber}/Patients?pageSize={pageSize}&pageNum={pageNum} | Gets the Patients for the requested report. |
| GET api/Reports/{reportNumber}/Phones?pageSize={pageSize}&pageNum={pageNum} | Gets the Phones for the requested report. |
| GET api/Reports/{reportNumber}/Prescriptions?pageSize={pageSize}&pageNum={pageNum} | Gets the Prescriptions for the requested report. |
| GET api/Reports/{reportNumber}/Referrals?pageSize={pageSize}&pageNum={pageNum} | Gets the Referrals for the requested report. |
| GET api/Reports/{reportNumber}/ReferralSources?pageSize={pageSize}&pageNum={pageNum} | Gets the ReferralSources for the requested report. |
| GET api/Reports/{reportNumber}/Reminders?pageSize={pageSize}&pageNum={pageNum} | Gets the Reminders for the requested report. |
| GET api/Reports/{reportNumber}/Resources?pageSize={pageSize}&pageNum={pageNum} | Gets the Resources for the requested report. |
| GET api/Reports/{reportNumber}/Schedules?pageSize={pageSize}&pageNum={pageNum} | Gets the Schedules for the requested report. |
| GET api/Reports/{reportNumber}/Sites?pageSize={pageSize}&pageNum={pageNum} | Gets the Sites for the requested report. |
| GET api/Reports/{reportNumber}/Summary | Gets the overivew summary for the requested report. |
| GET api/Reports/{reportNumber}/Transactions?pageSize={pageSize}&pageNum={pageNum} | Gets the Transactions for the requested report. |
| GET api/Reports/{reportNumber}/Visits?pageSize={pageSize}&pageNum={pageNum} | Gets the Visits for the requested report. |
| GET api/Reports?requestedBy={requestedBy} | Gets the report requests for the associated user. |
Emails
API for interacting with Emails. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Emails | Deletes the Emails for the associated sync session. |
| POST api/Emails | Applies the exclusions to the existing |
| GET api/Emails?pageSize={pageSize}&pageNum={pageNum} | Gets the Emails for the associated sync session. |
Syncs
API for interacting with Sites. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| GET api/ExpiredSyncs/{pullapp}?days={days} | |
| DELETE api/Syncs | Deletes the Syncs, including all of the associated data, for the associated sync id or customer id. |
| POST api/Syncs/ApplyExclusions/{entityType} | Applies the exclusions to the existing syncs |
| GET api/Syncs/Exists?syncId={syncId} | Returns a 200 if sync exists in any cache, or a 404 if it does not exist in any cache. |
| DELETE api/Syncs/FastDelete | Deletes the syncs header record and schedules removal of all associated data, for the associated sync id or customer id. |
| GET api/Syncs?pageSize={pageSize}&pageNum={pageNum} | Gets the Syncs for the associated customer id. |
Invoices
API for interacting with Invoices. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Invoices | Deletes the Invoices for the associated sync session. |
| POST api/Invoices | Applies the exclusions to the existing |
| GET api/Invoices?pageSize={pageSize}&pageNum={pageNum} | Gets the Invoices for the associated sync session. |
LabPanels
API for interacting with LabPanels. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/LabPanels | Deletes the LabPanels for the associated sync session. |
| POST api/LabPanels | Applies the exclusions to the existing |
| GET api/LabPanels?pageSize={pageSize}&pageNum={pageNum} | Gets the LabPanels for the associated sync session. |
LabTestResults
API for interacting with LabTestResults. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/LabTestResults | Deletes the LabTestResults for the associated sync session. |
| POST api/LabTestResults | Applies the exclusions to the existing |
| GET api/LabTestResults?pageSize={pageSize}&pageNum={pageNum} | Gets the LabPanels for the associated sync session. |
MedicalHistories
API for interacting with MedicalHistories. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/MedicalHistories | Deletes the MedicalHistories for the associated sync session. |
| POST api/MedicalHistories | Applies the exclusions to the existing |
| GET api/MedicalHistories?pageSize={pageSize}&pageNum={pageNum} | Gets the LabPanels for the associated sync session. |
PatientCustomFields
API for interacting with PatientCustomField. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/PatientCustomFields | Deletes the PatientCustomField for the associated sync session. |
| POST api/PatientCustomFields | Applies the exclusions to the existing |
| GET api/PatientCustomFields?pageSize={pageSize}&pageNum={pageNum} | Gets the PatientCustomFields for the associated sync session. |
PatientIdentifiers
API for interacting with PatientIdentifiers. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/PatientIdentifiers | Deletes the PatientIdentifiers for the associated sync session. |
| POST api/PatientIdentifiers | Applies the exclusions to the existing |
| GET api/PatientIdentifiers?pageSize={pageSize}&pageNum={pageNum} | Gets the PatientIdentifiers for the associated sync session. |
Patients
API for interacting with Patients. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Patients | Deletes the Patients for the associated sync session. |
| POST api/Patients | Applies the exclusions to the existing |
| GET api/Patients?pageSize={pageSize}&pageNum={pageNum} | Gets the Patients for the associated sync session. |
Phones
API for interacting with Phones. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Phones | Deletes the Phones for the associated sync session. |
| POST api/Phones | Applies the exclusions to the existing |
| GET api/Phones?pageSize={pageSize}&pageNum={pageNum} | Gets the Phones for the associated sync session. |
Ping
Methods
| API | Description |
|---|---|
| GET api/PingTest | |
| HEAD api/PingTest |
Prescriptions
API for interacting with Prescriptions. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Prescriptions | Deletes the Prescriptions for the associated sync session. |
| POST api/Prescriptions | Applies the exclusions to the existing |
| GET api/Prescriptions?pageSize={pageSize}&pageNum={pageNum} | Gets the Prescriptions for the associated sync session. |
Referrals
API for interacting with Referrals. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Referrals | Deletes the Referral for the associated sync session. |
| POST api/Referrals | Applies the exclusions to the existing |
| GET api/Referrals?pageSize={pageSize}&pageNum={pageNum} | Gets the Referrals for the associated sync session. |
ReferralSources
API for interacting with ReferralSources. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/ReferralSources | Deletes the ReferralSources for the associated sync session. |
| POST api/ReferralSources | Applies the exclusions to the existing |
| GET api/ReferralSources?pageSize={pageSize}&pageNum={pageNum} | Gets the ReferralSources for the associated sync session. |
Reminders
API for interacting with Reminders. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Reminders | Deletes the Reminders for the associated sync session. |
| POST api/Reminders | Applies the exclusions to the existing |
| GET api/Reminders?pageSize={pageSize}&pageNum={pageNum} | Gets the Reminders for the associated sync session. |
Resources
API for interacting with Resources. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Resources | Deletes the Resources for the associated sync session. |
| POST api/Resources | Applies the exclusions to the existing |
| GET api/Resources?pageSize={pageSize}&pageNum={pageNum} | Gets the Resources for the associated sync session. |
Schedules
API for interacting with Schedules. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Schedules | Deletes the Schedules for the associated sync session. |
| POST api/Schedules | Applies the exclusions to the existing |
| GET api/Schedules?pageSize={pageSize}&pageNum={pageNum} | Gets the Schedules for the associated sync session. |
Sites
API for interacting with Sites. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Sites | Deletes the Sites for the associated sync session. |
| POST api/Sites | Applies the exclusions to the existing |
| GET api/Sites?pageSize={pageSize}&pageNum={pageNum} | Gets the Sites for the associated sync session. |
SyncHistories
API for interacting with SyncHistories. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/SyncHistories | Deletes the SyncHistories for the associated sync session. |
| POST api/SyncHistories | Applies the exclusions to the existing |
| GET api/SyncHistories?pageSize={pageSize}&pageNum={pageNum} | Gets the SyncHistories for the associated sync session. |
Transactions
API for interacting with Transactions. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Transactions | Deletes the Transactions for the associated sync session. |
| POST api/Transactions | Applies the exclusions to the existing |
| GET api/Transactions?pageSize={pageSize}&pageNum={pageNum} | Gets the Transactions for the associated sync session. |
Visits
API for interacting with Visits. The API expects the session id for the sync session in the header of all methods. The header should contain a value named 'sessionId' to ensure the client is interacting with a single sync session.
Methods
| API | Description |
|---|---|
| DELETE api/Visits | Deletes the Visits for the associated sync session. |
| POST api/Visits | Applies the exclusions to the existing |
| GET api/Visits?pageSize={pageSize}&pageNum={pageNum} | Gets the Visits for the associated sync session. |