YM REST Services

<back to all web services

Pinpoint

Returns the City, State and Country corresponding to a given set of longitude and latitude.

Requires Authentication
Requires any of the roles:member, admin
The following routes are available for this service:
GET/Ymc/{ClientID}/Member/{MemberID}/PinpointReturns the location city, state, country from coordinates.
Pinpoint Parameters:
NameParameterData TypeRequiredDescription
latquerydoubleNo
lngquerydoubleNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CityLookupResponse Parameters:
NameParameterData TypeRequiredDescription
responseformDataNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	response: 
	{
		city: String,
		state: String,
		country: String,
		latitude: 0,
		longitude: 0,
		place_id: String
	},
	lat: 0,
	lng: 0,
	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-03T06:59:57.9056082-04:00,
	Device: Desktop
}