Actions

History

Family Place Management » History » Revision 1

Revision 1/2 | Next »
Eric Vieillevigne, 05/12/2015 05:47 PM

Table of contents
Point Of interest- POI

Point Of interest- POI¶

The poi API is used to manage the Point of interest entered by the member of the family.

Get POI List- poigetall¶

The method poigetall enables a logged user to retrieve all the POI shared by the family

By sending an HTTP request http://devserver/api/poi/getall?

Parameters:

No parameters necessary for this method

The method returns the list of POI Ipoi.

Response:

{
  "cn":"poigetall",
  "feed":[
    {
      "isTemporary":"true",/*Is Temporary is used for temporary location suchas phone location*/
      "accountId":"133",/*Author of the POi*/
      "mapURI":"http:\/\/devserver\/media\/144_5790?",/*Url address of the google map*/
      "placeTips":[],/*associated tip*/
      "placeId":"144_1453",/*Unique Id of the place*/
      "address":{/*Geocoding information*/
        "latitudeE6":"48824623",
        "attribute3ZipCode":"92310",
        "attribute2Town":"Sèvres",
        "attribute0Country":"France",
        "attribute4Line":"Chemin de Halage",
        "radius":"230",
        "formattedAddress":"Chemin de Halage, 92310 Sèvres, France",
        "longitudeE6":"2228993",
        "accuracy":"5",/*Accuracy please see Google Map documentation*/
        "attribute1State":"Île-de-France" 
      },
      "name":"Chemin de Halage 92310 Sèvres France",/*Name of the place*/
      "pictureURIs":[],/*Define picture of the place*/
      "placeType":"UNKNOWN"/*Type of the place*/
    },{
      "isTemporary":"true",
      "accountId":"133",
      "mapURI":"http:\/\/devserver\/media\/144_8631?",
      "placeTips":[],
      "placeId":"144_1856",
      "address":{
        "latitudeE6":"48899165",
        "attribute3ZipCode":"92110",
        "attribute2Town":"Clichy",
        "attribute0Country":"France",
        "attribute4Line":"40 Boulevard Jean Jaurès",
        "radius":"125",
        "formattedAddress":"40 Boulevard Jean Jaurès, 92110 Clichy, France",
        "longitudeE6":"2307130",
        "accuracy":"5",
        "attribute1State":"Île-de-France" 
      },
      "name":"40 Boulevard Jean Jaurès 92110 Clichy France",
      "pictureURIs":[],
      "placeType":"UNKNOWN" 
      }

    }
  ]
}

Error:

Error Code	Type	Value	Description
FizMediaQuotaExceededException	ex	601	Media Quota exceedded
FizApiUnattendedException	un	500	Unattended Exception
FizAccountNotFoundInSessionException	un	501	Session is invalid
FizApiInvalidParameterException	un	502	invalid token
FizApiModelDoesNotExistException	un	503	Object does not exists
FizApiModelRightException	un	504	Right exception to use this method

Get POI - poiget¶

The method poiget enables a logged user to retreive a poi with a specific placeId.

By sending an HTTP request http://devserver/api/poi/get?placeId=144_1453

Parameters:

Name	Type	Description
placeId	String	Place Id of the POI queried

The method returns the POI information Iplace.

Response:

{
  "cn":"poiget",
  "feed":{
    "isTemporary":"true",
    "accountId":"133",
    "mapURI":"http:\/\/devserver\/media\/144_5790?",
    "placeTips":[],
    "placeId":"144_1453",
    "address":{
      "latitudeE6":"48824623",
      "attribute3ZipCode":"92310",
      "attribute2Town":"Sèvres",
      "attribute0Country":"France",
      "attribute4Line":"Chemin de Halage",
      "radius":"230",
      "formattedAddress":"Chemin de Halage, 92310 Sèvres, France",
      "longitudeE6":"2228993",
      "accuracy":"5",
      "attribute1State":"Île-de-France" 
    },
    "name":"Chemin de Halage 92310 Sèvres France",
    "pictureURIs":[],
    "placeType":"UNKNOWN" 
  }
}

Error:

