Developer Feedback?

[Mc4llister]

Devs, any feedback on our first public and open API? Would love to make sure it's running smoothly for future projects.

Thanks @sshami !

Check it out:
@jamesdabbs
@dhaskew
@neerajrao
@Neetuj
@CindyFowler
@jkevintu
@rosariorobinson

[gbinal]

For convenience, here's a link to the documentation. The readme says that it'll be migrated there soon, which is great news.

[neerajrao]

Sorry for the late reply, Matthew. The API looks really good.

[Neetuj]

I might be not understanding the whole picture correctly so please feel
free to correct me here are the inputs i hav e

1. Page 1 .. it should be population instead of popuplation (most probably
   unintended spelling mistake)

2. i am not sure if i understand the country to region mapping .. can a
   country have multiples regoins ? or can a region have multiple countries ?
   or both ?

3. eitherways will it be useful to have region url in country API elements?

4. what is the difference between country page url and country site url
   and mobile page url ( i am assuming this is a seperate url for mobiles)
   ?? Also will it make sense to club all Urls in one list ( like in videos
   key-value name-url ??) that ways if there are more urls to be added
   later on ( like say region url ..) it can be done without changing the
   interface.

5. medical considerations is also not clear to me .. will ti always be a
   string only or could it be a list of strings ?? I am assuming that a
   country might have ebola+aids+thyriod e.t.c and there might be different
   considerations pertaining that .. is a string not too limiting ?

cheers,
Neetu

On Mon, Nov 24, 2014 at 11:04 AM, Gray Brooks [email protected]
wrote:

For convenience, here's a link to the documentation
https://github.com/PeaceCorps/Countries-Regions-REST-API/raw/master/API%20Documentation/Peace%20Corps%20Country%20%26%20Regions%20API%20Documention.pdf.
The readme says that it'll be migrated there soon, which is great news.

—
Reply to this email directly or view it on GitHub
#1 (comment)
.

[jkevintu]

Be sure to escape your html tag double quote in json object.

projects_list: "<h2> Make a Contribution</h2> 
<p> Learn more about Volunteer projects and how your contribution helps.</p> 
<p> <a href=" ">Volunteer Projects in Dominican Republic</a></p> ",

A valid response example can help developers for early prototype coding.

[jamesdabbs]

Very cool. I remember asking for a list of countries during the hackathon
weekend when we were starting Medlink - now you could just say "hey, hit
this API". 👍

@Neetuj https://github.com/Neetuj - My understanding is that each country
is in a single region. The "region" attribute is a slug that can be used to
look up details of that region (e.g. geography/countries/ghana is in
{"region": "africa"}, which you can drill into by going to
geograpy/regions/africa.

Any plans to expand this? Any goals outside the geography namespace?

On Tue, Dec 2, 2014 at 11:17 AM, Jereimah Kevin Tu <[email protected]

wrote:

Be sure to escape your html tag double quote in json object.

projects_list: "

Make a Contribution

Learn more about Volunteer projects and how your contribution helps.

Volunteer Projects in Dominican Republic

",

A valid response example can help developers for early prototype coding.

—
Reply to this email directly or view it on GitHub
#1 (comment)
.

[sshami]

Thanks for the helpful feedback everyone, I really appreciate it.

@Neetuj
Thanks for the feedback, I've addressed each of your questions & feedback below:

1. Page 1 .. it should be population instead of popuplation (most probably
   unintended spelling mistake)

Good catch! This has been fixed in the README file, but still needs to be fixed in the Documentation PDF file.

2. i am not sure if i understand the country to region mapping .. can a
   country have multiples regoins ? or can a region have multiple countries ?
   or both ?

The Regions API is a separate API from the Countries API. So when you call the Regions API (/api/v1/geography/regions) - you get all the Peace Corps regions. When you call the Countries API (/api/v1/geography/countries) - you get all the Peace Corps countries, and each country is within a specific region (indicated by the regions field). The two Regions and Countries APIs have no ties, think of them as two separate APIs. Hope that clarifies it.

3. eitherways will it be useful to have region url in country API elements?

That could be useful, we will consider it for the next version.

4. what is the difference between country page url and country site url
   and mobile page url ( i am assuming this is a seperate url for mobiles)
   ?? Also will it make sense to club all Urls in one list ( like in videos
   key-value name-url ??) that ways if there are more urls to be added
   later on ( like say region url ..) it can be done without changing the
   interface.

Country Page URL: This is the Country page within our Peace Corps website.
Mobile Page URL: This is the Country page within our Peace Corps Mobile website.
Country Site URL: This is the Country website - separate (subdomain) from the Peace Corps website.

If it’s helpful, I can add these descriptions to the documentation.

As for joining all URLs into one list like videos, that can be considered for the next version as well. Currently, each of those URLs are separate fields within our DB tables which is why they’re separated.

@jkevintu
Thanks, good call!

@jamesdabbs
As we receive more feedback, we can improve this API through version releases. We are also looking into opening up other useful data within the Peace Corps website through APIs.