{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"af2a4f0b-f261-466f-a73e-fa47a7244bbd","name":"4SIGHT Connect Data Reference","description":"![4SIGHT Connect Data.](https://4sightsolution.com/wp-content/uploads/2020/12/4sight_logo.svg \"4SIGHT Connect Data logo\") \n\n> The 4SIGHT Connect Data Reference documentation represents the data elements accessible for customers using the **4SIGHT Connect Data** product. \n>\n>> The product delivers data in two parts: \n>> * MQTT Delivering Data In Real-time.\n>> * RESTful API's\n\n**Need Help?** Contact [4SIGHT Connect Support](https://app.smartsheet.com/b/form/c05a4acfebf341aab81c266817204aa5).\n\n# 4SIGHT Status Codes\n| Status Code  | Message | Description|\n| :----: |:-:|:-:|\n| 200 | OK | Request Succeeded |\n| 207 | Multi Status | Multiple operations have happened, and the status for each operation can be found in the body of the response\n| 400 | Bad Request | Wrong information was provided |\n| 401 | Unauthorized | Provided credentials were incorrect, or account doesn't have access |\n| 404 | Not Found | Resource doesn’t exist |\n| 500 | Internal Server | Server-side errors |\n| 502 | bad gateway | Something wrong happened on the server |\n| 504 | Timeout | Server is not getting a response from upstream |\n\n# 4SIGHT Connect Data Message Elements\n> The table below provides the format, description, format, and character length of the message elements available in the 4SIGHT Connect Data product. \n>\n>> Link to the [4SIGHT Connect Data Message Elements](https://assaabloy.box.com/s/ryhjkeah3ko664zzxjx1nsyks6x505xs).\n\n| Message Element  | Description |Format| Char Length|\n| :----: |:-:|:-:|:-:|\n| site_id| Unique Header Value represents the tenant ID.|String|No Limit|\n| id| Unique Header Value represents the shipment ID.|String|24|\n| dock_id| Unique Header Value represents the dock ID. Dock ID can be retrieve using get docks rest API |String|24|\n| appointment_no| Appointment # associated to a shipment.No Appointment generates a system  generated number starting with NA.|String|50|\n| shipment_status| Shipment Status for a shipment. Values are : scheduled, arrived, turnedaway, departed, deleted|String|50|\n| reference_no| Represents a unique identifier like a PO|String|50|\n| schedule_date_time| Schedule Date and time 2020-01-09T11:56:14.998Z.Time needs to in UTC format|String|No Limit|\n| carrier_company| Carrier Company on the shipment associated to the schedule|String|50|\n| trailer_no| Trailer# associated on the schedule/shipment|String|50|\n| duration| Duration associated on the schedule/shipment. Handles up to 90 days in minutes (129600 minutes)Integer values in minutes. Minimum: 15 Maximum: 129600|6|\n| ship_to| Ship To associated on the schedule/shipment|String|100|\n| ship_from| Ship From associated on the schedule/shipment|String|100|\n| dock| Dock associated on the schedule/shipment. If other is entered other_location is required|String|5|\n| dock_location| Required if Other is selected in Dock for schedule/shipment|String|No Limit|\n| shipment_type| Shipment Type associated on the schedule/shipment. Values: inbound AND outbound|String|8|\n| load_type| Load Type associated on the schedule/shipment. Values:drop AND live|String|4|\n| quantity| Quantity associated on the schedule/shipment|String|10|\n| description| Description associated on the schedule/shipment|String|255|\n| ship_date| Ship Date associated on the schedule/shipment 2021-02-10T19:50:00.000Z (UTC format)|String|No Limit|\n| comments| Comments.associated on the schedule/shipment|String|255|\n| email_address| Email Address associated on the schedule. Could be one to many addresses associated with a schedule. Ex. test@email.com, read@email.com|String|50|\n| driver_name| Driver Name on the shipment|String|No limit|\n| driver_cell_no| Driver cell # on the shipment.Format example 14695125122 |String|No limit|\n| driver_signature| Driver signature on the shipment Link to the stored image filehttp://digitalgate.4sightconnect.net/tenantID/apptNo/drsignature.png|String|No limit|\n| equipment_type| Equipment type for a shipment. Values options, Bobtail, Trailer, Container, Flatbed AND Other Value |String|No limit|\n| driver_signature| Driver signature on the shipment Link to the stored image filehttp://digitalgate.4sightconnect.net/tenantID/apptNo/drsignature.png|String|No limit|\n| arrived_by| Arrived by on the shipment List for an Arrived status record.|String|No limit|\n| arrival_start_date_time| Time the driver starts the arrival process on the Driver Control or 4SIGHT Connect app using the Mobile Xpress features. 2020-01-09T11:56:14.998Z (UTC Format)|String|No limit|\n| arrival_date_time|Date and time the shipment arrived2020-01-09T11:56:14.998Z (UTC Format)|String|No limit|\n| departed_by| Departed by on the shipment List for an Departed status record.|String|No limit|\n| departed_start_date_time| Time the driver starts the departure process on the Driver Control or 4SIGHT Connect app using the Mobile Xpress features. 2020-01-09T11:56:14.998Z (UTC Format)|String|No limit|\n| departed_date_time| Date and time the shipment departed 2020-01-09T11:56:14.998Z (UTC Format)|String|No limit|\n| shipment_alert | For scheduled appointments for a shipment. Provides the following values. Early, Late and On Time |String|No limit|\n| turned_away_by| Turned Away by on the shipment List for an Turned Away status record. |String|No limit|\n| turned_away_date_time| Date and time the shipment turned away 2020-01-09T11:56:14.998Z (UTC Format).|String|No limit|\n| turned_away_reason| Reason the shipment was turned away. The values are: At Capacity, Impatient Driver, Too Early, Damaged, Late Appointment, No Appointment, Dirty, Other|String|16|\n| deleted_by| Who deleted a shipment record given it a shipment status of Deleted.|String|No limit|\n| deleted_date_time| Date and time the shipment was deleted 2020-01-09T11:56:14.998Z.(UTC Format)|String|No limit|\n| deleted_comments| Reason the shipment was deleted. |String|16|\n| is_pre_check_in| Provides if an appointment is preCheckIn or not. Pre checkIn is based on a user checking in with the 4SIGHT Connect App Mobile Xpress Features. True/False |Boolean||\n| date_from| date in the present 2020-01-09T11:56:14.998Z.(UTC Format) |String|No limit|\n| date_to| date in the past 2020-01-09T11:56:14.998Z.(UTC Format) |String|No limit|\n| date| Date in the present 2020-01-09T11:56:14.998Z.(UTC Format) |String|No limit|\n| available_times| Times available for a dock. In 60 minute time HH:MM-HH:MM |String|No limit|\n| limit| The number of data you are going to send. Maximum is 100, Example: 10 |String|No limit|\n| title| For the send push notification API. Title of Notification popup/windows displayed on the users phone when they received the notification. |String|50|\n| body| For the send push notification API. Body of Notification popup/windows displayed on the users phone when they received the notification. |String|500|\n\n\n\n# MQTT Delivering Data In Real-time\n> MQTT (Message Queuing Telemetry Transport) is an open OASIS and ISO standard (ISO/IEC 20922) lightweight, publish-subscribe network protocol that transports messages between devices.\n\n> # MQTT Connection Details\n\n| Message Element  | Description |Format|\n| :----: |:-:|:-:|\n| MQTT Client Name | This field is a free form and can be a descriptive representation of the application.| String |\n| MQTT ID| This field must be the API token shown in the API user credentials |String |\n| Protocol| The application uses MQTT/TLS protocol. | String |\n| URL| https://data.4sightconnect.net/.  |String|\n| SSL/TLS Certificate Type| CA Signed Server Certificate | String |\n| User Name/Password| API User Name for 4SIGHT Connect Data. This can be found in the data application at https://dg.4sightconnect.net/data#/. |String|\n| Qos | 0, 1 or 2 Message Dependent | String|\n| Subscribe/Publish  Topic| This field must be the API token that can be found in the data application at https://dg.4sightconnect.net/data#/. |String|\n\n> # Digital Dock & Digital Max Events\n\n > # Subscribe Events\n\n - Override Request (ORR)\n - Cancel Override Request (COR)\n - Trailer Presence SensorStatus (TPS)\n - Restraint Status (RE)\n - Override Status (ORS)\n - Door Open Status (DOR)\n - Door Closed Status (DOC)\n - Leveler Stored Status (LVL)\n - Post Release TPS Status (TPP)\n - Diagnostic Code(DAG)\n - Total Restraint Cycles (TRC)\n - Total Leveler Cycles (TLC)\n - Total Door Cycles (TDC)\n - Total Override Cycles (OCC)\n - Trailer Turn Time (TTT)\n - Trailer Load Time (TLT)\n - Gateway Status (GWS)\n\n\n> ## Override Request\n  >> * **Event Name: ORR\n    - Event Description: Dock position has issued a request to enter override mode due to a missed engagement with a trailer or loss of engagement with a trailer. Request from Dock for Override Authorization. A value of 1 = Request for Override Authorization. This will turn a check mark at the HMI that will allow the user to enable override without knowing the override password.\n  >> * **Payload:**\n   ```\n     {\n        “DockID”:”EUID”,\n        “SiteID”:”AccountName”,\n        “DockName”:”Dock Name”,\n        “Event”: [\n          {\n             “name”:”ORR”,\n             “value”:”0/1”,\n             “timestamp”:”2020-10-19T20: 15: 18.730000Z”\n          }\n        ]\n      }\n   ```\n\n> ## Cancel Override Request\n  >> * **Event Name: COR\n    - Event Description: Dock position has issued a cancel override request from the user of the HMI..\nA value of 1 = Cancel Override.\n  >> * **Payload:**\n   ```\n     {\n       “DockID”:”EUID”,\n       “SiteID”:”AccountName”,\n       “DockName”:”Dock Name”,\n       “Event”: [\n            {\n                “name”:”COR”,\n                “value”:”0/1”,\n                “timestamp”:”2020-10-19T20: 15: 18.730000Z”\n            }\n        ]\n      }\n   ```\n\n> ## Trailer Presence Sensor Status\n  >> * **Event Name: TPS\n    - Event Description: The sensor detects when a trailer arrives or departs from a dock position. A value of 1 = Trailer present\nA value of 1 = Cancel Override.\n  >> * **Payload:**\n   ```\n     {\n        “DockID”:”EUID”,\n        “SiteID”:”AccountName”,\n        “DockName”:”Dock Name”,\n        “Event”:[\n             {\n                 “name”:”TPS”,\n                 “value”:”0/1”,\n                 “timestamp”:”2020-10-19T20:15:18.730000Z”\n             }\n          ]\n     }\n   ```\n\n> ## Restraint Status\n  >> * **Event Name: CORER\n    - Event Description: Reports if the restraint is engaged or home. A value of 1 = Restraint Engaged. A value of 0 = Restraint Released. (It may still be in Override Mode)\n  >> * **Payload:**\n   ```\n     {\n         “DockID”:”EUID”,\n         “SiteID”:”AccountName”,\n         “DockName”:”Dock Name”,\n         “Event”:[\n              {\n                  “name”:”RE”,\n                  “value”:”0/1”,\n                  “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n           ]\n      }\n   ```\n\n> ## Override Status\n  >> * **Event Name: ORS\n    - Event Description: Reports if the restraint is in Override mode. A value of 1 = Restraint Override. A value of 0 = Restraint not in override mode. (It may still be engaged) \n  >> * **Payload:**\n   ```\n     {\n         “DockID”:”EUID”,\n         “SiteID”:”AccountName”,\n         “DockName”:”Dock Name”,\n         “Event”:[\n              {\n                  “name”:”ORS”,\n                  “value”:”0/1”,\n                  “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ]\n      }\n   ```\n\n> ## Door Open Status\n  >> * **Event Name: DOR\n    - Event Description: Reports if the Door Open sensor is ON indicating Door in OPEN position. A value of 1 = Door Open. A value of 0 = Door Not Open.\n  >> * **Payload:**\n   ```\n     {\n         “DockID”:”EUID”,\n         “SiteID”:”AccountName”,\n         “DockName”:”Dock Name”,\n         “Event”:[\n                  {\n                           “name”:”DOR”,\n                           “value”:”0/1”,\n                           “timestamp”:”2020-10-19T20:15:18.730000Z”\n                  }\n         ]\n     }\n   ```\n\n> ## Door Closed Status\n  >> * **Event Name: DOC\n    - Event Description: Event Description: Reports if the Door Closed sensor is ON indicating Door in CLOSED position. A value of 1 = Door Closed. A value of 0 = Door Not Closed.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”EUID”,\n          “SiteID”:”AccountName”,\n          “DockName”:”Dock Name”,\n          “Event”:[\n               {\n                    “name”:”DOC”,\n                    “value”:”0/1”,\n                    “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ]\n     }\n   ```\n\n> ## Leveler Status\n  >> * **Event Name: LVL\n    - Event Description: Reports the status of the Leveler Stored Sensor. A value of 1 = Leveler is stored. A value of 0 = Leveler is not stored.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”EUID”,\n          “SiteID”:”AccountName”,\n          “DockName”:”Dock Name”,\n          “Event”:[\n               {\n                    “name”:”LVL”,\n                    “value”:”0/1”,\n                    “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ]\n     }\n   ```\n\n> ## Post Release TPS Status\n  >> * **Event Name: TPP\n    - Event Description: Reports if a Trailer is detected at the dock position after the restraint has transitioned from Restraint Engage to Restraint Release. A value of 1 = Trailer Present, Restraint has been Released. A value of 0 = No trailer present or trailer present but Restraint has not been released.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”EUID”,\n          “SiteID”:”AccountName”,\n          “DockName”:”Dock Name”,\n          “Event”:[\n               {\n                    “name”:”TPP”,\n                    “value”:”0/1”,\n                    “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ]\n     }\n   ```\n\n> ## Diagnostic Code\n  >> * **Event Name: DAG\n    - Event Description: Diagnostic Error Code associated with Digital Master Control Panel. Please consult user manual for definition of code.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”EUID”,\n          “SiteID”:”AccountName”, \n          “DockName”:”Dock Name”, \n          “Event”:[\n               {\n                    “name”:”DAG”,\n                    “value”:”varies”, \n                    “timestamp”:”2020-10-19T20:15:18.730000Z” }\n          ] \n     }\n   ```\n\n> ## Total Restraint Cycles\n  >> * **Event Name: TRC\n    - Event Description: Total Restraint Cycles stored in PLC.  One cycle = Restraint Engaged -> Restraint Released. This value is for the life of the product.  This is an integer value\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”EUID”,\n          “SiteID”:”AccountName”, \n          “DockName”:”Dock Name”, \n          “Event”:[\n               {\n                    “name”:”TRC”,\n                    “value”:”varies”, \n                    “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ] \n     }\n   ```\n\n\n> ## Total Leveler Cycles\n  >> * **Event Name: TLC\n    - Event Description: Total Leveler Cycles stored in PLC.  One cycle = Running the Leveler pump motor. This value is for the life of the product.  This is an integer value.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”EUID”,\n          “SiteID”:”AccountName”, \n          “DockName”:”Dock Name”, \n          “Event”:[\n               {\n                    “name”:”TLC”,\n                    “value”:”varies”, \n                    “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ] \n     }\n   ```\n\n> ## Total Door Cycles\n  >> * **Event Name: TDC\n    - Event Description: Total Door Cycles stored in PLC. One cycle = Door Open-Door Close. This value is for the life of the product. This is an integer value.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”EUID”,\n          “SiteID”:”AccountName”,\n          “DockName”:”Dock Name”,\n          “Event”:[\n               {\n                    “name”:”TDC”,\n                    “value”:”varies”,\n                    “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ]\n     }\n   ```\n\n> ## Total Override Cycles\n  >> * **Event Name: OCC\n    - Event Description: Total Override Count stored in PLC. One count = Restraint Override = True. This value is for the life of the product. This is an integer value\n\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”EUID”,\n          “SiteID”:”AccountName”,\n          “DockName”:”Dock Name”,\n          “Event”:[\n               {\n                    “name”:”OCC”,\n                    “value”:”varies”,\n                    “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ]\n     }\n   ```\n\n\n> ## Trailer Turn Time\n  >> * **Event Name: TTT\n    - Event Description: This event gives the detail about the total time that trailer was present at the dock. Its difference between TPS=1 to TPS=0.\n  >>  * **Payload:**\n    ```\n      {\n          \"Account\": \"DVSITE\",\n          \"DockID\": \"0004A30B0027AD86\",\n          \"SiteID\": \"\",\n          \"DockName\": \"Daryl Desk\",\n          \"Event\": [\n              {\n                  \"name\": \"Trailer Turn Time\",\n                  \"value\": \"00:01:56\",\n                  \"timestamp\": \"2021-09-11T17:28:57.914Z\"\n              }\n          ]\n      }\n    ```\n\n> ## Trailer Load Time\n  >> * **Event Name: TLT\n    - Event Description: This event gives the detail about the total load time that restraint was engaged with trailer. Its difference between RE=1 to RE=0.\n  >>  * **Payload:**\n    ```\n      {\n          \"Account\": \"DVSITE\",\n          \"DockID\": \"0004A30B0027AD86\",\n          \"SiteID\": \"\",\n          \"DockName\": \"Daryl Desk\",\n          \"Event\": [\n              {\n                  \"name\": \"Trailer Load Time\",\n                  \"value\": \"00:01:16\",\n                  \"timestamp\": \"2021-09-11T17:28:30.562Z\"\n              }\n          ]\n      }\n    ```\n\n> ## Gateway Status\n  >> * **Event Name: GWS\n    - Event Description: Event Description: Status of site gateway. The gateway has a 1 minute keep alive that is used to trigger this event. Values are Connected and Disconnect. An event will trigger when the gateways connection status changes.\n\n\n  >> * **Payload:**\n   ```\n     {\n          “Account”:”Name”,\n          “GatewayEUI”:” 123456FFFF”,\n          “GatewayName”:”Gateway Name”,\n          “Event”:[\n               {\n                    “name”:”GWS”,\n                    “value”:”Connected/Disconnected”,\n                    “timestamp”:”2020-10-19T20:15:18.730000Z”\n               }\n          ]\n     }\n   ```\n\n > # Publish Events\n\n - Override Password (OPW)\n - Operator Password (UPW)\n - Supervisor Password (SPW)\n - Override Authorization (OA)\n - Play Back\n\n> ## Override Password\n  >> * **Event Name: OPW\n    - Event Description: Password to enable Override of the Restraint at the Dock Position. The value must be between 1111 –4444 with no single digit being <1 or >4. ie 1544 is not allowed.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”Dock EUID”,\n          “SiteID”:”AccountName”, \n          “DockName”:”Dock Name”, \n          “Event”:[\n               {\n                    “name”:”OPW”,\n                    “value”:”111\",\n               }\n          ] \n     }\n   ```\n\n\n\n> ## Operator Password\n  >> * **Event Name: UPW\n    - Event Description: HMI User Password. Allows the screen to be unlocked from screen saver and basic operation of the HMI. The value must be between 1111 –4444 with no single digit being <1 or >4. ie 1544 is not allowed.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”Dock EUID”,\n          “SiteID”:”AccountName”, \n          “DockName”:”Dock Name”, \n          “Event”:[\n               {\n                    “name”:”UPW”,\n                    “value”:”1111”,\n               }\n          ] \n     }\n   ```\n\n\n> ## Supervisor Password\n  >> * **Event Name: SPW\n    - Event Description: HMI Supervisor Password. Allows the screen to be unlocked from screen saver and complete operation of the HMI. The value must be between 1111 –4444 with no single digit being <1 or >4. ie 1544 is not allowed.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”Dock EUID”,\n          “SiteID”:”AccountName”, \n          “DockName”:”Dock Name”, \n          “Event”:[\n               {\n                    “name”:”SPW”,\n                    “value”:”1111”,\n               }\n          ] \n     }\n   ```\n\n\n> ## Override Authorization\n  >> * **Event Name: OA\n    - Event Description: Remote authorizationof Restraint Override. This will defeat the need for the password locally.\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:”Dock EUID”,\n          “SiteID”:”AccountName”, \n          “DockName”:”Dock Name”, \n          “Event”:[\n               {\n                    “name”:”OA”,\n                    “value”:”1”,\n               }\n          ] \n     }\n   ```\n\n> ## Play Back\n  >> * **Event Name: Play\n    - Event Description: Publishes a maximum of 7 days of historical messages thru the MQTT Broker Subscribe Event. It play all events for all Docks in the Account (Time should be in UTC format).\n  >> * **Payload:**\n   ```\n     {\n          “DockID”:””,\n          “SiteID”:””, \n          “DockName”:””, \n          “Event”:[\n               {\n                    “name”:”PLAY”,\n                    “value”:”2021-7-14T13:00:00Z”,\n               }\n          ] \n     }\n   ```\n> # Digital Gate & Digital Max Events\n\n> # MQTT Subscribe Events\n| Access | Channel|\n| :----: |:----:|\n| Read Only | Shipments |\n\n> ## Scheduled Event\n  >> * **Description:** Request from Shipment for Scheduled Shipments.\n     - shipment_status : SCHEDULED\n     - Value is an array of information for the scheduled shipment. It should show only changes to the shipment and not all the fields.\n  >> * **Payload:**\n     ```\n      {\n        \"site_id\": \"4Front Sales\",\n        \"event\": \"SCHEDULED\",\n        \"data\": [\n            {\n                \"appointment_no\": \"VJ566\",\n                \"schedule_date_time\": \"2021-04-12T21:30:00.000Z\",\n                \"shipment_status\": \"scheduled\",\n                \"duration\": 60,\n                \"dock_id\": \"60522c8f504af125bcda48f6\",\n                \"dock_location\": \"ME DVS\",\n                \"shipment_type\": \"inbound\",\n                \"load_type\": \"live\",\n                \"reference_no\": \"REF1035\",\n                \"carrier_company\": \"CARR\",\n                \"quantity\": \"QTY\",\n                \"description\": \"Description\",\n                \"trailer_no\": \"TRl#\",\n                \"ship_date\": \"2021-04-12T19:50:00.000Z\",\n                \"ship_to\": \"DD\",\n                \"ship_from\": \"FF\",\n                \"comment\": \"Test for Arrive\"\n            }\n         ]    \n       }\n    ``` \n\n> ## Update Event\n  >> * **Description:** Request from Shipment for Update Shipment.\n     - shipment_status : SCHEDULED, ARRIVED, TURN AWAY, DEPARTED, DELETED\n     - Value is information for the updated shipment. It should show only changes to the shipment and not all the fields.\n  >> * **Payload:**\n     ```\n       {\n           \"site_id\": \"kbdev\",\n           \"site_name\": \"kbdev\",\n           \"group_id\": \"\",\n           \"event\": \"UPDATED\",\n           \"channel\": \"shipments\",\n           \"data\": {\n               \"_id\": \"6074d360a33dae02ac284d93\",\n               \"appointment_no\": \"APT12A\",\n               \"shipment_status\": \"scheduled\",\n               \"location\": \"Dock 2\",\n               \"reference_no\": \"RER4643\",\n               \"carrier_company\": \"4FRONT\",\n               \"description\": \"Test Description--MQTT\",\n               \"comment\": \"This is MQQTT update testing.\",\n               \"dock_name\": \"Dock 2\",\n               \"dock_id\": \"60522c8f504af125bcda48f2\",\n               \"updatedAt\": \"2021-04-12T23:11:24.000Z\",\n               \"updated_by\": \"test-user\"\n            }\n        }\n     ```\n> ## Pre Check-in Event\n  >> * **Description:** Request from Shipment for Pre Check-in Shipment Status.\n     - shipment_status : SCHEDULED, PRE_CHECK_INin value is true\n     - Value is information for the updated shipment. It should show only changes to the shipment and not all the fields.\n  >> * **Payload:**\n      ```\n        {\n           \"site_id\": \"kbdev\",\n           \"site_name\": \"kbdev\",\n           \"group_id\": \"\",\n           \"event\": \"PRE_CHECK_IN\",\n           \"channel\": \"shipments\",\n           \"data\": {\n               \"_id\": \"606dd65b99b09b1ba5da9700\",\n               \"appointment_no\": \"NA4642A0\",\n               \"shipment_status\": \"scheduled\",\n               \"is_pre_check_in\": true,\n               \"duration\": 15,\n               \"dock_id\": \"604f7a4959d3275e4a567781\",\n               \"trailer_no\": \"1234\",\n               \"carrier_company\": \"Demo\",\n               \"pre_check_in_changed_fields\": [\n                   {\n                      \"_id\": \"606dd65b99b09b1ba5da9705\",\n                      \"key\": \"carrier_company\",\n                      \"label\": \"Carrier/Company\",\n                      \"new_value\": \"Demo\",\n                      \"old_value\": \"\"\n                   },\n                   {\n                       \"_id\": \"606dd65b99b09b1ba5da9704\",\n                       \"key\": \"trailer_no\",\n                       \"label\": \"Trailer #\",\n                       \"new_value\": \"1234\",\n                       \"old_value\": \"\"\n                    },    \n                    {\n                       \"_id\": \"606dd65b99b09b1ba5da9703\",\n                       \"key\": \"reference_no\",\n                       \"label\": \"Reference #\",\n                       \"new_value\": \"Qwe\",\n                       \"old_value\": \"\"\n                    }\n                 ],\n                \"driver_cell\": \"+14699000000\",\n                \"driver_name\": \"Vijay Mahale\",\n                \"equipment_type\": \"FLATBED\",\n                \"pre_check_in_date_time\": \"2021-04-07T15:57:15.666Z\",\n                \"pre_check_in_location\": {\n                    \"_id\": \"606dd65b99b09b1ba5da9702\",\n                    \"latitude\": 28.57566754700036,\n                    \"longitude\": 77.43450172820444,\n                    \"eta\": 120\n                },\n                \"reference_no\": \"Qwe\",\n                \"location\": \"No Location\",\n                \"is_pre_check_in_expired\": false,\n                \"pre_check_in_expiry_date_time\": \"2021-04-08T15:57:15.666Z\",\n                \"qr_code_url\": \"https://api.qrserver.com/v1/create-qr-code/?size=150x150&data=NA4642A0\",\n                \"appt_creation_type\": \"NO APPT\"\n          }\n      }\n    ```\n> ## Arrived Event\n  >> * **Description:** Request from Shipment for Arrive Shipment Status.\n    - shipment_status : ARRIVED\n    - Value is information for the updated shipment. It \n    should show only changes to the shipment and not all the fields.\n  >> * **Payload:**\n     ```\n      {\n         \"site_id\": \"kbdev\",\n         \"site_name\": \"kbdev\",\n         \"group_id\": \"\",\n         \"event\": \"ARRIVED\",\n         \"channel\": \"shipments\",\n         \"data\": {\n             \"_id\": \"6074d360a33dae02ac284d93\",\n             \"appointment_no\": \"APT12A\",\n             \"shipment_status\": \"arrived\",\n             \"appt_creation_type\": \"UI\",\n             \"is_pre_check_in\": false,\n             \"is_express_arrival\": false,\n             \"is_express_departure\": false,\n             \"duration\": 60,\n             \"shipment_alert\": \"early\",\n             \"dock_id\": \"60522c8f504af125bcda48f2\",\n             \"location\": \"Dock 2\",\n             \"reference_no\": \"RER4643\",\n             \"carrier_company\": \"4FRONT\",\n             \"trailer_no\": \"TRL885\",\n             \"driver_name\": \"VIJAY\",\n             \"driver_cell\": \"+15125125122\",\n             \"equipment_type\": \"CONTAINER\",\n             \"arrival_start_date_time\": \"2021-04-12T23:38:42.963Z\",\n             \"arrival_date_time\": \"2021-04-12T23:39:29.841Z\",\n             \"arrived_by\": \"Driver Control - Vijay Mahale\"\n         }\n     }\n    ```\n> ## Departed Event\n  >> * **Description:** Request from Shipment for Depart Shipment Status.\n    - shipment_status : DEPARTED\n    - Value is information for the updated shipment. It \n    should show only changes to the shipment and not all the fields.\n  >> * **Payload:**\n    ```\n      {\n         \"site_id\": \"kbdev\",\n         \"site_name\": \"kbdev\",\n         \"group_id\": \"\",\n         \"event\": \"DEPARTED\",\n         \"channel\": \"shipments\",\n         \"data\": {\n             \"_id\": \"6074d360a33dae02ac284d93\",\n             \"appointment_no\": \"APT12A\",\n             \"shipment_status\": \"departed\",\n             \"location\": \"Dock 2\",\n             \"reference_no\": \"RER4643\",\n             \"carrier_company\": \"4FRONT\",\n             \"trailer_no\": \"TRL885\",\n             \"driver_name\": \"VIJAY\",\n             \"driver_cell\": \"+15125125123\",\n             \"departure_signature_data_url\": \"https://dgtest.4sightconnect.net/data/shipments/driver-signature/6074d360a33dae02ac284d93\",\n             \"departure_date_time\": \"2021-04-13T12:14:23.940Z\",\n             \"departed_by\": \"Driver Control - Vijay Mahale\"\n         }\n      }\n    ```\n> ## Turned Away Event\n  >> * **Description:** Request from Shipment for Turned Away Shipment Status.\n    - shipment_status : TURNED_AWAY\n    - Value is information for the updated shipment. It \n    should show only changes to the shipment and not all the fields.\n  >> * **Payload:**\n     ```\n       {\n          \"site_id\": \"kbdev\",\n          \"site_name\": \"kbdev\",\n          \"group_id\": \"\",\n          \"event\": \"TURNED_AWAY\",\n          \"channel\": \"shipments\",\n          \"data\": {\n              \"_id\": \"6074d360a33dae02ac284d93\",\n              \"appointment_no\": \"APT12A\",\n              \"shipment_status\": \"turnedaway\",\n              \"reference_no\": \"RER4643\",\n              \"carrier_company\": \"4FRONT\",\n              \"trailer_no\": \"TRL885\",\n              \"driver_name\": \"VIJAY\",\n              \"driver_cell\": \"+15125125122\",\n              \"arrival_date_time\": \"2021-04-12T23:39:29.841Z\",\n              \"turned_away_date_time\": \"2021-04-13T12:09:37.052Z\",\n              \"turned_away_by\": \"test-user\",\n              \"turned_away_reasons\": \"Damaged,Dirty,Late Appointment\"\n          }\n       }\n     ```\n\n> ## Deleted Event\n  >> * **Description:** Request from Shipment for Delete Shipment Status.\n    - shipment_status : DELETED\n    - Value is information for the updated shipment. It \n    should show only changes to the shipment and not all the fields.\n  >> * **Payload:**\n    ```\n      {\n        \"site_id\": \"kbdev\",\n        \"site_name\": \"kbdev\",\n        \"group_id\": \"\",\n        \"event\": \"DELETED\",\n        \"channel\": \"shipments\",\n        \"data\": {\n            \"_id\": \"607541aca33dae02ac2851d5\",\n            \"appointment_no\": \"S413202110\",\n            \"shipment_status\": \"deleted\",\n            \"deleted_date_time\": \"2021-04-13T12:16:55.971Z\",\n            \"schedule_date_time\": \"2021-04-13T17:01:00.005Z\",\n            \"deleted_by\": \"test-user\",\n            \"deleted_comments\": \"This is a MQTT delete appt testing....\"\n        }\n      }\n    ```\n\n> ## Total Schedule Count Event\n  >> * **Description:** Request for total the number of scheduled appointments for a site. \n    - shipment_status : SCHEDULE \n    - Value is for the life of the product.  This is an integer value.\n  >> * **Payload:**\n    ```\n      {\n         \"site_id\": \"kbdev\",\n         \"site_name\": \"kbdev\",\n         \"group_id\": \"\",\n         \"event\": \"SCHEDULE\",\n         \"channel\": \"shipments\",\n         \"data\": {\n             \"shipment_status\": \"deleted\",\n             \"value\": 8\n         }\n      }\n    ```\n\n> ## Total No Appointment Count Event\n  >> * **Description:** Request for Total number of no appointments for a site.\n    - shipment_status : ARRIVE\n    - Value is for the life of the product. This is an integer value.\n  >>  * **Payload:**\n    ```\n      {\n         \"site_id\": \"kbdev\",\n         \"site_name\": \"kbdev\",\n         \"group_id\": \"\",\n         \"event\": \"ARRIVE\",\n         \"channel\": \"shipments\",\n         \"data\": {\n             \"shipment_status\": \"arrived\",\n             \"value\": 2925\n         }\n      }\n    ```\n\n\n# MQTT Publish Events\n| Access | Channel|\n|:----:|:----:|\n| Write Only | Shipment |\n\n> ## Scheduled Event\n   >> * **Description:** Schedule Shipment.\n     - shipment_status : SCHEDULE\n     - Value is information for the scheduled shipment. It should show only changes to the shipment and not all the fields\n   >> * **Payload:**\n       ```\n         {\n            \"site_id\": \"kbdev\",\n            \"site_name\": \"kbdev\",\n            \"group_id\": \"\",\n            \"event\": \"SCHEDULE\",\n            \"channel\": \"shipments\",\n            \"data\": {\n                \"appointment_no\": \"VJ66\",\n                \"schedule_date_time\": \"2021-04-08T23:20:00.000Z\",\n                \"shipment_status\": \"scheduled\",\n                \"duration\": 20,\n                \"dock_id\": \"60522c8f504af125bcda48f9\",\n                \"dock_location\": \"ME DVS\",\n                \"shipment_type\": \"inbound\",\n                \"load_type\": \"live\",\n                \"reference_no\": \"REF1035\",\n                \"carrier_company\": \"CARR\",\n                \"quantity\": \"QTY\",\n                \"description\": \"Description\",\n                \"trailer_no\": \"TRl#\",\n                \"ship_date\": \"2021-02-10T19:50:00.000Z\",\n                \"ship_to\": \"DD\",\n                \"ship_from\": \"FF\",\n                \"comment\": \"Deepthi for Arrive\",\n                \"email_address\": \"vijaykumar.mahale@4frontes.com\"\n            }\n          }\n        ``` \n\n> ## Update Event\n   >> * **Description:** Update Shipment Status. \n     - shipment_status : SCHEDULE, ARRIVE, TURN AWAY\n     - Value is information that can be updated on a shipment.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"site_name\": \"kbdev\",\n          \"group_id\": \"\",\n          \"event\": \"UPDATE\",\n          \"channel\": \"shipments\",\n          \"data\": {\n              \"id\": \"606c8cc89a0a297743874fcf\",\n              \"appointment_no\": \"MQ07\",\n              \"schedule_date_time\": \"2021-04-06T20:00:00.000Z\",\n              \"shipment_status\": \"scheduled\",\n              \"duration\": 60,\n              \"dock_id\": \"60522c8f504af125bcda4904\",\n              \"shipment_type\": \"outbound\",\n              \"load_type\": \"drop\",\n              \"reference_no\": \"R\",\n              \"carrier_company\": \"CARRPUB55\",\n              \"quantity\": \"PUB\",\n              \"description\": \"Publish Testing\",\n              \"trailer_no\": \"TRl#\",\n              \"ship_date\": \"2021-02-10T19:50:00.000Z\",\n              \"ship_to\": \"Publish Testing\",\n              \"ship_from\": \"Publish Testing\",\n              \"comment\": \"Publish Testing\",\n              \"email_address\": \"vijaykumar.mahale@assaabloy.com\"\n          }\n      }\n    ```\n\n> ## Depart\n  >> * **Description:** Depart a shipment. \n    - shipment_status : DEPART\n    - Value is information that can be used to depart a shipment.\n  >> * **Payload:**\n    ```\n      {\n         \"site_id\": \"4Front Sales\",\n         \"group_id\": \"Group Name\",\n         \"channel\": \"shipments\",\n         \"event\": \"DEPART\",\n         \"data\": {\n             \"id\": \"606b1159fd823656d0502197\",\n             \"driver_signature\": \"data:image/png;base64,iVBORw0KGgo==\",\n             \"departure_start_date_time\": \"2020-04-05T22:49:27.984Z\"\n         }\n      }\n    ```\n\n> ## Arrived Event\n  >> * **Description:** Arrive a shipment.\n    - shipment_status : ARRIVE\n    - Value is information that can be used to arrive a shipment.\n  >> * **Payload:**\n    ```\n      {\n         \"site_id\": \"4Front Sales\",\n         \"group_id\": \"Group Name\",\n         \"channel\": \"shipments\",\n         \"event\": \"ARRIVE\",\n         \"data\": {\n             \"id\": \"606b84f09a0a297743874a3d\",\n             \"arrival_start_date_time\": \"2020-04-05T23:46:27.809Z\",\n             \"trailer_no\": \"trl\",\n             \"driver_name\": \"VJ\",\n             \"driver_cell\": \"+15125125126\",\n             \"equipment_type\": \"CONTAINER\",\n             \"reference_no\": \"test\",\n             \"carrier_company\": \"CARR\"\n         }\n      }\n    ```\n\n> ## No Touch Depart\n  >> * **Description:** Depart a shipment for no touch access departure.\n    - shipment_status : ARRIVE\n    - Value is information that can be used to authorize a no touch depart a shipment. \n  >> * **Payload:**\n    ```\n      {\n         \"site_id\": \"kbdev\",\n         \"group_id\": \"Group Name\",\n         \"channel\": \"shipments\",\n         \"event\": \"ARRIVE\",\n         \"data\": {\n             \"id\": \"606dfdfd3f9a4a20ed77cf33\"\n         }\n      }\n    ```\n\n> ## Turned Away Event\n  >> * **Description:** Turn Away a shipment.\n    - shipment_status : TURN AWAY\n    - Value is information that can be used to turn away a shipment. \n  >> * **Payload:**\n    ```\n      {\n         \"site_id\": \"4Front Sales\",\n         \"group_id\": \"Group Name\",\n         \"channel\": \"shipments\",\n         \"event\": \"TURN AWAY\",\n         \"data\": {\n             \"id\": \"606dfdfd3f9a4a20ed77cf33\",\n             \"reasons\": [\n                 \"Damaged\",\n                 \"Dirty\",\n                 \"Too Early\"\n             ]\n         }\n      }\n    ```\n\n> ## Deleted Event\n  >> * **Description:** Request from Shipment for Delete Shipment Status. \n    - shipment_status : DELETE\n    - Value is information that can be used to delete a shipment\n  >> * **Payload:**\n    ```\n      {\n         \"site_id\": \"kbdev\",\n         \"group_id\": \"Group Name\",\n         \"channel\": \"shipments\",\n         \"event\": \"DELETE\",\n         \"data\": {\n             \"id\": \"606df08f99b09b1ba5daa14f\",\n             \"comments\": \"bf dfhfghf ghfgh fgh gfhg\"\n         }\n     }\n    ```\n\n\n> # Yard Events\n\n> # MQTT Subscribe Events\n| Access | Channel|\n| :----: |:----:|\n\n\n> ## Location Event\n  >> * **Description:** Location message from Tag. Transmitted on movement of tag or heartbeat time frame. \n    - Value is information that can be used to locate and inventory the associated asset to the Tag.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"end-to-end\",\n          \"group_id\": \"\",\n          \"event\": {\n              \"name\": \"LOCATION\",\n              \"x\": \"32.94222002737216\",\n              \"y\": \"-96.91712098372382\",\n              \"timestamp\": \"2022-02-24T14:49:43.837Z\",\n              \"direction\": \"45\",\n              \"speed\": 0,\n              \"account\": \"YardENT1\",\n              \"tag_id\": \"70B3D57050002D67\",\n              \"tag_qr\": \"GPS-000007\",\n              \"site_id\": \"\",\n              \"battery\": \"4300\",\n              \"asset\": \"620ffac62dbe65cd37f8d96c\"\n          }\n      }\n    ```\n\n> ## Allocate Event\n  >> * **Description:** Tag allocated to trailer at check in point.\n    - Value is information that represents tag and trailer match.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"end-to-end\",\n          \"group_id\": \"\",\n          \"name\": {\n              \"event\": \"ALLOCATED\",\n              \"appointment_no\": \"APT24FEB2\",\n              \"tag_id\": \"\",\n              \"asset_id\": \"62179d206da885e6b1e5e6a5\",\n              \"trailer_no\": \"TRl877\",\n              \"carrier_id\": \"4FRONT\",\n              \"timestamp\": \"2022-02-24T14:58:40.825Z\"\n          }\n      } \n    ```\n\n> ## Unallocated Event\n  >> * **Description:** Tag put back into inventory.\n    - Tag is now in population that can be allocated to new trailer\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"620a8cf5764acf211b3665b5\",\n          \"group_id\": \"\",\n          \"event\": {\n              \"name\": \"UNALLOCATED\",\n              \"appointment_no\": \"GPS-000005\",\n              \"tag_id\": \"\",\n              \"asset_id\": \"621019f62dbe65cd37f8e93f\",\n              \"trailer_no\": \"GPS-000005\",\n              \"carrier_id\": \"GPS-000005\",\n              \"timestamp\": \"2022-02-24T14:59:35.088Z\"\n          }\n      }\n    ```\n\n> ## Tasked Event\n  >> * **Description:** Task status updates.\n    - Task has been created/updated or deleted in system.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"end-to-end\",\n          \"group_id\": \"\",\n          \"event\": {\n              \"name\": \"TASK\",\n              \"task_id\": \"62179d886da885e6b1e5e72f\",\n              \"task_type\": \"MOVE\",\n              \"status\": \"Assigned\",\n              \"assignee_id\": \"6213424c2dbe65cd37f938b3\",\n              \"asset_id\": \"62179d206da885e6b1e5e6a5\",\n              \"point_a\": \", \",\n              \"point_b\": \"32.941887148022495, -96.91820420998141\",\n              \"timestamp\": \"2022-02-24T15:00:24.176Z\"\n          }\n      }\n    ```\n\n> ## Status Event\n  >> * **Description:** Assignee status updates.\n    - Assignee Status\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": { \n              \"name\":\"ASTATUS\", \n              \"assignee_id\": \"Unique ID\", \n              \"Available\":\"True/False\", \n              \"_date_time\": \"2020-04- 05T23:46:27.809Z\"\n          }\n      }\n    ```\n\n> ## tag Event\n  >> * **Description:** Alert based on Tag Status\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": { \n              \"name\":\"TAG\", \n              \"tag_id\": \"Unique ID\", \n              \"status\":\"Collection: Battery Warning, Battery Critical, GeoFence, LocationChange\",\n              \"_date_time\": \"2020-04- 05T23:46:27.809Z\"\n          }\n      }\n    ```\n\n\n# MQTT Publish Events\n| Access | Channel|\n|:----:|:----:|\n\n\n> ## Allocate Event\n  >> * **Description:** Assignee status updates.\n    - Assignee Status\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": { \n              \"Name\":\"ALLOCATE\", \n              \"appointment_no\": \"VJ66\", \n              \"tag_id\": \"0004A30B002325AF\", \n              \"trailer_no\": \"trl\", \n              \"carrier_id\":\"Carrier Company\", \n              \"_date_time\": \"2020-04- 05T23:46:27.809Z\"\n          }\n      }\n    ```\n\n> ## Unallocated Event\n  >> * **Description:** Request from Shipment for Delete Shipment Status. \n    - shipment_status : DELETE\n    - Value is information that can be used to delete a shipment\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": { \n              \"Name\":\"UNALLOCATE\", \n              \"appointment_no\": \"VJ66\", \n              \"tag_id\": \"0004A30B002325AF\", \n              \"asset_id\":\"asset_id\", \n              \"trailer_no\": \"trl\", \n              \"carrier_id\":\"Carrier Company\", \n              \"_date_time\": \"2020-04- 05T23:46:27.809Z\"\n          }\n      }\n    ```\n\n> ## Task Create\n  >> * **Description:** Task status updates. \n    - Task has been created/updated in system.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": {\n              \"name\": \"TaskCreate\",\n              \"asset_id\": \"620ca79ab28b88de6e63afd8\",\n              \"to_location_id\": \"62101c1f2dbe65cd37f8ebc2\"\n              \"priority\": true\n          }\n      }\n    ```\n\n> ## Change Priority\n  >> * **Description:** Task status updates. \n    - Task priotity has been updated in system.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": {\n              \"name\": \"TaskPriority\",\n              \"task_id\": \"6217cf5e3c74f8e86a4f0921\"\n          }\n      }\n    ```\n\n> ## Task Complete\n  >> * **Description:** Task status updates. \n    - Task has been completed in system.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": {\n              \"name\": \"TaskComplete\",\n              \"task_id\": \"6217df6327729a638061fe60\"\n          }\n      }\n    ```\n\n> ## Task Delete\n  >> * **Description:** Task status updates. \n    - Task has been deleted in system.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": {\n              \"name\": \"TaskDelete\",\n              \"task_id\": \"620fd36caf58fa0e263ccb61\"\n          }\n      }\n    ```\n\n> ## Task Release\n  >> * **Description:** Task status updates. \n    - Task has been release in system.\n  >> * **Payload:**\n    ```\n      {\n          \"site_id\": \"kbdev\",\n          \"group_id\": \"Group Name\",\n          \"event\": {\n              \"name\": \"TaskRelease\",\n              \"task_id\": \"6217cf5e3c74f8e86a4f0921\"\n          }\n      }\n    ```\n# 4SIGHT Connect Data RESTful API's\n\n| API  | Description | Required|\n| ---- |:----:|:----:|\n| Retreive Token| **POST** auth token|username, password|\n| Create Shipments| **POST** 1 to 100 schedules at one time in our system|appointment_no, schedule_date_time, shipment_status, duration, dock, dock_location (if other in dock)|\n| Get Shipments| **GET** schedules from our system|none|\n| Update Shipments| **PATCH** updates on a shipment to our system|appointment_no|\n| Get Docks| **GET** docks configured in our system|none|\n| Available Docks| **GET** available docks in our system|none|\n| Send Push Notifications| **POST** push notification to drivers with mobile app |driver_cell, title, message|","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14999099","collectionId":"af2a4f0b-f261-466f-a73e-fa47a7244bbd","publishedId":"TzJpifWH","public":true,"publicUrl":"https://apidoc.4sightconnect.net","privateUrl":"https://go.postman.co/documentation/14999099-af2a4f0b-f261-466f-a73e-fa47a7244bbd","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2021-04-14T17:27:25.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f7d7bab6c5801dfd239d3437c034b70cb488ffb9a72bc203cfd06b23310cfaa7","favicon":"https://4sightconnect.net/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://apidoc.4sightconnect.net/view/metadata/TzJpifWH"}