Error Code	Type	Value	Description
FizMediaQuotaExceededException	ex	601	Media Quota exceedded
FizApiUnattendedException	un	500	Unattended Exception
FizAccountNotFoundInSessionException	un	501	Session is invalid
FizApiInvalidParameterException	un	502	invalid token
FizApiModelDoesNotExistException	un	503	Object does not exists
FizApiModelRightException	un	504	Right exception to use this method

Create a POI - poicreate¶

The method poicreate enables a logged user to create a poi.

By sending an HTTP request http://devserver/api/poi/create?placeId=144_1453

Parameters:

Name	Type	Description
name	String	Name of the POI - required field
geocodedAddress.accuracy	String	accuracy of the address (0 if a country, 5 if a precise address with street number)
geocodedAddress.attribute0Country	string	Country where the address is
geocodedAddress.attribute1State	string	State where the address is
geocodedAddress.attribute2Town	string	Town where the address is
geocodedAddress.attribute3ZipCode	string	Zipcode where the address is
geocodedAddress.attribute4Line	string	line of the address (ex : 3 st-james street)
geocodedAddress.formattedAddress	string	the well formatted address latitude as an int
geocodedAddress.latitudeE6	string	the well formatted address latitude as an int (* 1 000 000)
geocodedAddress.longitudeE6	string	the well formatted address longitude as an int (* 1 000 000)
geocodedAddress.radius	string	the radius of the place in meter
placeType	String Value	Place Type UNKNOWN,SPORT,SCHOOL,HOME,SHOPPING,MUSIC,PARK,WORK
contactId	String	contact Id of the contact linked to the place (e.g. Place of Mr. Smith)
text	String	text describing the place
picture	binary or url	multiples files to attach with a place

The method returns the POI information Iplace.

Response:

{
  "cn":"poicreate",
  "feed":{
    "isTemporary":"true",
    "accountId":"133",
    "mapURI":"http:\/\/devserver\/media\/144_5790?",
    "placeTips":[],
    "placeId":"144_1453",
    "address":{
      "latitudeE6":"48824623",
      "attribute3ZipCode":"92310",
      "attribute2Town":"Sèvres",
      "attribute0Country":"France",
      "attribute4Line":"Chemin de Halage",
      "radius":"230",
      "formattedAddress":"Chemin de Halage, 92310 Sèvres, France",
      "longitudeE6":"2228993",
      "accuracy":"5",
      "attribute1State":"Île-de-France" 
    },
    "name":"Chemin de Halage 92310 Sèvres France",
    "pictureURIs":[],
    "placeType":"UNKNOWN" 
  }
}

Error:

Error Code	Type	Value	Description
FizApiUnattendedException	un	500	Unattended Exception
FizAccountNotFoundInSessionException	un	501	Session is invalid
FizApiInvalidParameterException	un	502	invalid token
FizApiModelDoesNotExistException	un	503	Object does not exists
FizApiModelRightException	un	504	Right exception to use this method

Create a simple POI - poicreatesimple¶

