Needio.Services

<back to all web services

AddUserLocationRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/User/AddUserLocation/
AddUserLocationRequest Parameters:
NameParameterData TypeRequiredDescription
LocationNamequerystringNo
LocationqueryGeoLocationNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
AddUserLocationResponse Parameters:
NameParameterData TypeRequiredDescription
userLocationformUserLocationDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ExYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
UserLocationDTO Parameters:
NameParameterData TypeRequiredDescription
UserLocationIdformintNo
UserIdformintNo
LocationNameformstringNo
LocationformGeoLocationNo
ActiveYnformboolNo
GeoLocation Parameters:
NameParameterData TypeRequiredDescription
LonformstringNo
LatformstringNo
GeoAddressformstringNo
IsDeletedformboolNo
AddUserLocationResponse Parameters:
NameParameterData TypeRequiredDescription
userLocationformUserLocationDTONo

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.

POST /User/AddUserLocation/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddUserLocationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:GeoAddress>String</d2p1:GeoAddress>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:Lat>String</d2p1:Lat>
    <d2p1:Lon>String</d2p1:Lon>
  </Location>
  <LocationName>String</LocationName>
</AddUserLocationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddUserLocationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <userLocation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:ActiveYn>false</d2p1:ActiveYn>
    <d2p1:Location>
      <d2p1:GeoAddress>String</d2p1:GeoAddress>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:Lat>String</d2p1:Lat>
      <d2p1:Lon>String</d2p1:Lon>
    </d2p1:Location>
    <d2p1:LocationName>String</d2p1:LocationName>
    <d2p1:UserId>0</d2p1:UserId>
    <d2p1:UserLocationId>0</d2p1:UserLocationId>
  </userLocation>
</AddUserLocationResponse>