Added draft of response codes for #14

docs/clinical-content/elevated-bll-map.md

@@ -0,0 +1,5 @@
+<form method="get" action="/assets/files/BLL-map.pdf">
+   <button type="submit" class="btn"><span style="font-weight: 600">Download <i class="material-icons" style="color: #fff; font-size: 24px">file_download</i></span></button>
+</form>
+
+![Map of Elevated Blood Lead Levels](/assets/images/BLL-map.png)

docs/clinical-content/lead-faq-en.md

@@ -0,0 +1,42 @@
+<form method="get" action="/assets/files/FAQ.English.Spanish.02.22.2017.pdf">
+   <button type="submit" class="btn"><span style="font-weight: 600">Download Lead FAQ <i class="material-icons" style="color: #fff; font-size: 24px">file_download</i></span></button>
+</form>
+
+
+## What are the health effects of lead on children?
+
+Lead in children, even at low levels, can affect their developing brain and nervous system. This may result in decreased academic achievement and IQ, increased risk of attention-related and problem behaviors, and decreased hearing. Lead can also effect a child’s growth.
+
+## How are most children in Chicago exposed to lead?
+
+In Chicago, children are most likely to be exposed to lead while living or staying in older homes or apartments that have lead paint. Most homes built before 1978 (when lead paint was banned in the U.S.) have some lead paint on the inside and outside of the building. When old paint cracks and peels, it makes lead dust. Lead dust is so small you cannot see it or smell it. Children may get lead poisoning from swallowing or breathing in lead dust on their hands and toys.
+
+## What are other ways children can be exposed to lead?
+
+Lead can also be found in soil, water, pots, containers, candy, folk medicine, cosmetics made in other countries, and some toys and toy jewelry. For up-to-date information on recalls of toys and other products that contain lead you can check [http://www.cpsc.gov](http://www.cpsc.gov).
+
+## Who is at greatest risk of lead poisoning in Chicago?
+
+We worry most about young children (especially ages 0-3, but up to age 6) both because their brains are developing rapidly and because they are more likely to put their hands and objects contaminated with lead dust into their mouths. Children who live in older, poorly maintained homes or apartments or who have parents who are exposed to lead at work or through other activities are also at increased risk for lead poisoning.
+
+## How do I know if my child has lead poisoning?
+
+A simple blood test is the only way to know if your child has lead poisoning. Most
+children who have lead poisoning do not look or act sick.
+
+## Are there any foods that help prevent lead poisoning? 
+
+Giving your child healthy foods is important for healthy development and is also helpful for preventing lead poisoning. Foods with calcium, iron, and Vitamin C can help keep lead out of the body. Calcium is in milk, yogurt, cheese, and leafy green vegetables like spinach. Iron is in red meats, beans, peanut butter, and cereals. Vitamin C is in oranges, green and red peppers, and juice. Ask your doctor if you have any questions about this.
+
+## What else can I do to protect my child from lead exposure inside my home?
+
+Household dust is a major source of lead. Windowsills and window wells, in particular, can contain a lot of leaded dust. Clean your home weekly. Use a solution of water and cleaner to wet-mop floors and to wipe windowsills and other surfaces. Don’t reuse cloths or sponges on dishes or counters. Don’t dry-dust, sweep, or vacuum as these activities can spread lead dust. Remove shoes prior to entering the home. Wash hands and toys often with soap and water and always wash hands before eating and sleeping. When possible, windows should be shut to prevent abrasion of painted surfaces. In addition, parents who work in auto repair, construction, or plumbing, or who make stained glass or use firing ranges can carry lead dust on themselves, so they should shower and change clothes before interacting with young children.
+
+## Is there any financial assistance available to fix lead hazards in my home or apartment? 
+
+Yes. CDPH has a program available that can provide financial assistance to fix lead hazards. <span style="background: #F3F315">For more information, please call (312) 747-LEAD (5323).</a>
+
+**For additional information visit:** [https://www.epa.gov/lead/learn-about-lead#lower](https://www.epa.gov/lead/learn-about-lead#lower) or [http://www.cdc.gov/nceh/lead/](http://www.cdc.gov/nceh/lead/)
+
+
+

docs/clinical-content/lead-faq-es.md

@@ -0,0 +1,48 @@
+<form method="get" action="/assets/files/FAQ.English.Spanish.02.22.2017.pdf">
+   <button type="submit" class="btn"><div style="font-weight: 600">Descargar Plomo FAQ <i class="material-icons" style="color: #fff; font-size: 24px">file_download</i></div></button>
+</form>
+
+## ¿Cuáles son los efectos del plomo en la salud de los niños?
+
+El plomo en los niños, aún en bajos niveles, puede afectar el desarrollo del cerebro y sistema nervioso. Esto puede provocar una disminución en los logros académicos y el CI, mayor riesgo de comportamientos problemáticos y relacionados a la atención, así como disminución en la audición. El plomo también puede afectar el crecimiento de un niño. 
+
+## ¿De qué manera está expuesta al plomo la mayoría de los niños en Chicago? 
+
+En Chicago, es más común que los niños estén expuestos al plomo mientras viven o se quedan en casas antiguas o apartamentos que tienen pintura a base de plomo. La mayoría de las casas construidas antes de 1978 (cuando la pintura a base de plomo fue prohibida en los Estados Unidos) tiene algo de pintura a base de plomo en el interior y exterior del edificio. Cuando la pintura vieja se agrieta o se levanta, crea polvo de plomo. El polvo de plomo es tan diminuto que no se puede ver ni oler. Los niños pueden intoxicarse con plomo al tragar o respirar el polvo de plomo que está en sus manos y juguetes.
+
+## ¿Cuáles son otras formas en las que los niños pueden estar expuestos al plomo?
+
+El plomo puede encontrarse también en la tierra, el agua, las
+ollas, los contenedores, los dulces, la medicina popular y los cosméticos hechos en otros países, al igual que algunos juguetes y joyería de juguete. Para obtener información actualizada sobre los juguetes y otros productos que pueden contener plomo, puede buscar en [http://www.cpsc.gov](http://www.cpsc.gov).
+
+
+## ¿Cuál es el mayor riesgo de envenenamiento por plomo en Chicago?
+
+Nos preocupamos más por los niños más pequeños (especialmente de 0 a 3
+años de edad, pero hasta 6 años) tanto porque sus cerebros están desarrollándose rápidamente como porque ellos son quienes más comúnmente meten sus manos y objetos contaminados con polvo de plomo en sus bocas. Los niños que viven en casas o apartamentos más antiguos y que reciben un mal mantenimiento o cuyos padres están expuestos al plomo en el trabajo o mediante otras actividades, también corren un mayor riesgo de envenenamiento por plomo.
+
+
+## ¿Cómo sé si mi hijo tiene envenenamiento por plomo?
+
+Un sencillo examen de sangre es la única forma de saber si su hijo tiene envenenamiento por plomo. La mayoría de los niños que padece envenenamiento por plomo no se ven ni actúan como si estuvieran enfermos.
+
+
+## ¿Existen algunos alimentos que puedan ayudar a prevenir el envenenamiento por plomo?
+
+Es importante darle alimentos saludables a su hijo para que tenga un desarrollo sano y esto también ayudará a prevenir el envenenamiento por plomo. Los alimentos que contienen calcio, hierro y vitamina C pueden ayudar a mantener el plomo fuera del cuerpo. El calcio se encuentra en la leche, el yogur, el queso y los vegetales de hojas verdes como la espinaca. El hierro se encuentra en las carnes rojas, los frijoles, la mantequilla de maní y los cereales. La vitamina C se encuentra en las naranjas, los chiles pimientos verdes y rojos, y el jugo. Si tiene alguna pregunta acerca de este aviso, consulte a su doctor.
+
+
+## ¿En qué otra forma puedo proteger a mi hijo contra la exposición al plomo dentro de mi casa? 
+
+El polvo doméstico es la fuente principal del plomo. Las repisas y los huecos de las ventanas, en particular, pueden contener mucho polvo de plomo. Limpie su casa semanalmente. Use una solución de agua y un producto de limpieza para trapear los pisos con el trapeador mojado y para limpiar las repisas de las ventanas y otras superficies. No vuela a usar trapos o esponjas en los platos o mostradores. No barra el piso con el polvo en seco, ni aspire ya que estas actividades pueden esparcir el polvo de plomo. Quítese los zapatos antes de entrar a la casa. Con frecuencia lávese las manos y lave los juguetes con agua y con jabón, y siempre lave sus manos antes de comer y de dormir. Cuando sea posible, las ventanas deben estar cerradas para prevenir la abrasión de las superficies pintadas. Además, los padres que trabajan en un taller automotriz, en construcción o plomería, o quienes pintan vidrio o utilizan campos de tiro pueden portar polvo de plomo sobre sí mismos, así que deben ducharse y cambiarse la ropa antes de interactuar con sus hijos
+pequeños.
+
+## ¿Existe alguna asistencia financiera disponible para determinar los riesgos de plomo en mi casa o apartamento?
+
+Sí. El CDPH tiene un programa disponible que puede proveer asistencia financiera para determinar los riesgos de plomo. <span style="background: #F3F315"> Para obtener más información, llame al (312) 747-LEAD (5323).</a>
+
+
+**Para obtener información adicional, visite:** https://www.epa.gov/lead/learn-about-lead#lower o http://www.cdc.gov/nceh/lead/
+
+
+

docs/index.md

@@ -169,6 +169,34 @@ GET <url>/get/
 }
 ```
 
+### Response Codes
+
+The API will return codes to indicate whether the prediction encountered any errors. Often, error codes will be accompanied by a longer explanation of the error in addition to the brief explanations below.
+
+|         Error Name          |  Error Code  |                                    Error Explanation                                         |
+|-----------------------------|:------------:|----------------------------------------------------------------------------------------------|
+| Success                     | 200          | No error.                                                                                    |
+| Missing data field          | 400          | A required field was not included in the submission.                                         |
+| Incorrect data type         | 400          | A field contained an unexpected data type that does not match submission requirements.       |
+| Incorrect date format       | 400          | One of the date formats is incorrect.                                                        |
+| Invalid JSON                | 400          | JSON structure was incomplete, contained unexpected characters, or was not properly closed.  |
+| Invalid race/ethnicity code | 400          | Value used to encode race or ethnicity does not match an expected value.                     |
+| Unauthorized                | 401          | Failed to provide authentication key or provided invalid key.                                |
+| Not Found                   | 404          | The URI requested is invalid or does not exist.                                              |
+| Child over 1 years-old      | 412          | The child is ineligible for Lead Safe.                                                       |
+| Address outside of Chicago  | 412          | Address is outside of Chicago or address failed to be geocoded within Chicago.               |
+
+```json
+"errors":
+  [
+    {
+      "message": "An error message which conveys details",
+      "code": 400
+    }
+  ]
+```
+
+
 ## Interpreting Risk Levels
 
 Elevated lead levels has severe impacts on a child's mental and physical development. When the API identifies elevated blood-lead levels, doctors are highly encouraged to conduct further blood tests

mkdocs.yml

@@ -1,13 +1,19 @@
 
 # Site Information
-site_name: Lead Safe API v0.5.0-alpha2
+site_name: Lead Safe API v0.5.0-alpha4
 site_author: City of Chicago
 site_description: Lead Free API Documentation
 site_url: http://dev.cityofchicago.org/docs/lead-free
 
 # Page Tree
 pages:
+
 - Home: index.md
+- 'Clinical Content':
+  - 'FAQ':
+    - English: 'clinical-content/lead-faq-en.md'
+    - Español: 'clinical-content/lead-faq-es.md'
+  - 'Map of Elevated BLL': 'clinical-content/elevated-bll-map.md'
 - 'Terms of Service': 'tos.md'
 - 'Apply for Lead Safe': 'apply.md'
 
@@ -20,7 +26,7 @@ copyright: Copyright &copy; 2016-2017 <a href="http://www.cityofchicago.org">Cit
 
 # Theme
 theme_dir: 'theme/material'
-site_favicon: 'assets/images/favicon.png'
+site_favicon: 'assets/images/favicon.ico'
 extra:
   logo: 'assets/images/city-seal-inverse-small.png'
   palette:
@@ -37,8 +43,8 @@ extra:
       link: 'http://dev.cityofchicago.org'
 extra_css:
   - 'stylesheets/extra.css'
-extra_javascript:
-  - 'javascripts/extra.js'
+# extra_javascript:
+#   - 'javascripts/extra.js'
 
 # Google Analytics
 # google_analytics: