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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LocationCoordinatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <input>String</input>
  <response>
    <LocationCoordinatesApiResponse.Data>
      <city>String</city>
      <country>String</country>
      <latitude>0</latitude>
      <longitude>0</longitude>
      <place_id>String</place_id>
      <state>String</state>
    </LocationCoordinatesApiResponse.Data>
  </response>
</LocationCoordinatesResponse>