PUT api/v1/Goals/{id}/Waypoints

Synchronize a list of waypoints with the existing waypoints on a goal.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The goal ID that is having it's waypoints updated

 globally unique identifier

Required
fields

Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.

 Collection of string

None.
suppressResponseCodes

Some applications do wonky things if error codes are used. Use this to force 200s to always return.

 boolean

None.
APIKey

This is your unique key that identifies you as the developer of this app. Required for all calls.

 string

None.
APIToken

This is the user's session token generated when you authenticate the user

 string

None.

Body Parameters

Update object

GoalWaypointsUpdateObject
NameDescriptionTypeAdditional information
UpdateCreateList

(Required minimum of 2) Must pass up all waypoints. Any waypoints without an ID will be created, and any with an ID (that is matched to an existing waypoint) will be updated. If it has an ID and we can't find the object it matches then that element will be ignored. Any existing waypoints that can't be matched to the list passed in will be deleted.

 Collection of GoalWaypointUpdateCreate

None.
WaypointPeriodType

Linear = 0, Step = 1, Periodstep = 2, Weekly Reset Daily Step = 3

 WAYPOINTPERIODTYPE

None.

Request Formats

application/json, text/json

Sample: 
{
  "UpdateCreateList": [
    {
      "ID": "1da54380-83b0-4a79-9337-bd79e92fc205",
      "Name": "sample string 1",
      "Date": "2024-11-21T01:23:55.5894732-05:00",
      "Value": 3.1
    },
    {
      "ID": "1da54380-83b0-4a79-9337-bd79e92fc205",
      "Name": "sample string 1",
      "Date": "2024-11-21T01:23:55.5894732-05:00",
      "Value": 3.1
    }
  ],
  "WaypointPeriodType": 0
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Goal
NameDescriptionTypeAdditional information
ID

The goal's ID

 globally unique identifier

None.
Name

The goal's name/title

 string

None.
Description

The goal's description

 string

None.
GoalType

The goal's type/category: WIG = 0, SubWIG = 1, Lead = 2

 byte

None.
DisplayType

The goal's value storage type: Number = 5, Money = 9, Percentage = 17

 byte

None.
DisplayColor

The goal's current state color: Red = 255, Yellow = 0, Green = 1

 byte

None.
BoundaryType

The goal's boundary condition type: Meet or Exceeds = 0, Not Greater Than = 1

 byte

None.
CurrentValue

The goal's current value

 decimal number

None.
TargetValue

The current target value for this goal with respect to the current UTC date and goal waypoints.

 decimal number

None.
DisplayValue

The goal's display value. This could be different than the current value if it is an aggregate or composite goal.

 decimal number

None.
StartValue

The value of the starting waypoint

 decimal number

None.
EndValue

The value of the ending waypoint

 decimal number

None.
CurrentDecimalLength

The decimal precision required when displaying the display or current value. This is NOT applied to the data value coming down from the server.

 integer

None.
TargetDecimalLength

The decimal precision required when displaying the target value. This is NOT applied to the data value coming down from the server.

 integer

None.
FinalDecimalLength

The decimal precision required when displaying the final value. This is NOT applied to the data value coming down from the server.

 integer

None.
TeamID

The goal's team ID

 globally unique identifier

None.
YellowTolerance

Yellow tolerance/variance value

 decimal number

None.
RedTolerance

Red tolerance/variance value

 decimal number

None.
WaypointType

Linear = 0, Step = 1, Periodstep = 2, Weekly Reset Daily Step = 3

 integer

None.
InTeamChildrenIDs

IN team goal child IDs

 Collection of globally unique identifier

None.
InTeamParentIDs

IN team goal parent IDs

 Collection of globally unique identifier

None.
OutTeamChildrenIDs

OUT of team goal child IDs

 Collection of globally unique identifier

None.
OutTeamParentIDs

OUT of team goal parent IDs

 Collection of globally unique identifier

None.
IsRetired

If the goal is retired

 boolean

None.
IsDeleted

If the goal is deleted

 boolean

None.
IsFuture

If the goal isn't active yet (future goal)

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "ID": "43c66415-20cd-4430-afad-f76af2113503",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "GoalType": 64,
  "DisplayType": 64,
  "DisplayColor": 64,
  "BoundaryType": 64,
  "CurrentValue": 8.1,
  "TargetValue": 9.1,
  "DisplayValue": 10.1,
  "StartValue": 11.1,
  "EndValue": 12.1,
  "CurrentDecimalLength": 13,
  "TargetDecimalLength": 14,
  "FinalDecimalLength": 15,
  "TeamID": "b340c4a9-6cc9-440d-b102-f31a9f399e71",
  "YellowTolerance": 17.1,
  "RedTolerance": 18.1,
  "WaypointType": 19,
  "InTeamChildrenIDs": [
    "78350372-2d2b-47dc-a950-6822a1a1a296",
    "cd78dab0-a690-42b3-93d7-4a4eb09fda72"
  ],
  "InTeamParentIDs": [
    "a431135b-998e-48e3-9925-5092132cbbcb",
    "6e88e5fa-34ef-4cd9-bdbb-e09206428ad3"
  ],
  "OutTeamChildrenIDs": [
    "e90bc189-a0d5-4c94-b94e-aea271ecc5ba",
    "f64f6b77-8b5d-4fa7-b3d0-b7dd4c5aa3d3"
  ],
  "OutTeamParentIDs": [
    "a9de5dc3-ac11-4a0a-ad9e-ddd829a6e0fd",
    "d2faf9fd-9db9-4322-9008-dc58027092e6"
  ],
  "IsRetired": true,
  "IsDeleted": true,
  "IsFuture": true
}