### Example JSON Response for Calendar Events Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ This is an example of the JSON response received when querying for calendar events by Case ID. The response is an array of objects, each representing a calendar event with details such as case information, dates, status, and appointment specifics. ```json [ { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2019-05-09T10:00:00", "toDate": "2019-05-09T15:30:00", "comments": "Tgggfgh", "status": { "id": 5, "description": "Overdue(Open)" }, "documentIDs": [], "createdDate": "2019-05-09T12:36:00-04:00", "appointment": { "appointmentID": 81615, "subject": "Appeal: ", "type": { "id": 3, "description": "Case-related (No Court) " }, "activityType": { "id": 21, "description": "Appeal" }, "address": " Ggggg", "isRecurrence": false, "isAllDayEvent": false, "attendingStaff": [ { "contactId": 1631752, "name": "Ilinykh, Andrey" } ], "location": { "contactId": 285118, "name": "All Defendants" }, "owner": { "id": 488, "name": "Ilinykh, Andrey", "contactID": 1631752 } } }, { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2022-01-04T10:00:00", "toDate": "2022-01-04T16:00:00", "comments": "", "status": { "id": 5, "description": "Overdue(Open)" }, "documentIDs": [], "createdDate": "2022-01-04T11:10:00-05:00", "appointment": { "appointmentID": 82809, "subject": "Appointment - ", "type": { "id": 3, "description": "Case-related (No Court) " }, "activityType": { "id": 51, "description": "Appointment_case-related" }, "address": "", "isRecurrence": false, "isAllDayEvent": false, "attendingStaff": [ { "contactId": 1152318, "name": "Cambs, Peter e." }, { "contactId": 1631752, "name": "Ilinykh, Andrey" } ], "owner": { "id": 488, "name": "Ilinykh, Andrey", "contactID": 1631752 } } }, { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2022-03-10T10:00:00", "toDate": "2022-03-10T15:30:00", "comments": "Test", "status": { "id": 2, "description": "Canceled" }, "documentIDs": [], "createdDate": "2022-03-10T16:17:00-05:00", "modifiedDate": "2022-06-09T12:08:00-04:00", "appointment": { "appointmentID": 82862, "subject": "50H: ", "type": { "id": 3, "description": "Case-related (No Court) " }, "activityType": { "id": 150, "description": "50H" }, "address": "", "isRecurrence": false, "isAllDayEvent": false, "attendingStaff": [ { "contactId": 1631752, "name": "Ilinykh, Andrey" }, { "contactId": 1695568, "name": "Tim, Berton" } ], "owner": { "id": 488, "name": "Ilinykh, Andrey", "contactID": 1631752 } }, "adjournedOrCanceledInfo": { "canceled": true, "changedByLastName": "Ilinykh", "changedByFirstName": "Andrey", "party": "", "reason": "Consent", "approvedBy": "", "adjournComments": "" } }, { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2022-03-30T10:00:00", "toDate": "2022-03-30T15:30:00", "comments": "", "status": { "id": 2, "description": "Canceled" }, "documentIDs": [], "createdDate": "2022-03-30T11:06:00-04:00", "modifiedDate": "2022-06-09T12:42:00-04:00", "appointment": { "appointmentID": 82876, "subject": "Adverse Exam: ", "type": { "id": 3, "description": "Case-related (No Court) " }, "activityType": { "id": 183, "description": "Adverse Exam" }, "address": "", "isRecurrence": false, "isAllDayEvent": false } } ] ``` -------------------------------- ### GET /websites/documenter_getpostman_view_5921778_uvejm5kq Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Retrieves a list of appointments for a given case. ```APIDOC ## GET /websites/documenter_getpostman_view_5921778_uvejm5kq ### Description Retrieves a list of appointments associated with a specific case. The response includes details such as case ID, appointment times, comments, status, and attending staff. ### Method GET ### Endpoint /websites/documenter_getpostman_view_5921778_uvejm5kq ### Parameters #### Query Parameters - **caseID** (integer) - Required - The unique identifier for the case. ### Request Example ```json { "example": "GET /websites/documenter_getpostman_view_5921778_uvejm5kq?caseID=516718" } ``` ### Response #### Success Response (200) - **caseID** (integer) - The ID of the case. - **caseNumber** (string) - The number of the case. - **fromDate** (string) - The start date and time of the appointment (ISO 8601 format). - **toDate** (string) - The end date and time of the appointment (ISO 8601 format). - **comments** (string) - Any comments associated with the appointment. - **status** (object) - The status of the appointment. - **id** (integer) - The ID of the status. - **description** (string) - The description of the status. - **documentIDs** (array) - A list of document IDs associated with the appointment. - **createdDate** (string) - The date and time the appointment was created (ISO 8601 format). - **appointment** (object) - Details of the appointment. - **appointmentID** (integer) - The unique ID of the appointment. - **subject** (string) - The subject of the appointment. - **type** (object) - The type of the appointment. - **id** (integer) - The ID of the appointment type. - **description** (string) - The description of the appointment type. - **activityType** (object) - The activity type of the appointment. - **id** (integer) - The ID of the activity type. - **description** (string) - The description of the activity type. - **address** (string) - The address associated with the appointment. - **isRecurrence** (boolean) - Indicates if the appointment is a recurrence. - **isAllDayEvent** (boolean) - Indicates if the appointment is an all-day event. - **attendingStaff** (array) - A list of staff attending the appointment. - **contactId** (integer) - The contact ID of the staff member. - **name** (string) - The name of the staff member. - **owner** (object) - The owner of the appointment. - **id** (integer) - The ID of the owner. - **name** (string) - The name of the owner. - **contactID** (integer) - The contact ID of the owner. #### Response Example ```json { "example": [ { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2025-02-03T17:16:00-05:00", "toDate": "2025-02-03T17:46:00-05:00", "comments": "

