Location Management

Create-Location

This API is used to create a physical location of a user or an organization, depending upon the usecase

• The endpoint for Create location is /data/v1/location/create
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.open-sunbird.org/api/data/v1/location/create

Header parameters

Body

application/json

The body refers to the format of the request.

• It represents the set of parameters to be passed for creating a location

request*LocationCreateRequest

Response

200400500

SUCCESS. The Create location operation was successful!

Headers

Body

application/json

id*string

ver*string

ts*string

params*LocationParams

responseCode*string

result*Result

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/location/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "code": "APCODE",
        "name": "APSTATE1",
        "type": "state"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.location.create",
  "ver": "v1",
  "ts": "2020-11-20 07:09:36:098+0000",
  "params": {
    "resmsgid": null,
    "msgid": "f794b084-d4e9-4ce3-9795-82c88ada6b66",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS",
    "id": "6824e3d3-5512-4344-a481-7bac011edaa8"
  }
}

Search-Location

This API is associated with fetching the location data based on the criterias specified in the request body.

• The endpoint for Search location is /data/v1/location/search
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

POSThttps://staging.open-sunbird.org/api/data/v1/location/search

Header parameters

Body

application/json

The body refers to the format of the request.

• The body contains metadata about the location to be searched

request*LocationSearchRequest

Response

200400500

SUCCESS. The Search location operation was successful!

Headers

Body

application/json

id*string

ver*string

ts*string

params*LocationParams

responseCode*string

result*SearchResult

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/location/search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "filters": {
          "code": "APCODE1"
        }
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.location.search",
  "ver": "v1",
  "ts": "2020-11-20 07:20:43:770+0000",
  "params": {
    "resmsgid": null,
    "msgid": "2d12c998-96c4-43d6-8937-4ebbb8b68d02",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": [
      {
        "identifier": "6824e3d3-5512-4344-a481-7bac011edaa8",
        "code": "APCODE",
        "name": "APSTATE",
        "id": "6824e3d3-5512-4344-a481-7bac011edaa8",
        "type": "state"
      }
    ],
    "count": 1
  }
}

Update-Location

This API is associated with updating the location data based on the location id,

• The endpoint for Update location is /data/v1/location/update
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

PATCHhttps://staging.open-sunbird.org/api/data/v1/location/update

Header parameters

Body

application/json

The body refers to the format of the request.

• It represents the set of parameters to be passed for updating a location

request*LocationUpdateRequest

Response

200400500

SUCCESS. The Update location operation was successful!

Headers

Body

application/json

id*string

ver*string

ts*string

params*LocationParams

responseCode*string

result*LocationResult

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/location/update', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "request": {
        "name": "APSTATE1",
        "id": "e4e60956-277c-439e-bbf7-5c99730341f3"
      }
    }),
});
const data = await response.json();

Response

{
  "id": "api.location.update",
  "ver": "v1",
  "ts": "2020-11-20 12:58:11:871+0000",
  "params": {
    "resmsgid": null,
    "msgid": "9e447000-03f7-43ee-9e3e-342c4a6d5acf",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}

Delete-Location

This API is associated with deleting the location data based on the location id.

• The endpoint for Search location is /data/v1/location/delete
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

DELETEhttps://staging.open-sunbird.org/api/data/v1/location/delete/{locationId}

Path parameters

locationId*string

Location id of location

Header parameters

Response

200400500

SUCCESS. The Delete location operation was successful!

Headers

Body

application/json

id*string

ver*string

ts*string

params*LocationParams

responseCode*string

result*LocationResult

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/location/delete/{locationId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "api.location.delete",
  "ver": "v1",
  "ts": "2020-11-20 13:17:44:741+0000",
  "params": {
    "resmsgid": null,
    "msgid": "c549ef41-faa8-4db2-9136-3490a6ee2607",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "response": "SUCCESS"
  }
}