https://github.com/pgrimaud/webservices-esgi

REST & SOAP APIs
https://github.com/pgrimaud/webservices-esgi

Last synced: 4 months ago
JSON representation

REST & SOAP APIs

• Host: GitHub
• URL: https://github.com/pgrimaud/webservices-esgi
• Owner: pgrimaud
• Created: 2014-04-29T12:54:53.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-07-01T08:41:45.000Z (almost 11 years ago)
• Last Synced: 2025-01-06T09:11:30.452Z (5 months ago)
• Language: PHP
• Homepage:
• Size: 2.03 MB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Webservices ESGI

## REST

    API server : http://sharetheworld.rest

L'API est principalement RESTful. Les données sont exposées sous la forme d'URI qui représentent des ressources et peuvent être récupérés via des clients HTTP (comme les navigateurs web).

## Requêtes countries

Ces requêtes permettent de récupérer des pays en fonction des paramètres.

*Construction d'une requête standard*

    GET Host+ /countries

    

    Host: sharetheworld.rest

    Method: GET

*Fichier retourné*

    

      

        1

        country_name

        code

        continent

      

      (...)

    

Il est possible d'affiner les recherches en plaçant les paramètres suivants:

    GET Host+ /countries?continent=Europe

    

    Host: sharetheworld.rest

    Method: GET

    Parameter : name | code | continent

*Fichier retourné*

    

      

        1

        country_name

        code

        Europe

      

      (...)

    

## Requêtes country

Ces requêtes permettent de récupérer un pays grâce à son id.

*Construction d'une requête standard*

    GET Host+ /country/:id

    

    Host: sharetheworld.rest

    Method: GET

*Fichier retourné*

    

      

        :id

        country_name

        code

        continent

      

    

## Requêtes towns

Ces requêtes permettent de récupérer des villes en fonction des paramètres.

*Construction d'une requête standard*

    GET Host+ /towns

    

    Host: sharetheworld.rest

    Method: GET

*Fichier retourné*

    

      

        id

        town_name

        population

        country_id

      

      (...)

    

Il est possible d'affiner les recherches en plaçant les paramètres suivants:

    GET Host+ /towns?country_id=1

    

    Host: sharetheworld.rest

    Method: GET

    Parameter : name | population| country_id

*Fichier retourné*

    

      

        id

        town_name

        population

        1

      

      (...)

    

## Requêtes town

Ces requêtes permettent de récupérer une ville grâce à son id.

*Construction d'une requête standard*

    GET Host+ /town/:id

    

    Host: sharetheworld.rest

    Method: GET

*Fichier retourné*

    

      

        :id

        town_name

        population

        country_id

      

    

## Requêtes places

Ces requêtes permettent de récupérer des lieux en fonction des paramètres.

*Construction d'une requête standard*

    GET Host+ /places

    

    Host: sharetheworld.rest

    Method: GET

*Fichier retourné*

    

      

        id

        place_name

        
address

        description

        latitude

        longitude

        town_id

      

      (...)

    


Il est possible d'affiner les recherches en plaçant les paramètres suivants:

    GET Host+ /places?town_id=1

    

    Host: sharetheworld.rest

    Method: GET

    Parameter : name | address| continent | country_id | town_id

*Fichier retourné*

    

      

        id

        place_name

        
address

        description

        latitude

        longitude

        1

      

      (...)

    


## Requêtes place

Ces requêtes permettent de récupérer un lieu grâce à son id.

*Construction d'une requête standard*

    GET Host+ /place/:id

    

    Host: sharetheworld.rest

    Method: GET

*Fichier retourné*

    

      

        :id

        place_name

        
address

        description

        latitude

        longitude

        town_id

      

    


Ces requêtes permettent l'ajout d'un lieu. Tous les paramètres sont requis.

*Construction d'une requête standard*

    GET Host+ /place

    

    Host: sharetheworld.rest

    Method: POST

    Parameters : name, address, town_id, description, latitude, longitude

## Erreurs

Les erreurs sont retournées sous le format suivant

    

       Error Message