Test

", "status": { "id": 5, "description": "Overdue(Open)" }, "documentIDs": [], "createdDate": "2025-02-03T17:16:00-05:00", "appointment": { "appointmentID": 84548, "subject": "50H: ", "type": { "id": 3, "description": "Case-related (No Court)" }, "activityType": { "id": 150, "description": "50H" }, "address": "", "isRecurrence": false, "isAllDayEvent": false, "attendingStaff": [ { "contactId": 1631752, "name": "Ilinykh, Andrey" } ], "owner": { "id": 488, "name": "Ilinykh, Andrey", "contactID": 1631752 } } } ] } ``` ``` -------------------------------- ### GET /cases Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Retrieves a list of cases including appointment details, status, and associated staff members. ```APIDOC ## GET /cases ### Description Retrieves a collection of case records, including scheduling information, appointment subjects, and assigned staff. ### Method GET ### Endpoint /cases ### Parameters #### Query Parameters - **caseID** (integer) - Optional - Filter results by specific case ID. ### Request Example GET /cases ### Response #### Success Response (200) - **caseID** (integer) - Unique identifier for the case. - **caseNumber** (string) - The reference number for the case. - **appointment** (object) - Details regarding the scheduled appointment. - **status** (object) - Current status of the case. #### Response Example { "caseID": 516718, "caseNumber": "9000002", "appointment": { "appointmentID": 89943, "subject": "appointment with client", "address": "6 Park harbor, Port Washington, NY 11050" } } ``` -------------------------------- ### GET /appointments Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ#intro Retrieves a list of appointments. Supports filtering by case number and date ranges. ```APIDOC ## GET /appointments ### Description Retrieves a list of appointments. Supports filtering by case number and date ranges. ### Method GET ### Endpoint /appointments ### Parameters #### Query Parameters - **caseNumber** (string) - Optional - Filters appointments by case number. - **fromDate** (string) - Optional - Filters appointments from a specific start date and time (ISO 8601 format). - **toDate** (string) - Optional - Filters appointments up to a specific end date and time (ISO 8601 format). ### Request Example ``` GET /appointments?caseNumber=9000002&fromDate=2026-01-20T12:00:00&toDate=2026-01-20T12:30:00 ``` ### Response #### Success Response (200) - **appointments** (array) - A list of appointment objects. - **caseNumber** (string) - The case number associated with the appointment. - **fromDate** (string) - The start date and time of the appointment (ISO 8601 format). - **toDate** (string) - The end date and time of the appointment (ISO 8601 format). - **comments** (string) - Comments related to the appointment. - **status** (object) - The status of the appointment. - **id** (integer) - The status ID. - **description** (string) - The status description. - **documentIDs** (array) - A list of document IDs associated with the appointment. - **createdDate** (string) - The date and time the appointment was created (ISO 8601 format). - **appointment** (object) - Details of the appointment. - **appointmentID** (integer) - The unique identifier for the appointment. - **subject** (string) - The subject of the appointment. - **type** (object) - The type of appointment. - **id** (integer) - The type ID. - **description** (string) - The type description. - **activityType** (object) - The activity type of the appointment. - **id** (integer) - The activity type ID. - **address** (string) - The address of the appointment location. - **isRecurrence** (boolean) - Indicates if the appointment is a recurring event. - **isAllDayEvent** (boolean) - Indicates if the appointment is an all-day event. - **attendingStaff** (array) - A list of staff attending the appointment. - **contactId** (integer) - The contact ID of the staff member. - **name** (string) - The name of the staff member. - **judge** (object) - Information about the judge for the appointment. - **contactId** (integer) - The contact ID of the judge. - **name** (string) - The name of the judge. - **location** (object) - Information about the appointment location. - **contactId** (integer) - The contact ID of the location. - **name** (string) - The name of the location. - **owner** (object) - Information about the owner of the appointment. - **id** (integer) - The owner's ID. - **name** (string) - The owner's name. - **contactID** (integer) - The owner's contact ID. #### Response Example ```json [ { "caseNumber": "9000002", "fromDate": "2026-01-20T12:00:00", "toDate": "2026-01-20T12:30:00", "comments": "some test comments", "status": { "id": 1, "description": "Open" }, "documentIDs": [ 3173710 ], "createdDate": "2026-01-20T10:40:00-05:00", "appointment": { "appointmentID": 89943, "subject": "appointment with client", "type": { "id": 3, "description": "Case-related (No Court)" }, "activityType": { "id": 20 }, "address": " 6 Park harbor, Port Washington, NY 11050", "isRecurrence": false, "isAllDayEvent": false, "attendingStaff": [ { "contactId": 1631752, "name": "Ilinykh, Andrey" } ], "judge": { "contactId": 1631752, "name": "Ilinykh, Andrey" }, "location": { "contactId": 285118, "name": "All Defendants" }, "owner": { "id": 488, "name": "Ilinykh, Andrey", "contactID": 1631752 } } } ] ``` ``` -------------------------------- ### GET /cases/appointments Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Retrieves a list of appointments associated with specific cases, including timing, staff, and location details. ```APIDOC ## GET /cases/appointments ### Description Retrieves a collection of case appointments including scheduling details, attending staff, and location information. ### Method GET ### Endpoint /cases/appointments ### Parameters #### Query Parameters - **caseNumber** (string) - Optional - Filter appointments by specific case number. ### Request Example GET /cases/appointments?caseNumber=9000002 ### Response #### Success Response (200) - **caseID** (integer) - Unique identifier for the case. - **caseNumber** (string) - The case reference number. - **fromDate** (string) - Start timestamp of the appointment. - **toDate** (string) - End timestamp of the appointment. - **appointment** (object) - Detailed object containing subject, location, and staff information. #### Response Example [ { "caseNumber": "9000002", "fromDate": "2026-01-20T12:00:00", "toDate": "2026-01-20T12:30:00", "appointment": { "appointmentID": 89943, "subject": "appointment with client", "address": "6 Park harbor, Port Washington, NY 11050" } } ] ``` -------------------------------- ### GET /cases/appointments Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Retrieves a list of appointments associated with specific cases, including scheduling details and status. ```APIDOC ## GET /cases/appointments ### Description Retrieves a collection of case appointments including metadata such as case ID, status, and staff attendance. ### Method GET ### Endpoint /cases/appointments ### Parameters #### Query Parameters - **caseID** (integer) - Optional - Filter appointments by specific case ID. ### Request Example GET /cases/appointments?caseID=516718 ### Response #### Success Response (200) - **caseID** (integer) - The ID of the associated case. - **caseNumber** (string) - The reference number of the case. - **appointment** (object) - Details regarding the scheduled appointment. - **status** (object) - Current status of the appointment. #### Response Example { "caseID": 516718, "caseNumber": "9000002", "appointment": { "appointmentID": 84550, "subject": "50H: ", "isAllDayEvent": false }, "status": { "id": 5, "description": "Overdue(Open)" } } ``` -------------------------------- ### GET /cases/appointments Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Retrieves a list of appointments associated with specific cases, including timing, status, and participant details. ```APIDOC ## GET /cases/appointments ### Description Retrieves a collection of case appointments, including metadata such as case ID, appointment status, and attending staff. ### Method GET ### Endpoint /cases/appointments ### Parameters #### Query Parameters - **caseID** (integer) - Optional - Filter appointments by specific case ID. ### Request Example GET /cases/appointments?caseID=516718 ### Response #### Success Response (200) - **caseID** (integer) - The unique identifier for the case. - **caseNumber** (string) - The human-readable case number. - **fromDate** (string) - Start date and time of the appointment. - **toDate** (string) - End date and time of the appointment. - **status** (object) - Current status of the appointment. - **appointment** (object) - Detailed appointment information including subject, type, and staff. #### Response Example { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2024-06-03T15:00:00", "toDate": "2024-06-03T21:00:00", "status": { "id": 5, "description": "Overdue(Open)" }, "appointment": { "appointmentID": 83969, "subject": "Appointment - test appointment 5", "isAllDayEvent": false } } ``` -------------------------------- ### GET /cases/appointments Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ#intro Retrieves a list of appointments associated with cases, including details on status, duration, and assigned staff. ```APIDOC ## GET /cases/appointments ### Description Retrieves a collection of case appointments, including scheduling information, status, and associated staff members. ### Method GET ### Endpoint /cases/appointments ### Parameters #### Query Parameters - **caseID** (integer) - Optional - Filter appointments by specific case ID. ### Response #### Success Response (200) - **caseID** (integer) - The ID of the associated case. - **caseNumber** (string) - The reference number of the case. - **fromDate** (string) - Start date and time of the appointment. - **toDate** (string) - End date and time of the appointment. - **status** (object) - Current status of the appointment. - **appointment** (object) - Detailed appointment information including subject, type, and attending staff. #### Response Example { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2024-06-03T15:00:00", "toDate": "2024-06-03T21:00:00", "status": { "id": 5, "description": "Overdue(Open)" }, "appointment": { "appointmentID": 83969, "subject": "Appointment - test appointment 5", "attendingStaff": [ { "contactId": 1152318, "name": "Cambs, Peter e." } ] } } ``` -------------------------------- ### GET /case/calendar/byCaseNumber Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Retrieves a list of calendar appointments and events associated with a specific case number. ```APIDOC ## GET /case/calendar/byCaseNumber ### Description Retrieves all calendar entries, including appointments and events, linked to a specific case number. ### Method GET ### Endpoint https://app.smartadvocate.com/CaseSyncAPI/case/calendar/byCaseNumber ### Parameters #### Query Parameters - **CaseNumber** (string) - Required - The unique identifier for the case. ### Request Example ```curl curl --location 'https://app.smartadvocate.com/CaseSyncAPI/case/calendar/byCaseNumber?CaseNumber=9000002' \ --header 'Authorization: Bearer {{APIToken}}' ``` ### Response #### Success Response (200) - **Array** (object) - A list of calendar event objects containing caseID, caseNumber, dates, status, and appointment details. #### Response Example ```json [ { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2019-05-09T10:00:00", "toDate": "2019-05-09T15:30:00", "status": { "id": 5, "description": "Overdue(Open)" }, "appointment": { "subject": "Appeal: ", "isRecurrence": false } } ] ``` ``` -------------------------------- ### Get Calendar by Case Number (cURL) Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ This snippet demonstrates how to make a GET request to the SmartAdvocate API to retrieve calendar events for a given case number. It requires an authorization token and specifies the case number as a query parameter. The response is a JSON array of calendar event objects. ```curl curl --location 'https://app.smartadvocate.com/CaseSyncAPI/case/calendar/byCaseNumber?CaseNumber=9000002' \ --header 'AUTHORIZATION: Bearer {{APIToken}}' ``` -------------------------------- ### GET /api/cases/appointments Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ#intro Retrieves a list of appointments associated with specific cases, including details on staff, status, and event timing. ```APIDOC ## GET /api/cases/appointments ### Description Retrieves a list of case appointments, including metadata such as case numbers, status, and attendee information. ### Method GET ### Endpoint /api/cases/appointments ### Parameters #### Query Parameters - **caseID** (integer) - Optional - Filter appointments by specific case ID. ### Request Example GET /api/cases/appointments?caseID=516718 ### Response #### Success Response (200) - **caseID** (integer) - The unique identifier for the case. - **caseNumber** (string) - The human-readable case number. - **appointment** (object) - Detailed object containing subject, type, address, and attending staff. #### Response Example { "caseID": 516718, "caseNumber": "9000002", "appointment": { "appointmentID": 83967, "subject": "Appointment - test appointment 3", "attendingStaff": [ { "contactId": 1152318, "name": "Cambs, Peter e." } ] } } ``` -------------------------------- ### GET /case/calendar/byCaseNumber Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ#intro Retrieves calendar events for a given case number. Requires Bearer Token authorization. ```APIDOC ## GET /case/calendar/byCaseNumber ### Description Retrieves a list of calendar events associated with a specific case number. ### Method GET ### Endpoint https://app.smartadvocate.com/CaseSyncAPI/case/calendar/byCaseNumber ### Parameters #### Query Parameters - **CaseNumber** (string) - Required - The case number to filter calendar events by. ### Request Example ``` curl --location 'https://app.smartadvocate.com/CaseSyncAPI/case/calendar/byCaseNumber?CaseNumber=9000002' ``` ### Response #### Success Response (200) - **caseID** (integer) - The ID of the case. - **caseNumber** (string) - The case number. - **fromDate** (string) - The start date and time of the event. - **toDate** (string) - The end date and time of the event. - **comments** (string) - Any comments associated with the event. - **status** (object) - The status of the event. - **id** (integer) - The status ID. - **description** (string) - The status description. - **documentIDs** (array) - A list of document IDs associated with the event. - **createdDate** (string) - The date and time the event was created. - **modifiedDate** (string, optional) - The date and time the event was last modified. - **appointment** (object) - Details about the appointment. - **appointmentID** (integer) - The ID of the appointment. - **subject** (string) - The subject of the appointment. - **type** (object) - The type of appointment. - **id** (integer) - The type ID. - **description** (string) - The type description. - **activityType** (object) - The activity type of the appointment. - **id** (integer) - The activity type ID. - **description** (string) - The activity type description. - **address** (string) - The address of the appointment. - **isRecurrence** (boolean) - Whether the event is a recurrence. - **isAllDayEvent** (boolean) - Whether the event is an all-day event. - **attendingStaff** (array) - A list of staff attending the appointment. - **contactId** (integer) - The contact ID of the staff member. - **name** (string) - The name of the staff member. - **location** (object, optional) - The location of the appointment. - **contactId** (integer) - The contact ID of the location. - **name** (string) - The name of the location. - **owner** (object) - The owner of the appointment. - **id** (integer) - The owner ID. - **name** (string) - The owner's name. - **contactID** (integer) - The owner's contact ID. - **adjournedOrCanceledInfo** (object, optional) - Information about adjournment or cancellation. - **canceled** (boolean) - Indicates if the event was canceled. - **changedByLastName** (string) - Last name of the person who changed the status. - **changedByFirstName** (string) - First name of the person who changed the status. - **party** (string) - The party involved. - **reason** (string) - The reason for cancellation or adjournment. - **approvedBy** (string) - Who approved the change. - **adjournComments** (string) - Comments regarding adjournment. #### Response Example ```json [ { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2019-05-09T10:00:00", "toDate": "2019-05-09T15:30:00", "comments": "Tgggfgh", "status": { "id": 5, "description": "Overdue(Open)" }, "documentIDs": [], "createdDate": "2019-05-09T12:36:00-04:00", "appointment": { "appointmentID": 81615, "subject": "Appeal: ", "type": { "id": 3, "description": "Case-related (No Court) " }, "activityType": { "id": 21, "description": "Appeal" }, "address": " Ggggg", "isRecurrence": false, "isAllDayEvent": false, "attendingStaff": [ { "contactId": 1631752, "name": "Ilinykh, Andrey" } ], "location": { "contactId": 285118, "name": "All Defendants" }, "owner": { "id": 488, "name": "Ilinykh, Andrey", "contactID": 1631752 } } } ] ``` ``` -------------------------------- ### Get Calendar by CaseID using cURL Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ This snippet demonstrates how to fetch calendar events associated with a specific case ID using a cURL command. It requires an authorization token for access. The output is a JSON array of calendar events. ```curl curl --location 'https://app.smartadvocate.com/CaseSyncAPI/case/516718/calendar' ``` -------------------------------- ### GET /case/{caseID}/calendar Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Retrieves a list of calendar appointments and events associated with a specific case ID. ```APIDOC ## GET /case/{caseID}/calendar ### Description Retrieves all calendar appointments and events linked to a specific case ID. Requires a valid Bearer Token for authorization. ### Method GET ### Endpoint https://app.smartadvocate.com/CaseSyncAPI/case/{caseID}/calendar ### Parameters #### Path Parameters - **caseID** (integer) - Required - The unique identifier of the case. ### Request Example ``` curl --location 'https://app.smartadvocate.com/CaseSyncAPI/case/516718/calendar' \ --header 'Authorization: Bearer {{APIToken}}' ``` ### Response #### Success Response (200) - **caseID** (integer) - The ID of the case. - **caseNumber** (string) - The case number. - **fromDate** (string) - Start date and time of the appointment. - **toDate** (string) - End date and time of the appointment. - **status** (object) - Status details of the appointment. - **appointment** (object) - Detailed information about the appointment, including subject, type, and attendees. #### Response Example ```json [ { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2019-05-09T10:00:00", "toDate": "2019-05-09T15:30:00", "status": { "id": 5, "description": "Overdue(Open)" }, "appointment": { "appointmentID": 81615, "subject": "Appeal: " } } ] ``` ``` -------------------------------- ### GET /case/{caseID}/calendar Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ#intro Retrieves a list of calendar appointments for a specific case identified by its CaseID. ```APIDOC ## GET /case/{caseID}/calendar ### Description Retrieves all calendar appointments associated with a specific case ID. This endpoint requires a valid Bearer Token for authorization. ### Method GET ### Endpoint https://app.smartadvocate.com/CaseSyncAPI/case/{caseID}/calendar ### Parameters #### Path Parameters - **caseID** (integer) - Required - The unique identifier of the case. ### Request Example ``` curl --location 'https://app.smartadvocate.com/CaseSyncAPI/case/516718/calendar' \ --header 'Authorization: Bearer {{APIToken}}' ``` ### Response #### Success Response (200) - **caseID** (integer) - The ID of the case. - **caseNumber** (string) - The case number. - **fromDate** (string) - Start date and time of the appointment. - **toDate** (string) - End date and time of the appointment. - **appointment** (object) - Details regarding the appointment subject, type, and staff. #### Response Example ```json [ { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2019-05-09T10:00:00", "toDate": "2019-05-09T15:30:00", "appointment": { "appointmentID": 81615, "subject": "Appeal: " } } ] ``` ``` -------------------------------- ### POST /Users/authenticate Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Authenticates a user and returns a token for subsequent API requests. ```APIDOC ## POST /Users/authenticate ### Description Authenticates a user with provided credentials and returns an access token. ### Method POST ### Endpoint https://app.smartadvocate.com/CaseSyncAPI/Users/authenticate ### Parameters #### Request Body - **Username** (string) - Required - The username for authentication. - **Password** (string) - Required - The password for authentication. ### Request Example ```json { "Username":"test", "Password":"test123" } ``` ### Response #### Success Response (200) - **username** (string) - The authenticated username. - **userID** (integer) - The unique identifier for the user. - **token** (string) - The JWT token for accessing protected resources. #### Response Example ```json { "username": "test", "userID": 677, "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3NyIsImhvc3QiOiIiLCJuYmYiOjE2MjA2NjU2MjYsImV4cCI6MTYyMDY3MjgyNiwiaWF0IjoxNjIwNjY1NjI2LCJpc3MiOiJTbWFydEFkdm9jYXRlVGVzdCJ9.LA2ObLE4AAa_DvoYGSBP0A44aonFB_O7mqKcrZYrLXc" } ``` ``` -------------------------------- ### HTTP Response Headers Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ This snippet outlines common HTTP response headers returned by a web server. It includes Content-Length, Content-Type, Date, and Server information, which are crucial for understanding the response size, format, and server details. ```http Content-Length: 3820 Content-Type: application/json Date: Tue, 20 Jan 2026 16:33:43 GMT Server: Kestrel ``` -------------------------------- ### Display Appointment and Case Data (JSON) Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ This JSON snippet represents a single record containing case details and associated appointment information. It includes case ID, case number, date/time information, comments, status, and appointment specifics like subject, type, and attending staff. This format is typical for data exchange between systems. ```json { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2025-02-04T12:00:00", "toDate": "2025-02-04T12:30:00", "comments": "

