AOP Core Role API Specification

The following are examples of automated Collaboration messages that can be sent to the custom AOP REST endpoint using a POST operation. These messages can be sent by GeoEvent or any other service that can interface with a REST endpoint.

Example Message without Graphic or Spatial Data

Raw Request

http://MyServer.com:10080/Geocortex/AOP/Room/d03e4d60597b49ec8dce38a933b83306/Event/Add?clientEvent={"type":"MessageEvent","data":{"message":"AUTOMATED ALERT"}}

Formatted Request

http://MyServer.com:10080/Geocortex/AOP/Room/c062aed0320d4a90beb3b7a2dcd34abb/Event/Add?clientEvent={
    "type": "MessageEvent",
    "data": {  
        "message": "AUTOMATED ALERT"
    }
}

Raw Return Result

{"type":"MessageEvent","created":"2017-06-07T22:54:24.838Z","createdBy":"POSTMAN","id":"a5b51b13f4fd49cfa87b9b5cdfa98144","data":{"message":"AUTOMATED ALERT"},"roomId":"d03e4d60597b49ec8dce38a933b83306","updated":"2017-06-07T22:54:24.838Z","updatedBy":"POSTMAN","sourceEvent":null,"isOwner":false,"attachmentId":null}

Formatted Return Result

{
    "type": "MessageEvent",
    "created": "2017-06-07T22:54:24.838Z",
    "createdBy": "POSTMAN",
    "id": "a5b51b13f4fd49cfa87b9b5cdfa98144",
    "data": {
        "message": "AUTOMATED ALERT"
    },
    "roomId": "d03e4d60597b49ec8dce38a933b83306",
    "updated": "2017-06-07T22:54:24.838Z",
    "updatedBy": "POSTMAN",
    "sourceEvent": null,
    "isOwner": false,
    "attachmentId": null
}

Result in AOP Application

Example Message with Associated Spatial Graphic

Raw Request

http://MyServer.com:10080/Geocortex/AOP/Room/d03e4d60597b49ec8dce38a933b83306/Event/Add?clientEvent={"data":{"markup":{"points":{"spatialReference":{"wkid":102100},"geometryType":"esriGeometryPoint","features":[{"geometry":{"x":-13739128.0,"y":6177233.0,"spatialReference":{"wkid":102100}},"attributes":{"__symbol":{"color":[247,244,23,204],"size":16,"angle":0,"xoffset":0,"yoffset":0,"type":"esriSMS","style":"esriSMSDiamond","outline":{"color":[240,116,13,255],"width":1.5,"type":"esriSLS","style":"esriSLSSolid"}}}}]},"polylines":{},"polygons":{},"rectangles":{}},"message":"Ship in distress at Saxe Point"},"type":"ShareMarkupEvent"}

Formatted Request

http://MyServer.com:10080/Geocortex/AOP/Room/d03e4d60597b49ec8dce38a933b83306/Event/Add?clientEvent={
    "data": {
        "markup": {
            "points": {
                "spatialReference": {
                    "wkid": 102100
                },
                "geometryType": "esriGeometryPoint",
                "features": [
                    {
                        "geometry": {
                            "x": -13739128.0,
                            "y": 6177233.0,
                            "spatialReference": {
                                "wkid": 102100
                            }
                        },
                        "attributes": {
                            "__symbol": {
                                "color": [
                                    247,
                                    244,
                                    23,
                                    204
                                ],
                                "size": 16,
                                "angle": 0,
                                "xoffset": 0,
                                "yoffset": 0,
                                "type": "esriSMS",
                                "style": "esriSMSDiamond",
                                "outline": {
                                    "color": [
                                        240,
                                        116,
                                        13,
                                        255
                                    ],
                                    "width": 1.5,
                                    "type": "esriSLS",
                                    "style": "esriSLSSolid"
                                }
                            }
                        }
                    }
                ]
            },
            "polylines": {},
            "polygons": {},
            "rectangles": {}
        },
        "message": "Ship in distress at Saxe Point"
    },
    "type": "ShareMarkupEvent"
}

Raw Return Result

{"type":"ShareMarkupEvent","created":"2017-06-07T23:02:14.147Z","createdBy":"External GeoEvent","id":"9aefd3f158cc478ebe948d5d83ea8c2a","data":{"markup":{"points":{"spatialReference":{"wkid":102100},"geometryType":"esriGeometryPoint","features":[{"geometry":{"x":-13739128.0,"y":6177233.0,"spatialReference":{"wkid":102100}},"attributes":{"__symbol":{"color":[247,244,23,204],"size":16,"angle":0,"xoffset":0,"yoffset":0,"type":"esriSMS","style":"esriSMSDiamond","outline":{"color":[240,116,13,255],"width":1.5,"type":"esriSLS","style":"esriSLSSolid"}}}}]},"polylines":{},"polygons":{},"rectangles":{}},"message":"Ship in distress at Saxe Point"},"roomId":"d03e4d60597b49ec8dce38a933b83306","updated":"2017-06-07T23:02:14.147Z","updatedBy":"External GeoEvent","sourceEvent":null,"isOwner":false,"attachmentId":null}

Formatted Return Result

{
    "type": "ShareMarkupEvent",
    "created": "2017-06-07T23:02:14.147Z",
    "createdBy": "External GeoEvent",
    "id": "9aefd3f158cc478ebe948d5d83ea8c2a",
    "data": {
        "markup": {
            "points": {
                "spatialReference": {
                    "wkid": 102100
                },
                "geometryType": "esriGeometryPoint",
                "features": [
                    {
                        "geometry": {
                            "x": -13739128.0,
                            "y": 6177233.0,
                            "spatialReference": {
                                "wkid": 102100
                            }
                        },
                        "attributes": {
                            "__symbol": {
                                "color": [
                                    247,
                                    244,
                                    23,
                                    204
                                ],
                                "size": 16,
                                "angle": 0,
                                "xoffset": 0,
                                "yoffset": 0,
                                "type": "esriSMS",
                                "style": "esriSMSDiamond",
                                "outline": {
                                    "color": [
                                        240,
                                        116,
                                        13,
                                        255
                                    ],
                                    "width": 1.5,
                                    "type": "esriSLS",
                                    "style": "esriSLSSolid"
                                }
                            }
                        }
                    }
                ]
            },
            "polylines": {},
            "polygons": {},
            "rectangles": {}
        },
        "message": "Ship in distress at Saxe Point"
    },
    "roomId": "d03e4d60597b49ec8dce38a933b83306",
    "updated": "2017-06-07T23:02:14.147Z",
    "updatedBy": "External GeoEvent",
    "sourceEvent": null,
    "isOwner": false,
    "attachmentId": null
}

Result in AOP Application

© 2018 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 2.0