This catalogue of success stories.

Supported Formats

json

GET /api/success-stories
List all success stories

Use the id field as parameter for other queries

Supported Formats

json

Errors

401 Unauthorized

Examples

GET /api/v1/success-stories
{
  "page": "1",
  "per_page": "2",
  "token": "valid_token"
}
200
{
  "total": 7,
  "page": 1,
  "per_page": 2,
  "results": [
    {
      "id": "explore-a",
      "title": "Explore A",
      "company": "abc-earth"
    },
    {
      "id": "sense-b",
      "title": "Sense B",
      "company": "abc-earth"
    }
  ]
}
GET /api/v1/success-stories
{
  "token": "invalid_token"
}
401
{
  "error": "unauthorized"
}
GET /api/v1/success-stories
{
  "market": "market-one",
  "token": "valid_token"
}
200
{
  "total": 2,
  "page": 1,
  "per_page": 2,
  "results": [
    {
      "id": "plague-extintion",
      "title": "Plague Extintion",
      "company": "abc-earth"
    },
    {
      "id": "soil-preservation",
      "title": "Soil Preservation",
      "company": "abc-earth"
    }
  ]
}
GET /api/v1/success-stories
{
  "type": "service-type-a",
  "token": "valid_token"
}
200
{
  "total": 2,
  "page": 1,
  "per_page": 2,
  "results": [
    {
      "id": "soil-preservation",
      "title": "Soil Preservation",
      "company": "abc-earth"
    },
    {
      "id": "water-purification",
      "title": "Water Purification",
      "company": "abc-earth"
    }
  ]
}
GET /api/v1/success-stories
{
  "continent": "alpha",
  "token": "valid_token"
}
200
{
  "total": 1,
  "page": 1,
  "per_page": 1,
  "results": [
    {
      "id": "soil-preservation",
      "title": "Soil Preservation",
      "company": "abc-earth"
    }
  ]
}
GET /api/v1/success-stories
{
  "region": "beta",
  "token": "valid_token"
}
200
{
  "total": 1,
  "page": 1,
  "per_page": 1,
  "results": [
    {
      "id": "soil-preservation",
      "title": "Soil Preservation",
      "company": "abc-earth"
    }
  ]
}
GET /api/v1/success-stories
{
  "token": "invalid_token"
}
401
{
  "error": "unauthorized"
}

Params

Param name Description
page
optional

page to be returned


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String
market
optional

id of the intended market of success stories


Value: Must be String
type
optional

id of type of success stories


Value: Must be String
continent
optional

id of the continent where success stories occurred


Value: Must be String
region
optional

id of the region where success stories occurred


Value: Must be String

GET /api/success-stories/:id
Shows detailed information

This information is also available in the eopages.eu website

Supported Formats

json

Errors

401 Unauthorized

Examples

GET /api/v1/success-stories/plague-extintion
{
  "token": "valid_token"
}
200
{
  "title": "Plague Extintion",
  "summary": "A large text about the service and other info",
  "company": "abc-earth",
  "service": null,
  "client-name": "the client name",
  "client-url": "http://the-client.com",
  "source-name": "the source name",
  "source-url": "http://some-nice-data.com",
  "copyright-name": "the copyright name",
  "copyright-url": "http://copy-advice.com",
  "background-project": "Extra long description about the project",
  "issue-and-needs": "Issues and needs covered",
  "proposed-solution": "The solution proposed in the case",
  "industry-perspective": "An industry point of view",
  "cost-justification": "Explanation about costs",
  "return-of-investment": "The investment repayment data",
  "additional-information": "More info about the case",
  "continents": [
    {
      "id": "europe",
      "name": "Europe"
    },
    {
      "id": "america",
      "name": "America"
    }
  ],
  "regions": [
    {
      "id": "east-europe",
      "name": "East Europe"
    },
    {
      "id": "west-europe",
      "name": "West Europe"
    },
    {
      "id": "south-america",
      "name": "South America"
    },
    {
      "id": "north-america",
      "name": "North America"
    }
  ],
  "photo-gallery": [
    {
      "title": "Photo 01",
      "url": "http://eopagestest.s3.amazonaws.com/assets/23/crop/image_01.jpg"
    },
    {
      "title": "Second Image",
      "url": "http://eopagestest.s3.amazonaws.com/assets/24/crop/foto_02.jpg"
    }
  ]
}
GET /api/v1/success-stories/it-dont-exists
{
  "token": "valid_token"
}
404
{
  "error": "not found"
}
GET /api/v1/success-stories/plague-extintion
{
  "token": "invalid_token"
}
401
{
  "error": "unauthorized"
}

Params

Param name Description
id
optional

success story id, could be obtained from the 'list of success stories' query or company details


Value: Must be String