The method poicreatesimple enables a logged user to rcreate a simple Place with no geocode information necessary (typicaly createsimple is used by web cl.

By sending an HTTP request http://devserver/api/poi/createsimple?placeId=144_1453

Parameters:

Name	Type	Description
name	String	Name of the POI - required field
address	String	Full Address number street,zipcode,town,country or free form. Address will then be geocoded using google
placeType	String Value	Place Type UNKNOWN,SPORT,SCHOOL,HOME,SHOPPING,MUSIC,PARK,WORK
contactId	String	contact Id of the contact linked to the place (e.g. Place of Mr. Smith)
text	String	text describing the place
picture	binary or url	multiples files to attach with a place

The method returns the POI information Iplace.

Response:

{
  "cn":"poicreatesimple",
  "feed":{
    "isTemporary":"false",
    "accountId":"130",
    "mapURI":"http:\/\/devserver\/media\/144_11588?",
    "placeTips":[],
    "placeId":"144_2008",
    "address":{
      "latitudeE6":"48878318",
      "attribute3ZipCode":"75017",
      "attribute2Town":"Paris",
      "attribute0Country":"France",
      "attribute4Line":"36 Rue Brunel",
      "radius":"125",
      "formattedAddress":"36 Rue Brunel, 75017 Paris, France",
      "longitudeE6":"2287954",
      "accuracy":"5",
      "attribute1State":"Île-de-France" 
    },
    "name":"my place",
    "pictureURIs":[],
    "placeType":"WORK" 
  }
 }

Error:

Error Code	Type	Value	Description
FizApiUnattendedException	un	500	Unattended Exception
FizAccountNotFoundInSessionException	un	501	Session is invalid
FizApiInvalidParameterException	un	502	invalid token
FizApiModelDoesNotExistException	un	503	Object does not exists
FizApiModelRightException	un	504	Right exception to use this method

POI Update - poiupdate¶

The method poiupdate a logged user to update a simple Place with no geocode information necessary .

By sending an HTTP request http://devserver/api/poi/update

Parameters:

Name	Type	Description
placeId	String	Id of the place to be updated
name	String	Name of the POI - required field
address	String	Full Address number street,zipcode,town,country or free form. Address will then be geocoded using google
placeType	String Value	Place Type UNKNOWN,SPORT,SCHOOL,HOME,SHOPPING,MUSIC,PARK,WORK
contactId	String	contact Id of the contact linked to the place (e.g. Place of Mr. Smith)
text	String	text describing the place
picture	binary or url	multiples files to attach with a place

The method returns the POI information Iplace.

Response:

{
  "cn":"poicreatesimple",
  "feed":{
    "isTemporary":"false",
    "accountId":"130",
    "mapURI":"http:\/\/devserver\/media\/144_11588?",
    "placeTips":[],
    "placeId":"144_2008",
    "address":{
      "latitudeE6":"48878318",
      "attribute3ZipCode":"75017",
      "attribute2Town":"Paris",
      "attribute0Country":"France",
      "attribute4Line":"36 Rue Brunel",
      "radius":"125",
      "formattedAddress":"36 Rue Brunel, 75017 Paris, France",
      "longitudeE6":"2287954",
      "accuracy":"5",
      "attribute1State":"Île-de-France" 
    },
    "name":"my place",
    "pictureURIs":[],
    "placeType":"WORK" 
  }
 }

Error:

Error Code	Type	Value	Description
FizApiUnattendedException	un	500	Unattended Exception
FizAccountNotFoundInSessionException	un	501	Session is invalid
FizApiInvalidParameterException	un	502	invalid token
FizApiModelDoesNotExistException	un	503	Object does not exists
FizApiModelRightException	un	504	Right exception to use this method

Create a tip for a POI - poicreatetip¶

The method poicreatetip enables a logged user to create a TIP (textual information attach to POI (e.g. 'entry code is 4353434') Place with a specific PlaceId.

By sending an HTTP request http://devserver/api/poi/createtip?placeId=144_1453&text=My%20new%20tip%20from%20API
Parameters:

Name	Type	Description
placeId	String	Id of the place you want to add a tip
text	String	text describing the tip

The method returns the POI information IplaceTip.

Response:

{
  "cn":"poicreatetip",
  "feed":{
    "text":"My new tip from API",
    "accountId":"130",
    "placeTipId":"144_1453_202" 
  }
}

Error:

Error Code	Type	Value	Description
FizApiUnattendedException	un	500	Unattended Exception
FizAccountNotFoundInSessionException	un	501	Session is invalid
FizApiInvalidParameterException	un	502	invalid token
FizApiModelDoesNotExistException	un	503	Object does not exists
FizApiModelRightException	un	504	Right exception to use this method

delete a POI - poidelete¶

The method poidelete enables a logged user to delete a Place with a specific PlaceId.

By sending an HTTP request http://devserver/api/poi/delete?placeId=144_1453

Parameters:

Name	Type	Description
placeId	String	Id of the place you want to add a tip

The method returns a boleean.

Response:

{
  "cn":"poidelete",
  "feed":"true" 
}

Error:

Error Code	Type	Value	Description
FizApiUnattendedException	un	500	Unattended Exception
FizAccountNotFoundInSessionException	un	501	Session is invalid
FizApiInvalidParameterException	un	502	invalid token
FizApiModelDoesNotExistException	un	503	Object does not exists
FizApiModelRightException	un	504	Right exception to use this method

POI Nearby - poinearby¶

The method poinearby enables a logged user to list the POI nearby a certain position express in latitude and longitude.

By sending an HTTP request http://devserver/api/poi/nearby?latitudeE6=48825973&longitudeE6=2226752

Parameters:

Name	Type	Description
latitudeE6	string	latitude as an int (* 1 000 000)
longitudeE6	string	longitude as an int (* 1 000 000)

The method returns 2 lists of Iplaces:
1-'nearbyPlaces':Ordered by distance named
2-'otherPlaces'Ordered by name

Response:

{
  "cn":"poinearby",
  "feed":{
    "nearbyPlaces":[
      {
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/devserver\/media\/144_8634?",
        "placeTips":[],
        "placeId":"144_1858",
        "address":{
          "latitudeE6":"48825973",
          "attribute3ZipCode":"92310",
          "attribute2Town":"Sèvres",
          "attribute0Country":"France",
          "attribute4Line":"20 Rue Troyon",
          "radius":"125",
          "formattedAddress":"20 Rue Troyon, 92310 Sèvres, France",
          "longitudeE6":"2226752",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"20 Rue Troyon 92310 Sèvres France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/devserver\/media\/144_8640?",
        "placeTips":[],
        "placeId":"144_1862",
        "address":{
          "latitudeE6":"48825973",
          "attribute3ZipCode":"92310",
          "attribute2Town":"Sèvres",
          "attribute0Country":"France",
          "attribute4Line":"20 Rue Troyon",
          "radius":"125",
          "formattedAddress":"20 Rue Troyon, 92310 Sèvres, France",
          "longitudeE6":"2226752",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"20 Rue Troyon 92310 Sèvres France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8648?",
        "placeTips":[],
        "placeId":"144_1866",
        "address":{
          "latitudeE6":"48825973",
          "attribute3ZipCode":"92310",
          "attribute2Town":"Sèvres",
          "attribute0Country":"France",
          "attribute4Line":"20 Rue Troyon",
          "radius":"125",
          "formattedAddress":"20 Rue Troyon, 92310 Sèvres, France",
          "longitudeE6":"2226752",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"20 Rue Troyon 92310 Sèvres France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/devserver\/media\/144_8636?",
        "placeTips":[],
        "placeId":"144_1859",
        "address":{
          "latitudeE6":"48826060",
          "attribute3ZipCode":"92310",
          "attribute2Town":"Sèvres",
          "attribute0Country":"France",
          "attribute4Line":"16 Rue Troyon",
          "radius":"125",
          "formattedAddress":"16 Rue Troyon, 92310 Sèvres, France",
          "longitudeE6":"2226413",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"16 Rue Troyon 92310 Sèvres France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/devserver\/media\/144_8686?",
        "placeTips":[],
        "placeId":"144_1904",
        "address":{
          "latitudeE6":"48826060",
          "attribute3ZipCode":"92310",
          "attribute2Town":"Sèvres",
          "attribute0Country":"France",
          "attribute4Line":"16 Rue Troyon",
          "radius":"125",
          "formattedAddress":"16 Rue Troyon, 92310 Sèvres, France",
          "longitudeE6":"2226413",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"16 Rue Troyon 92310 Sèvres France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_8662?",
        "placeTips":[],
        "placeId":"144_1882",
        "address":{
          "latitudeE6":"48824270",
          "attribute3ZipCode":"",
          "attribute2Town":"Sèvres",
          "attribute0Country":"France",
          "attribute4Line":"",
          "radius":"1997",
          "formattedAddress":"Sèvres, France",
          "longitudeE6":"2215421",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"Sèvres France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      }
    ],
    "otherPlaces":[
      {
        "isTemporary":"true",
        "accountId":"130",
        "mapURI":"http:\/\/devserver\/media\/144_9044?",
        "placeTips":[],
        "placeId":"144_1945",
        "address":{
          "latitudeE6":"40742627",
          "attribute3ZipCode":"10011",
          "attribute2Town":"New York",
          "attribute0Country":"United States",
          "attribute4Line":"153 W 21st St",
          "radius":"131",
          "formattedAddress":"153 W 21st St, New York, NY 10011, USA",
          "longitudeE6":"-73995555",
          "accuracy":"5",
          "attribute1State":"New York" 
        },
        "name":"153 W 21st St Manhattan, NY 10011 USA",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/devserver\/media\/144_9931?",
        "placeTips":[],
        "placeId":"144_1970",
        "address":{
          "latitudeE6":"40742627",
          "attribute3ZipCode":"10011",
          "attribute2Town":"New York",
          "attribute0Country":"United States",
          "attribute4Line":"153 W 21st St",
          "radius":"131",
          "formattedAddress":"153 W 21st St, New York, NY 10011, USA",
          "longitudeE6":"-73995555",
          "accuracy":"5",
          "attribute1State":"New York" 
        },
        "name":"153 W 21st St Manhattan, NY 10011 USA",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"130",
        "mapURI":"http:\/\/devserver\/144_11229?",
        "placeTips":[],
        "placeId":"144_2000",
        "address":{
          "latitudeE6":"48866034",
          "attribute3ZipCode":"93360",
          "attribute2Town":"Neuilly-Plaisance",
          "attribute0Country":"France",
          "attribute4Line":"10 Rue des Morands",
          "radius":"125",
          "formattedAddress":"10 Rue des Morands, 93360 Neuilly-Plaisance, France",
          "longitudeE6":"2509519",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"4-10 Rue des Morands 93360 Neuilly-Plaisance France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/devserver\/media\/144_8631?",
        "placeTips":[],
        "placeId":"144_1856",
        "address":{
          "latitudeE6":"48899165",
          "attribute3ZipCode":"92110",
          "attribute2Town":"Clichy",
          "attribute0Country":"France",
          "attribute4Line":"40 Boulevard Jean Jaurès",
          "radius":"125",
          "formattedAddress":"40 Boulevard Jean Jaurès, 92110 Clichy, France",
          "longitudeE6":"2307130",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"40 Boulevard Jean Jaurès 92110 Clichy France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"true",
        "accountId":"133",
        "mapURI":"http:\/\/devserver\/media\/144_9585?",
        "placeTips":[],
        "placeId":"144_1959",
        "address":{
          "latitudeE6":"48899165",
          "attribute3ZipCode":"92110",
          "attribute2Town":"Clichy",
          "attribute0Country":"France",
          "attribute4Line":"40 Boulevard Jean Jaurès",
          "radius":"125",
          "formattedAddress":"40 Boulevard Jean Jaurès, 92110 Clichy, France",
          "longitudeE6":"2307130",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"40 Boulevard Jean Jaurès 92110 Clichy France",
        "pictureURIs":[],
        "placeType":"UNKNOWN" 
      },{
        "isTemporary":"false",
        "text":"",
        "accountId":"133",
        "mapURI":"http:\/\/jeronimo.dnsalias.net\/fiztestdev\/media\/144_9829?",
        "placeTips":[],
        "placeId":"144_1968",
        "address":{
          "latitudeE6":"48865498",
          "attribute3ZipCode":"93360",
          "attribute2Town":"Neuilly-Plaisance",
          "attribute0Country":"France",
          "attribute4Line":"10 Allée de Bruges",
          "radius":"125",
          "formattedAddress":"10 Allée de Bruges, 93360 Neuilly-Plaisance, France",
          "longitudeE6":"2509900",
          "accuracy":"5",
          "attribute1State":"Île-de-France" 
        },
        "name":"maison Willy",
        "pictureURIs":[],
        "placeType":"HOME" 
      },
      }
    ]
  }
}

Error:

Error Code	Type	Value	Description
FizApiUnattendedException	un	500	Unattended Exception
FizAccountNotFoundInSessionException	un	501	Session is invalid
FizApiInvalidParameterException	un	502	invalid token
FizApiModelDoesNotExistException	un	503	Object does not exists
FizApiModelRightException	un	504	Right exception to use this method

Files (0)

Updated by Eric Vieillevigne over 10 years ago · 1 revisions

Project

General

Profile

FamilyWall API

Wiki

Family Place Management » History » Revision 1

Point Of interest- POI¶

Get POI List- poigetall¶

Get POI - poiget¶

Create a POI - poicreate¶

Create a simple POI - poicreatesimple¶

POI Update - poiupdate¶

Create a tip for a POI - poicreatetip¶

delete a POI - poidelete¶

POI Nearby - poinearby¶