Method: serializedPolygons.get

AI-generated Key Takeaways

• Retrieve a serialized polygon using its ID, which will be provided in other API responses like InundationMap in FloodStatus.

• The request method is GET and uses a URL with gRPC Transcoding syntax.

• The request requires a 'name' path parameter specifying the ID of the serialized polygon.

• The request body must be empty.

• A successful response will contain an instance of SerializedPolygon.

• HTTP request
• Path parameters
• Request body
• Response body

Get a serialized polygon. IDs for these will appear in other API Responses, and you'll be able to use these IDs here. For example, see InundationMap in FloodStatus.

HTTP request

GET https://floodforecasting.googleapis.com/v1/{name=serializedPolygons/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. The name of the serialized polygon to retrieve. Name format: serializedPolygons/{polygonId}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of SerializedPolygon.