YM REST Services

<back to all web services

LocationCoordinates

Returns a list coordinates with city, state, lat, long, given a location string. If multiple locations are found, no long/lat will be available.

Requires Authentication
Requires any of the roles:member, admin
The following routes are available for this service:
GET/Ymc/{ClientID}/Member/{MemberID}/LocationCoordinatesReturns a list of coordinates for a location string.
LocationCoordinates Parameters:
NameParameterData TypeRequiredDescription
inputquerystringNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
LocationCoordinatesResponse Parameters:
NameParameterData TypeRequiredDescription
responseformData[]No
Data Parameters:
NameParameterData TypeRequiredDescription
cityformstringNo
stateformstringNo
countryformstringNo
latitudeformdoubleNo
longitudeformdoubleNo
place_idformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ymc/{ClientID}/Member/{MemberID}/LocationCoordinates HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"response":[{"city":"String","state":"String","country":"String","latitude":0,"longitude":0,"place_id":"String"}],"input":"String","MemberID":0,"ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T08:07:49.1012673-04:00","Device":"Desktop"}