GET web_api/securelink/mobile_locations/{id}

Get the Mobile Location result from the user's mobile device

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The SecureLink RequestId value that was returned in the POST request's response body should be included in the GET request's URL to refer to that specific item.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The response body will contain a SecureLinkLocationResult object with details on the result of the location request. If the mobile user has either not responded to the request yet or denied the request, then the SecureLinkLocationResult's GiactMobileLocationResult value will be null and the ErrorMessage value will contain the value "Location not available for this SecureLink RequestID".

SecureLinkLocationResult
NameDescriptionTypeAdditional information
LocationResult

Populated if the end user accepted the mobile location request

GiactMobileLocationResult

None.

ErrorMessage

Only populated if there is an error processing the request

string

None.

Response Formats

application/json, text/json

Sample:
{
  "LocationResult": {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "AccuracyRadius": 1.1,
    "Altitude": 3.1,
    "AltitudeAccuracy": 1.1,
    "Address": "sample string 4",
    "ZipPostalCode": "sample string 5",
    "City": "sample string 6",
    "StateRegion": "sample string 7",
    "CountyDistrict": "sample string 8",
    "Country": "sample string 9",
    "Distance": 1
  },
  "ErrorMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<SecureLinkLocationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.giact.com/verificationservices/v5">
  <ErrorMessage>sample string 1</ErrorMessage>
  <LocationResult>
    <AccuracyRadius>1.1</AccuracyRadius>
    <Address>sample string 4</Address>
    <Altitude>3.1</Altitude>
    <AltitudeAccuracy>1.1</AltitudeAccuracy>
    <City>sample string 6</City>
    <Country>sample string 9</Country>
    <CountyDistrict>sample string 8</CountyDistrict>
    <Distance>1</Distance>
    <Latitude>1.1</Latitude>
    <Longitude>2.1</Longitude>
    <StateRegion>sample string 7</StateRegion>
    <ZipPostalCode>sample string 5</ZipPostalCode>
  </LocationResult>
</SecureLinkLocationResult>