Business Service Zones

Get available service zones

get

https://test.swooveapi.comhttps://live.swooveapi.com

/service-zone/

Query parameters

app_keystringRequired

Responses

200

Service Zones Found

application/json

400

Validation Error

application/json

get

/service-zone/

HTTPcURLJavaScriptPython

GET /service-zone/?app_key=text HTTP/1.1
Host: test.swooveapi.com
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Service Zones",
  "responses": [
    {
      "_id": "text",
      "properties": {
        "country_code": "GH",
        "country": "GHANA",
        "city_code": "OUT-ACCRA",
        "city_name": "OUTSIDE ACCRA",
        "layer": 2,
        "stroke": "#ff0000",
        "stroke-width": 2,
        "stroke-opacity": 1,
        "fill": "#f00a0a",
        "fill-opacity": 1
      },
      "geometry": {
        "coordinates": [
          [
            1
          ]
        ],
        "type": "Polygon"
      }
    }
  ]
}

Check if a latitude and a longitude is in our service zone

post

https://test.swooveapi.comhttps://live.swooveapi.com

/service-zone/check-zone/

We allow requests from

• Layer 3 to Layer 3

• Layer 2 to Layer 3

• Layer 3 to Layer 2

Query parameters

app_keystringRequired

Body

applicaltion/json

longitudenumberRequiredDefault: 0

latitudenumberRequiredDefault: 0

Responses

200

Service Zones Found

application/json

400

Validation Error

application/json

post

/service-zone/check-zone/

HTTPcURLJavaScriptPython

POST /service-zone/check-zone/?app_key=text HTTP/1.1
Host: test.swooveapi.com
Content-Type: applicaltion/json
Accept: */*
Content-Length: 28

{
  "longitude": 0,
  "latitude": 0
}

{
  "success": true,
  "code": 200,
  "message": "Service Zones",
  "responses": {
    "_id": "text",
    "properties": {
      "country_code": "GH",
      "country": "GHANA",
      "city_code": "OUT-ACCRA",
      "city_name": "OUTSIDE ACCRA",
      "layer": 2,
      "stroke": "#ff0000",
      "stroke-width": 2,
      "stroke-opacity": 1,
      "fill": "#f00a0a",
      "fill-opacity": 1
    },
    "geometry": {
      "coordinates": [
        [
          1
        ]
      ],
      "type": "Polygon"
    }
  }
}