POST api/Favorite/Add

Add a single favorite to your Team Road Warrior account

Request Information

URI Parameters

None.

Body Parameters

AddFavoriteModel
NameDescriptionTypeAdditional information
Color

Color value for favorite

decimal number

Required

Range: inclusive between 0 and 1

Name

Display name of location

string

Required

String length: inclusive between 1 and 100

Address

Address of location (does not affect pin location)

string

Required

String length: inclusive between 1 and 200

Lat

Latitude of location (used for determining pin location)

decimal number

Required

Range: inclusive between -90 and 90

Lng

Longitude of location (used for determining pin location)

decimal number

Required

Range: inclusive between -180 and 180

ServiceTime

Service time in minutes

integer

Required

Range: inclusive between 1 and 999

Note

Note to be displayed for the location

string

String length: inclusive between 0 and 1000

Email

Email address for the location

string

String length: inclusive between 0 and 128

Phone

Phone number for the location

string

String length: inclusive between 0 and 50

ScheduleId

Unique Id of named schedule to attach to stop

globally unique identifier

None.

Request Formats

application/json, text/json
Sample:
{
  "Color": 0.5,
  "Name": "My new location",
  "Address": "123 Main Street, New York",
  "Lat": 33.0,
  "Lng": 33.0,
  "ServiceTime": 5,
  "Note": "A note goes here",
  "Email": "me@email.com",
  "Phone": "555-555-5555",
  "ScheduleId": null
}

Response Information

Resource Description

AddFavoriteResponseModel
NameDescriptionTypeAdditional information
FavoritesAdded

Number of favorites successfully added

integer

None.

IsSuccess

Did the operation succeed or not

boolean

None.

ErrorMessage

If there was an error, contains description of the error

string

None.

Response Formats

application/json, text/json
Sample:
{
  "FavoritesAdded": 1,
  "IsSuccess": true,
  "ErrorMessage": "Error message would go here"
}