SAP Sailing Analytics Webservices API Version 1.0

URL: /api/v1/mark/addMarkToRegatta

Description:

Adds a Mark to a specified Regatta


Webservice Type: REST
Intput format: Json
Output format: Json
Request method: POST
Mandatory parameters: regattaName: the name of the regatta to add the mark to.
markName: the name of the mark to add.
Optional parameters: shortName: short name of the mark to create. Defaults to the name if not given.
originatingMarkTemplateId: UUID of an existing mark template on which the mark is based on
originatingMarkPropertiesId: UUID of existing mark properties on which the mark is based on
color: Optional color of the mark to create. Defaults to null if not provided.
type: Optional type of the mark to create. Defaults to null if not provided.
pattern: Optional pattern of the mark to create. Defaults to null if not provided.
shape: Optional shape of the mark to create. Defaults to null if not provided.
Examples: Request:
            {
                "markName":"MyMark",
                "markShortName":"MM",
                "originatingMarkTemplateId":"305ffb4b-c23d-42a1-be45-f76a2bad8fab",
                "originatingMarkPropertiesId":"dc77e3d1-d405-435e-8699-ce7245a6fd4a",
                "regattaName":"test"
            }
            
Response:
            {
                "markId":uuidOfGeneratedMark
            }
            
Back to Web Service Overview