Embed

Contains information for the created/updated user farm and its parcels.

• Farm data
• Embed ID
• DAS farm ID
• Geometry as GeoJSON
• Area in hectares (nullable)
• State (nullable)
• Local Government Area (nullable)
• Postcodes

For each underlying Parcel

• Parcel ID
• Geometry as GeoJSON
• Area in hectares (nullable)
• State (nullable)
• Local Government Area (nullable)
• Postcodes

JSON schema in version draft-07

Schema

{
    "$schema": "https://json-schema.org/draft-07/schema",
    "title": "Embed webhook schema",
    "type": "object",
    "required": [
        "embedId",
        "dasFarmId",
        "geometry",
        "area",
        "state",
        "localGovernmentArea",
        "postcodes",
        "parcels"
    ],
    "properties": {
        "embedId": {
            "title": "Unique identifier for DAS Embed",
            "type": "string"
        },
        "dasFarmId": {
            "title": "Unique identifier for DAS Rural Platform",
            "type": "string"
        },
        "geometry": {
            "$ref": "#/$defs/geometry"
        },
        "area": {
            "$ref": "#/$defs/area"
        },
        "state": {
            "$ref": "#/$defs/state"
        },
        "localGovernmentArea": {
            "$ref": "#/$defs/localGovernmentArea"
        },
        "postcodes": {
            "$ref": "#/$defs/postcodes"
        },
        "parcels": {
            "title": "A collection of parcels inside the property",
            "type": "array",
            "items": {
                "title": "Each of the parcels inside the property",
                "type": "object",
                "required": [
                    "parcelId",
                    "geometry",
                    "area",
                    "state",
                    "localGovernmentArea",
                    "postcodes"
                ],
                "properties": {
                    "parcelId": {
                        "title": "The ID/name of the parcel",
                        "type": "string"
                    },
                    "geometry": {
                        "$ref": "#/$defs/geometry"
                    },
                    "area": {
                        "$ref": "#/$defs/area"
                    },
                    "state": {
                        "$ref": "#/$defs/state"
                    },
                    "localGovernmentArea": {
                        "$ref": "#/$defs/localGovernmentArea"
                    },
                    "postcodes": {
                        "$ref": "#/$defs/postcodes"
                    }
                }
            }
        }
    },
    "$defs": {
        "area": {
            "title": "The area in Ha. Four decimal points",
            "type": [
                "number",
                "null"
            ]
        },
        "localGovernmentArea": {
            "title": "The local government area that the property is in",
            "type": [
                "string",
                "null"
            ]
        },
        "postcodes": {
            "title": "A list of postcodes that the property is in",
            "type": "array",
            "items": {
                "title": "An Australian postcode",
                "type": "string"
            }
        },
        "state": {
            "title": "The state that the property is in",
            "type": [
                "string",
                "null"
            ]
        },
        "geometry": {
            "oneOf": [
                {
                    "$ref": "https://geojson.org/schema/Polygon.json"
                },
                {
                    "$ref": "https://geojson.org/schema/MultiPolygon.json"
                }
            ]
        }
    }
}

Example

{
    "$schema": "https://developers.dasintel.io/embed/json/webhook-schema.json",
    "embedId": "550e8400-e29b-41d4-a716-446655440000",
    "dasFarmId": "ab58b6ea-0b81-4b7f-97db-ac7968f36ab2",
    "geometry": {
        "type": "Polygon",
        "coordinates": [
            [
                [
                    143.71625862,
                    -38.347919023
                ],
                [
                    143.708663384,
                    -38.347064227
                ],
                [
                    143.70319557,
                    -38.346448468
                ],
                [
                    143.703667754,
                    -38.34384715
                ],
                [
                    143.704140001,
                    -38.341247553
                ],
                [
                    143.704830795,
                    -38.337443778
                ],
                [
                    143.706082143,
                    -38.337578518
                ],
                [
                    143.712002906,
                    -38.338251402
                ],
                [
                    143.717920775,
                    -38.33892401
                ],
                [
                    143.717219314,
                    -38.342720116
                ],
                [
                    143.716738029,
                    -38.34531892
                ],
                [
                    143.71625862,
                    -38.347919023
                ]
            ]
        ]
    },
    "area": 116.6078,
    "state": "VIC",
    "localGovernmentArea": "Colac Otway",
    "postcodes": [
        "3237"
    ],
    "parcels": [
        {
            "parcelId": "1\\TP618887",
            "geometry": {
                "type": "MultiPolygon",
                "coordinates": [
                    [
                        [
                            [
                                143.716738029,
                                -38.34531892
                            ],
                            [
                                143.703667754,
                                -38.34384715
                            ],
                            [
                                143.70319557,
                                -38.346448468
                            ],
                            [
                                143.708663384,
                                -38.347064227
                            ],
                            [
                                143.71625862,
                                -38.347919023
                            ],
                            [
                                143.716738029,
                                -38.34531892
                            ]
                        ]
                    ]
                ]
            },
            "area": 33.6323,
            "state": "VIC",
            "localGovernmentArea": "Colac Otway",
            "postcodes": [
                "3237"
            ]
        },
        {
            "parcelId": "1\\TP710930",
            "geometry": {
                "type": "MultiPolygon",
                "coordinates": [
                    [
                        [
                            [
                                143.704830795,
                                -38.337443778
                            ],
                            [
                                143.704140001,
                                -38.341247553
                            ],
                            [
                                143.717219314,
                                -38.342720116
                            ],
                            [
                                143.717920775,
                                -38.33892401
                            ],
                            [
                                143.712002906,
                                -38.338251402
                            ],
                            [
                                143.706082143,
                                -38.337578518
                            ],
                            [
                                143.704830795,
                                -38.337443778
                            ]
                        ]
                    ]
                ]
            },
            "area": 49.2598,
            "state": "VIC",
            "localGovernmentArea": "Colac Otway",
            "postcodes": [
                "3237"
            ]
        },
        {
            "parcelId": "1\\TP750107",
            "geometry": {
                "type": "MultiPolygon",
                "coordinates": [
                    [
                        [
                            [
                                143.717219314,
                                -38.342720116
                            ],
                            [
                                143.704140001,
                                -38.341247553
                            ],
                            [
                                143.703667754,
                                -38.34384715
                            ],
                            [
                                143.716738029,
                                -38.34531892
                            ],
                            [
                                143.717219314,
                                -38.342720116
                            ]
                        ]
                    ]
                ]
            },
            "area": 33.6365,
            "state": "VIC",
            "localGovernmentArea": "Colac Otway",
            "postcodes": [
                "3237"
            ]
        }
    ]
}

Notes

• The geometry property is a GeoJSON object. It can contain a Polygon or a MultiPolygon.
• The coordinates property of the geometry object is a list of coordinates. The first and last coordinate must be the same.
• The area property is in hectares with four decimal points.
• The postcodes property is a list of postcodes that the property is in.
• The localGovernmentArea property is the local government area that the property is in.
• The state property is the state that the property is in.