MaPlage.info GraphQL API Reference

Welcome to the MaPlage.info API documentation ! This reference includes the complete set of GraphQL types, queries and their parameters for getting Maplage.info data.

Contact

API Support

support@maplage.info

License

Apache 2.0

https://www.apache.org/licenses/LICENSE-2.0.html

Terms of Service

https://www.maplage.info

API Endpoints
https://tld.maplage.info/graphql
Headers
// Your token provided by SSO connection
Authorization: Bearer <YOUR_TOKEN_HERE>

Queries

alert

Description

Return one alert by identifier if exist or null given

Response

Returns an Alert

Arguments
Name Description
input - FindAlertInput!

Example

Query
query alert($input: FindAlertInput!) {
  alert(input: $input) {
    _id
    title
    detail
    datetime
    beach {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
    createdAt
  }
}
Variables
{"input": FindAlertInput}
Response
{
  "data": {
    "alert": {
      "_id": 4,
      "title": "abc123",
      "detail": "xyz789",
      "datetime": "xyz789",
      "beach": Beach,
      "createdAt": "2007-12-03T10:15:30Z"
    }
  }
}
Queries

alerts

Description

Return all alerts

Response

Returns [Alert!]!

Example

Query
query alerts {
  alerts {
    _id
    title
    detail
    datetime
    beach {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
    createdAt
  }
}
Response
{
  "data": {
    "alerts": [
      {
        "_id": 4,
        "title": "xyz789",
        "detail": "xyz789",
        "datetime": "abc123",
        "beach": Beach,
        "createdAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

alertsByBeach

Description

Return alerts by beach if exist or null given

Response

Returns [Alert!]

Arguments
Name Description
input - FindAlertInput!

Example

Query
query alertsByBeach($input: FindAlertInput!) {
  alertsByBeach(input: $input) {
    _id
    title
    detail
    datetime
    beach {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
    createdAt
  }
}
Variables
{"input": FindAlertInput}
Response
{
  "data": {
    "alertsByBeach": [
      {
        "_id": 4,
        "title": "abc123",
        "detail": "abc123",
        "datetime": "xyz789",
        "beach": Beach,
        "createdAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

alertsByCommunity

Description

Return alerts by user if exist or null given

Response

Returns [Alert!]

Arguments
Name Description
input - FindAlertInput!

Example

Query
query alertsByCommunity($input: FindAlertInput!) {
  alertsByCommunity(input: $input) {
    _id
    title
    detail
    datetime
    beach {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
    createdAt
  }
}
Variables
{"input": FindAlertInput}
Response
{
  "data": {
    "alertsByCommunity": [
      {
        "_id": 4,
        "title": "abc123",
        "detail": "abc123",
        "datetime": "xyz789",
        "beach": Beach,
        "createdAt": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

beach

Description

Return one beach by identifier if exist or null given

Response

Returns a Beach

Arguments
Name Description
input - FindBeachInput!

Example

Query
query beach($input: FindBeachInput!) {
  beach(input: $input) {
    _id
    name
    address
    postal_code
    insee_code
    location {
      type
      coordinates
    }
    picture
    webcam_url
    water_quality
    water_temperature
    attendance_bathing_area
    attendance_on_the_beach
    flag_color
    type
    equipment
    monitoring_periods {
      start_date
      end_date
      hours {
        ...HourPeriodFragment
      }
    }
    points_of_interest {
      picture
      category
      title
      link
    }
    community {
      _id
      name
      address
      location {
        ...LocationFragment
      }
      port
      alerts {
        ...AlertFragment
      }
      beaches {
        ...BeachFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
    }
    alerts {
      _id
      title
      detail
      datetime
      beach {
        ...BeachFragment
      }
      createdAt
    }
    weatherConditions {
      _id
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
      datetime
      beach {
        ...BeachFragment
      }
    }
    currentWeatherCondition {
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
    }
    tidalConditions {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
    currentTidalCondition {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
  }
}
Variables
{"input": FindBeachInput}
Response
{
  "data": {
    "beach": {
      "_id": 4,
      "name": "abc123",
      "address": "xyz789",
      "postal_code": "xyz789",
      "insee_code": "abc123",
      "location": Location,
      "picture": "xyz789",
      "webcam_url": "xyz789",
      "water_quality": "abc123",
      "water_temperature": 123.45,
      "attendance_bathing_area": "xyz789",
      "attendance_on_the_beach": "xyz789",
      "flag_color": "abc123",
      "type": "xyz789",
      "equipment": ["xyz789"],
      "monitoring_periods": [MonitoringPeriod],
      "points_of_interest": [PointOfInterest],
      "community": Community,
      "alerts": [Alert],
      "weatherConditions": [WeatherCondition],
      "currentWeatherCondition": CurrentWeatherCondition,
      "tidalConditions": [TidalCondition],
      "currentTidalCondition": TidalCondition
    }
  }
}
Queries

beaches

Description

Return all beaches

Response

Returns [Beach!]!

Example

Query
query beaches {
  beaches {
    _id
    name
    address
    postal_code
    insee_code
    location {
      type
      coordinates
    }
    picture
    webcam_url
    water_quality
    water_temperature
    attendance_bathing_area
    attendance_on_the_beach
    flag_color
    type
    equipment
    monitoring_periods {
      start_date
      end_date
      hours {
        ...HourPeriodFragment
      }
    }
    points_of_interest {
      picture
      category
      title
      link
    }
    community {
      _id
      name
      address
      location {
        ...LocationFragment
      }
      port
      alerts {
        ...AlertFragment
      }
      beaches {
        ...BeachFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
    }
    alerts {
      _id
      title
      detail
      datetime
      beach {
        ...BeachFragment
      }
      createdAt
    }
    weatherConditions {
      _id
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
      datetime
      beach {
        ...BeachFragment
      }
    }
    currentWeatherCondition {
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
    }
    tidalConditions {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
    currentTidalCondition {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
  }
}
Response
{
  "data": {
    "beaches": [
      {
        "_id": 4,
        "name": "xyz789",
        "address": "xyz789",
        "postal_code": "abc123",
        "insee_code": "xyz789",
        "location": Location,
        "picture": "xyz789",
        "webcam_url": "abc123",
        "water_quality": "abc123",
        "water_temperature": 987.65,
        "attendance_bathing_area": "abc123",
        "attendance_on_the_beach": "abc123",
        "flag_color": "xyz789",
        "type": "xyz789",
        "equipment": ["xyz789"],
        "monitoring_periods": [MonitoringPeriod],
        "points_of_interest": [PointOfInterest],
        "community": Community,
        "alerts": [Alert],
        "weatherConditions": [WeatherCondition],
        "currentWeatherCondition": CurrentWeatherCondition,
        "tidalConditions": [TidalCondition],
        "currentTidalCondition": TidalCondition
      }
    ]
  }
}
Queries

beachesByCommunity

Description

Return beaches by collectivity if exist or null given

Response

Returns [Beach!]

Arguments
Name Description
input - FindCommunityInput!

Example

Query
query beachesByCommunity($input: FindCommunityInput!) {
  beachesByCommunity(input: $input) {
    _id
    name
    address
    postal_code
    insee_code
    location {
      type
      coordinates
    }
    picture
    webcam_url
    water_quality
    water_temperature
    attendance_bathing_area
    attendance_on_the_beach
    flag_color
    type
    equipment
    monitoring_periods {
      start_date
      end_date
      hours {
        ...HourPeriodFragment
      }
    }
    points_of_interest {
      picture
      category
      title
      link
    }
    community {
      _id
      name
      address
      location {
        ...LocationFragment
      }
      port
      alerts {
        ...AlertFragment
      }
      beaches {
        ...BeachFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
    }
    alerts {
      _id
      title
      detail
      datetime
      beach {
        ...BeachFragment
      }
      createdAt
    }
    weatherConditions {
      _id
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
      datetime
      beach {
        ...BeachFragment
      }
    }
    currentWeatherCondition {
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
    }
    tidalConditions {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
    currentTidalCondition {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
  }
}
Variables
{"input": FindCommunityInput}
Response
{
  "data": {
    "beachesByCommunity": [
      {
        "_id": 4,
        "name": "abc123",
        "address": "abc123",
        "postal_code": "xyz789",
        "insee_code": "xyz789",
        "location": Location,
        "picture": "xyz789",
        "webcam_url": "xyz789",
        "water_quality": "abc123",
        "water_temperature": 987.65,
        "attendance_bathing_area": "xyz789",
        "attendance_on_the_beach": "abc123",
        "flag_color": "abc123",
        "type": "xyz789",
        "equipment": ["abc123"],
        "monitoring_periods": [MonitoringPeriod],
        "points_of_interest": [PointOfInterest],
        "community": Community,
        "alerts": [Alert],
        "weatherConditions": [WeatherCondition],
        "currentWeatherCondition": CurrentWeatherCondition,
        "tidalConditions": [TidalCondition],
        "currentTidalCondition": TidalCondition
      }
    ]
  }
}
Queries

beachesByInseeCode

Description

Return beaches by insee code if exist or null given

Response

Returns [Beach!]

Arguments
Name Description
input - FindBeachInput!

Example

Query
query beachesByInseeCode($input: FindBeachInput!) {
  beachesByInseeCode(input: $input) {
    _id
    name
    address
    postal_code
    insee_code
    location {
      type
      coordinates
    }
    picture
    webcam_url
    water_quality
    water_temperature
    attendance_bathing_area
    attendance_on_the_beach
    flag_color
    type
    equipment
    monitoring_periods {
      start_date
      end_date
      hours {
        ...HourPeriodFragment
      }
    }
    points_of_interest {
      picture
      category
      title
      link
    }
    community {
      _id
      name
      address
      location {
        ...LocationFragment
      }
      port
      alerts {
        ...AlertFragment
      }
      beaches {
        ...BeachFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
    }
    alerts {
      _id
      title
      detail
      datetime
      beach {
        ...BeachFragment
      }
      createdAt
    }
    weatherConditions {
      _id
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
      datetime
      beach {
        ...BeachFragment
      }
    }
    currentWeatherCondition {
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
    }
    tidalConditions {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
    currentTidalCondition {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
  }
}
Variables
{"input": FindBeachInput}
Response
{
  "data": {
    "beachesByInseeCode": [
      {
        "_id": 4,
        "name": "xyz789",
        "address": "xyz789",
        "postal_code": "abc123",
        "insee_code": "abc123",
        "location": Location,
        "picture": "abc123",
        "webcam_url": "abc123",
        "water_quality": "abc123",
        "water_temperature": 987.65,
        "attendance_bathing_area": "abc123",
        "attendance_on_the_beach": "abc123",
        "flag_color": "abc123",
        "type": "xyz789",
        "equipment": ["xyz789"],
        "monitoring_periods": [MonitoringPeriod],
        "points_of_interest": [PointOfInterest],
        "community": Community,
        "alerts": [Alert],
        "weatherConditions": [WeatherCondition],
        "currentWeatherCondition": CurrentWeatherCondition,
        "tidalConditions": [TidalCondition],
        "currentTidalCondition": TidalCondition
      }
    ]
  }
}
Queries

beachesByPostalCode

Description

Return beaches by postal code if exist or null given

Response

Returns [Beach!]

Arguments
Name Description
input - FindBeachInput!

Example

Query
query beachesByPostalCode($input: FindBeachInput!) {
  beachesByPostalCode(input: $input) {
    _id
    name
    address
    postal_code
    insee_code
    location {
      type
      coordinates
    }
    picture
    webcam_url
    water_quality
    water_temperature
    attendance_bathing_area
    attendance_on_the_beach
    flag_color
    type
    equipment
    monitoring_periods {
      start_date
      end_date
      hours {
        ...HourPeriodFragment
      }
    }
    points_of_interest {
      picture
      category
      title
      link
    }
    community {
      _id
      name
      address
      location {
        ...LocationFragment
      }
      port
      alerts {
        ...AlertFragment
      }
      beaches {
        ...BeachFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
    }
    alerts {
      _id
      title
      detail
      datetime
      beach {
        ...BeachFragment
      }
      createdAt
    }
    weatherConditions {
      _id
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
      datetime
      beach {
        ...BeachFragment
      }
    }
    currentWeatherCondition {
      temperature {
        ...TemperatureFragment
      }
      wind {
        ...WindFragment
      }
    }
    tidalConditions {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
    currentTidalCondition {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
  }
}
Variables
{"input": FindBeachInput}
Response
{
  "data": {
    "beachesByPostalCode": [
      {
        "_id": 4,
        "name": "xyz789",
        "address": "xyz789",
        "postal_code": "abc123",
        "insee_code": "abc123",
        "location": Location,
        "picture": "xyz789",
        "webcam_url": "xyz789",
        "water_quality": "abc123",
        "water_temperature": 123.45,
        "attendance_bathing_area": "xyz789",
        "attendance_on_the_beach": "xyz789",
        "flag_color": "xyz789",
        "type": "xyz789",
        "equipment": ["abc123"],
        "monitoring_periods": [MonitoringPeriod],
        "points_of_interest": [PointOfInterest],
        "community": Community,
        "alerts": [Alert],
        "weatherConditions": [WeatherCondition],
        "currentWeatherCondition": CurrentWeatherCondition,
        "tidalConditions": [TidalCondition],
        "currentTidalCondition": TidalCondition
      }
    ]
  }
}
Queries

communities

Description

Return all communities

Response

Returns [Community!]!

Example

Query
query communities {
  communities {
    _id
    name
    address
    location {
      type
      coordinates
    }
    port
    alerts {
      _id
      title
      detail
      datetime
      beach {
        ...BeachFragment
      }
      createdAt
    }
    beaches {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
    tidalConditions {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
  }
}
Response
{
  "data": {
    "communities": [
      {
        "_id": 4,
        "name": "xyz789",
        "address": "xyz789",
        "location": Location,
        "port": "xyz789",
        "alerts": [Alert],
        "beaches": [Beach],
        "tidalConditions": [TidalCondition]
      }
    ]
  }
}
Queries

community

Description

Return one community by identifier if exist or null given

Response

Returns a Community

Arguments
Name Description
input - FindCommunityInput!

Example

Query
query community($input: FindCommunityInput!) {
  community(input: $input) {
    _id
    name
    address
    location {
      type
      coordinates
    }
    port
    alerts {
      _id
      title
      detail
      datetime
      beach {
        ...BeachFragment
      }
      createdAt
    }
    beaches {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
    tidalConditions {
      _id
      datetime
      low_tide {
        ...TideFragment
      }
      high_sea {
        ...TideFragment
      }
      community
    }
  }
}
Variables
{"input": FindCommunityInput}
Response
{
  "data": {
    "community": {
      "_id": 4,
      "name": "xyz789",
      "address": "xyz789",
      "location": Location,
      "port": "abc123",
      "alerts": [Alert],
      "beaches": [Beach],
      "tidalConditions": [TidalCondition]
    }
  }
}
Queries

tidalConditionByCommunity

Description

Return all tidal condition by community identifier if exist or null given

Response

Returns [TidalCondition!]!

Arguments
Name Description
input - FindTidalConditionalInput!

Example

Query
query tidalConditionByCommunity($input: FindTidalConditionalInput!) {
  tidalConditionByCommunity(input: $input) {
    _id
    datetime
    low_tide {
      morning {
        ...PartTideFragment
      }
      evening {
        ...PartTideFragment
      }
    }
    high_sea {
      morning {
        ...PartTideFragment
      }
      evening {
        ...PartTideFragment
      }
    }
    community
  }
}
Variables
{"input": FindTidalConditionalInput}
Response
{
  "data": {
    "tidalConditionByCommunity": [
      {
        "_id": "xyz789",
        "datetime": "abc123",
        "low_tide": Tide,
        "high_sea": Tide,
        "community": "abc123"
      }
    ]
  }
}
Queries

tidalConditions

Description

Return all tidal condition

Response

Returns [TidalCondition!]!

Example

Query
query tidalConditions {
  tidalConditions {
    _id
    datetime
    low_tide {
      morning {
        ...PartTideFragment
      }
      evening {
        ...PartTideFragment
      }
    }
    high_sea {
      morning {
        ...PartTideFragment
      }
      evening {
        ...PartTideFragment
      }
    }
    community
  }
}
Response
{
  "data": {
    "tidalConditions": [
      {
        "_id": "abc123",
        "datetime": "xyz789",
        "low_tide": Tide,
        "high_sea": Tide,
        "community": "xyz789"
      }
    ]
  }
}
Queries

weatherCondition

Description

Return one weather condition by identifier if exist or null given

Response

Returns a WeatherCondition

Arguments
Name Description
input - FindWeatherConditionInput!

Example

Query
query weatherCondition($input: FindWeatherConditionInput!) {
  weatherCondition(input: $input) {
    _id
    temperature {
      description
      value
      datetime
      icon
    }
    wind {
      value
      datetime
    }
    datetime
    beach {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
  }
}
Variables
{"input": FindWeatherConditionInput}
Response
{
  "data": {
    "weatherCondition": {
      "_id": "abc123",
      "temperature": [Temperature],
      "wind": [Wind],
      "datetime": "abc123",
      "beach": Beach
    }
  }
}
Queries

weatherConditionByBeach

Description

Return weather condition by beach if exist or null given

Response

Returns [WeatherCondition!]

Arguments
Name Description
input - FindWeatherConditionInput!

Example

Query
query weatherConditionByBeach($input: FindWeatherConditionInput!) {
  weatherConditionByBeach(input: $input) {
    _id
    temperature {
      description
      value
      datetime
      icon
    }
    wind {
      value
      datetime
    }
    datetime
    beach {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
  }
}
Variables
{"input": FindWeatherConditionInput}
Response
{
  "data": {
    "weatherConditionByBeach": [
      {
        "_id": "xyz789",
        "temperature": [Temperature],
        "wind": [Wind],
        "datetime": "abc123",
        "beach": Beach
      }
    ]
  }
}
Queries

weatherConditions

Description

Return all weather condition

Response

Returns [WeatherCondition!]!

Example

Query
query weatherConditions {
  weatherConditions {
    _id
    temperature {
      description
      value
      datetime
      icon
    }
    wind {
      value
      datetime
    }
    datetime
    beach {
      _id
      name
      address
      postal_code
      insee_code
      location {
        ...LocationFragment
      }
      picture
      webcam_url
      water_quality
      water_temperature
      attendance_bathing_area
      attendance_on_the_beach
      flag_color
      type
      equipment
      monitoring_periods {
        ...MonitoringPeriodFragment
      }
      points_of_interest {
        ...PointOfInterestFragment
      }
      community {
        ...CommunityFragment
      }
      alerts {
        ...AlertFragment
      }
      weatherConditions {
        ...WeatherConditionFragment
      }
      currentWeatherCondition {
        ...CurrentWeatherConditionFragment
      }
      tidalConditions {
        ...TidalConditionFragment
      }
      currentTidalCondition {
        ...TidalConditionFragment
      }
    }
  }
}
Response
{
  "data": {
    "weatherConditions": [
      {
        "_id": "xyz789",
        "temperature": [Temperature],
        "wind": [Wind],
        "datetime": "abc123",
        "beach": Beach
      }
    ]
  }
}

Types

Alert

Description

An alert is declared by an aid station and matches to an event on a particular beach, an alert cannot be updated or deleted

Fields
Field Name Description
_id - ID! The unique id of the alert
title - String! The title of the alert
detail - String! The detail of the alert
datetime - String! The date and hour of the alert declaration as timestamp and rendered as datetime string by Middleware
beach - Beach! The beach related to the alert
createdAt - DateTime! The creation date of the alert
Example
{
  "_id": 4,
  "title": "xyz789",
  "detail": "abc123",
  "datetime": "xyz789",
  "beach": Beach,
  "createdAt": "2007-12-03T10:15:30Z"
}
Types

Beach

Description

This is the core object of MaPlage.info system, he describe a beach entity

Fields
Field Name Description
_id - ID! Unique id of beach
name - String! The name of the beach
address - String! The address of the beach (number and street)
postal_code - String! The french postal code of the beach
insee_code - String! The french insee code of the beach see here for the correspondence between PC and IC
location - Location! A geojson representation location of the beach
picture - String The link to the picture of the beach
webcam_url - String The link to the webcam of the beach
water_quality - String! The water quality of the beach, this can be good, average, bad and is rendered by Middleware with bonne, moyenne, mauvaise
water_temperature - Float! The water temperature of the beach
attendance_bathing_area - String! The attendance on the bathing area of the beach, this can be low, average, high and is rendered by Middleware with basse, moyenne, haute
attendance_on_the_beach - String! The attendance on the sand of the beach, this can be low, average, high and is rendered by Middleware with basse, moyenne, haute
flag_color - String! The flag color the beach, this can be red, yellow, green and is rendered by Middleware with Drapeau rouge, Drapeau jaune, Drapeau vert
type - String! The type of the beach (brown sand, white sand, black sand, etc...)
equipment - [String!] The equipment of the beach (lounge chair, beach umbrella, etc...)
monitoring_periods - [MonitoringPeriod!]! The monitoring period·s of the beach
points_of_interest - [PointOfInterest!] The point·s of interest related to the beach
community - Community! The community related to the beach
alerts - [Alert!]! The alert·s related to the beach
weatherConditions - [WeatherCondition!]! The last weather conditions related to the beach under 7 days
currentWeatherCondition - CurrentWeatherCondition! The current weather condition related to the beach
tidalConditions - [TidalCondition!]! All tidal condition related to the beach under 1 year
currentTidalCondition - TidalCondition! The current tidal condition related to the beach
Example
{
  "_id": "4",
  "name": "abc123",
  "address": "abc123",
  "postal_code": "xyz789",
  "insee_code": "abc123",
  "location": Location,
  "picture": "abc123",
  "webcam_url": "abc123",
  "water_quality": "xyz789",
  "water_temperature": 987.65,
  "attendance_bathing_area": "xyz789",
  "attendance_on_the_beach": "xyz789",
  "flag_color": "xyz789",
  "type": "xyz789",
  "equipment": ["abc123"],
  "monitoring_periods": [MonitoringPeriod],
  "points_of_interest": [PointOfInterest],
  "community": Community,
  "alerts": [Alert],
  "weatherConditions": [WeatherCondition],
  "currentWeatherCondition": CurrentWeatherCondition,
  "tidalConditions": [TidalCondition],
  "currentTidalCondition": TidalCondition
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Community

Description

A community brings together user·s and beach·es from the same region

Fields
Field Name Description
_id - ID! Unique id of community
name - String! The name of the community
address - String! The address of the community (number and street)
location - Location! A geojson point representation of the community
port - String The port related to the community
alerts - [Alert!]! The alert·s related to the community
beaches - [Beach!]! The beach·es related to the community
tidalConditions - [TidalCondition!]! The tidal condition related to the community
Example
{
  "_id": 4,
  "name": "abc123",
  "address": "xyz789",
  "location": Location,
  "port": "xyz789",
  "alerts": [Alert],
  "beaches": [Beach],
  "tidalConditions": [TidalCondition]
}
Types

CurrentWeatherCondition

Description

This is a weather condition representation for current hour

Fields
Field Name Description
temperature - Temperature! The current temperature
wind - Wind! The current wind
Example
{
  "temperature": Temperature,
  "wind": Wind
}
Types

DateTime

Description

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

Example
"2007-12-03T10:15:30Z"
Types

FindAlertInput

Description

Find alert by unique id, beach, user or community

Fields
Input Field Description
_id - String

The unique id of the alert
beach - String

The unique id of a beach related to an alert
user - String

The unique id of a user related to an alert
community - String

The unique id of a community related to an alert
Example
{
  "_id": "abc123",
  "beach": "abc123",
  "user": "xyz789",
  "community": "xyz789"
}
Types

FindBeachInput

Description

Find a beach by unique id, postal code or insee code

Fields
Input Field Description
_id - String

The unique id of a beach
postalCode - Int

The postal code of a beach
inseeCode - Int

The insee code of a beach
since - Float

Since a certain number of days
Example
{
  "_id": "xyz789",
  "postalCode": 123,
  "inseeCode": 123,
  "since": 123.45
}
Types

FindCommunityInput

Description

Find community by unique id

Fields
Input Field Description
_id - String!

The unique id of a community
Example
{"_id": "xyz789"}
Types

FindTidalConditionalInput

Description

Find tidal condition by community

Fields
Input Field Description
community - String!

The unique id of community related to tidal condition
Example
{"community": "xyz789"}
Types

FindWeatherConditionInput

Description

Find weather condition by unique id or beach

Fields
Input Field Description
_id - String

The unique id of a weather condition
beach - String

The unique id of a beach related to a weather condition
Example
{
  "_id": "xyz789",
  "beach": "xyz789"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
123.45
Types

HourPeriod

Description

A representation of hours interval, end time should be greater than start time

Fields
Field Name Description
start_time - String! The beginning of the interval on HH:MM format
end_time - String! The ending of the interval on HH:MM format
Example
{
  "start_time": "abc123",
  "end_time": "xyz789"
}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"4"
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

Location

Description

This is a geojson representation location of a Point

Fields
Field Name Description
type - String! The geojson type
coordinates - [Float!]! The coordinates of geojson point [longitude follow by latitude]
Example
{"type": "xyz789", "coordinates": [987.65]}
Types

MonitoringPeriod

Description

A representation of dates interval with one or multiple HourPeriod, end date should be greater than start date

Fields
Field Name Description
start_date - String! The beginning of the interval as timestamp and rendered as datetime string by Middleware
end_date - String! The ending of the interval as timestamp and rendered as datetime string by Middleware
hours - [HourPeriod!]! A representation of hours interval
Example
{
  "start_date": "xyz789",
  "end_date": "xyz789",
  "hours": [HourPeriod]
}
Types

PartTide

Description

This is a representation of a tidal condition

Fields
Field Name Description
hour - String The hour of tidal as timestamp and rendered as datetime string by Middleware
coefficient - Float The coefficient of tidal
Example
{"hour": "abc123", "coefficient": 987.65}
Types

PointOfInterest

Description

A representation of a point of interest for a beach

Fields
Field Name Description
picture - String! The picture of the point of interest
category - String! The category of the point of interest
title - String! The title of the point of interest
link - String! The link of the point of interest
Example
{
  "picture": "abc123",
  "category": "xyz789",
  "title": "xyz789",
  "link": "xyz789"
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

Temperature

Description

The representation of the temperature measurement for a given date

Fields
Field Name Description
description - String! The detail of temperature measurement
value - Float! The value of temperature measurement, in degree celsius
datetime - String! The date and hours of the temperature measurement as timestamp and rendered as datetime string by Middleware
icon - String! The icon corresponding to the temperature measurement
Example
{
  "description": "abc123",
  "value": 123.45,
  "datetime": "abc123",
  "icon": "abc123"
}
Types

TidalCondition

Description

This is the representation of a tidal condition

Fields
Field Name Description
_id - String! The unique id of tidal condition
datetime - String! The date and hours of the tidal condition as timestamp and rendered as datetime string by Middleware
low_tide - Tide! The low tide for the current tidal condition
high_sea - Tide! The high tide for the current tidal condition
community - String! The community related to current tidal condition
Example
{
  "_id": "xyz789",
  "datetime": "abc123",
  "low_tide": Tide,
  "high_sea": Tide,
  "community": "abc123"
}
Types

Tide

Description

This is the tidal condition for morning and evening

Fields
Field Name Description
morning - PartTide This is the tidal condition on morning
evening - PartTide This is the tidal condition on evening
Example
{
  "morning": PartTide,
  "evening": PartTide
}
Types

WeatherCondition

Description

This is the representation of a weather condition

Fields
Field Name Description
_id - String! The unique identifier of weather condition
temperature - [Temperature!]! All temperature measurements over a period
wind - [Wind!]! All wind measurements over a period
datetime - String! The date and hours of the weather condition as timestamp and rendered as datetime string by Middleware
beach - Beach! The beach related to the weather condition
Example
{
  "_id": "xyz789",
  "temperature": [Temperature],
  "wind": [Wind],
  "datetime": "xyz789",
  "beach": Beach
}
Types

Wind

Description

The representation of the wind measurement for a given date

Fields
Field Name Description
value - Float! The value of temperature measurement, in kilometer per hour
datetime - String! The date and hours of the temperature measurement as timestamp and rendered as datetime string by Middleware
Example
{"value": 987.65, "datetime": "abc123"}