Test emails

", "status": { "id": 5, "description": "Overdue(Open)" }, "documentIDs": [], "createdDate": "2025-02-04T11:40:00-05:00", "appointment": { "appointmentID": 84554, "subject": "50H: ", "type": { "id": 3, "description": "Case-related (No Court) " }, "activityType": { "id": 150, "description": "50H" }, "address": "", "isRecurrence": false, "isAllDayEvent": false, "attendingStaff": [ { "contactId": 1631752, "name": "Ilinykh, Andrey" }, { "contactId": 1672480, "name": "Krasnov, Yana a." } ], "owner": { "id": 488, "name": "Ilinykh, Andrey", "contactID": 1631752 } } } ``` -------------------------------- ### JSON API Response Structure Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ This snippet represents a typical JSON response from an API, detailing case information. It includes arrays for parties, owner objects, and adjournment/cancellation details. This structure is common for managing case-related data. ```json { "parties": [ { "id": 12345, "name": "Ilchyshyn, Iryna J." } ], "owner": { "id": 719, "name": "Ilchyshyn, Iryna J.", "contactID": 1699140 }, "adjournedOrCanceledInfo": { "canceled": false, "newFromDate": "2026-01-26T00:00:00", "newToDate": "2026-01-26T23:59:00", "changedByLastName": "Ilchyshyn", "changedByFirstName": "Iryna", "party": "All Parties", "reason": "Court Order", "approvedBy": "Owens, Sally", "adjournComments": "" } } ``` -------------------------------- ### Case Appointment JSON Schema Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ#intro A sample JSON object representing a single case appointment entry. It contains metadata such as case IDs, date ranges, status, and nested appointment details. ```json { "caseID": 516718, "caseNumber": "9000002", "fromDate": "2024-06-03T15:00:00", "toDate": "2024-06-03T21:00:00", "comments": "test appointment 5", "status": { "id": 5, "description": "Overdue(Open)" }, "documentIDs": [], "createdDate": "2024-05-31T15:45:00-04:00", "appointment": { "appointmentID": 83969, "subject": "Appointment - test appointment 5", "type": { "id": 3, "description": "Case-related (No Court)" }, "activityType": { "id": 126 }, "address": "", "isRecurrence": false, "isAllDayEvent": false, "attendingStaff": [ { "contactId": 1152318, "name": "Cambs, Peter e." }, { "contactId": 1631752, "name": "Ilinykh, Andrey" } ], "owner": { "id": 488, "name": "Ilinykh, Andrey", "contactID": 1631752 } } } ``` -------------------------------- ### POST /case/calendar/byDatePaged Source: https://documenter.getpostman.com/view/5921778/UVeJM5kQ Retrieves a paginated list of calendar events for cases modified within a specified date range. ```APIDOC ## POST /case/calendar/byDatePaged ### Description Retrieves a paginated list of calendar events for cases based on a modified date range. Requires a Bearer Token for authentication. ### Method POST ### Endpoint https://app.smartadvocate.com/CaseSyncAPI/case/calendar/byDatePaged ### Parameters #### Request Body - **modifiedFromDateTime** (string) - Required - Start date/time for the modification filter (ISO 8601). - **modifiedToDateTime** (string) - Required - End date/time for the modification filter (ISO 8601). - **caseNumbers** (array) - Optional - List of specific case numbers to filter by. - **pageRequest** (object) - Required - Pagination configuration. - **currentPage** (integer) - Required - The page index to retrieve. - **pageSize** (integer) - Required - Number of records per page. ### Request Example { "modifiedFromDateTime": "2026-01-01T05:00:00.0000000+00:00", "modifiedToDateTime": "2026-01-07T01:16:18.2190000+00:00", "caseNumbers": [], "pageRequest": { "currentPage": 0, "pageSize": 5 } } ### Response #### Success Response (200) - **caseID** (integer) - The unique identifier of the case. - **caseNumber** (string) - The formatted case number. - **fromDate** (string) - Start date of the appointment. - **toDate** (string) - End date of the appointment. - **status** (object) - Status details of the calendar event. - **appointment** (object) - Detailed appointment information including subject, type, and attending staff. #### Response Example [ { "caseID": 519920, "caseNumber": "5 - 000010", "fromDate": "2026-01-26T00:00:00", "toDate": "2026-01-26T23:59:00", "status": { "id": 1, "description": "Open" }, "appointment": { "appointmentID": 89923, "subject": "Appointment - ", "isAllDayEvent": true } } ] ```