Organization Location

Gets a list of organization locations

get

This endpoint is used to fetch all the organization locations in the current organization

Authorizations

Responses

application/json

object[]Optional

Serializes organization location querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/org/location/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "text",
    "location_id": "text",
    "region": "text",
    "location_name": "text",
    "description": "text",
    "country": "text",
    "state": "text",
    "city": "text",
    "area": "text",
    "subarea": "text",
    "address": "text",
    "city_bb": "text",
    "pincode": "text",
    "landmark": "text",
    "latitude": 1,
    "longitude": 1,
    "district": "text",
    "address_type": "text",
    "is_ci": true,
    "base_radius": 1,
    "is_preconfigured": true
  }
]

Creates a new location

post

This endpoint is used to save a new user for the current organization

Authorizations

Body

Other propertiesanyOptional

Responses

post

HTTPcURLJavaScriptPython

POST /ux/common/org/location/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "location_name": "JP Nagar",
  "country": "India",
  "address": "3rd floor",
  "state": "Karnataka",
  "city": "Bangalore",
  "area": "JP Nagar",
  "subarea": "3rd phase",
  "pincode": "574221",
  "description": "Branch office address"
}

201

No response body

No content

Gets a organization location with the given id

get

This endpoint is used to fetch a organization location details in the current organization

Authorizations

Path parameters

idstringRequired

Responses

application/json

objectOptional

Serializes organization location querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/org/location/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

Edits the organization location with given id

put

This endpoint is used to edit an existing organization location for the current organization

Authorizations

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializes organization location querysets.

idstringRead-onlyRequired

location_idstring · max: 25Required

regionstring · max: 100Optional

location_namestring · max: 256Optional

descriptionstring · max: 1000Optional

countrystring · max: 100Optional

statestring · max: 100Optional

citystring · max: 100Optional

areastring · max: 100Optional

subareastring · max: 100Optional

addressstring · max: 1000Optional

city_bbstring · max: 100Optional

pincodestring · max: 100Optional

landmarkstring · max: 100Optional

latitudenumber · floatOptional

longitudenumber · floatOptional

districtstring · max: 100Optional

address_typestring · max: 255Optional

is_cibooleanOptional

base_radiusnumber · floatOptional

is_preconfiguredbooleanOptional

Responses

application/json

objectOptional

Serializes organization location querysets.

put

HTTPcURLJavaScriptPython

PUT /ux/common/org/location/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 348

{
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

Deletes the organization location with given id

delete

This endpoint is used to delete an existing organization location for the current organization

Authorizations

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /ux/common/org/location/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

204

No response body

No content

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializes organization location querysets.

idstringRead-onlyRequired

location_idstring · max: 25Required

regionstring · max: 100Optional

location_namestring · max: 256Optional

descriptionstring · max: 1000Optional

countrystring · max: 100Optional

statestring · max: 100Optional

citystring · max: 100Optional

areastring · max: 100Optional

subareastring · max: 100Optional

addressstring · max: 1000Optional

city_bbstring · max: 100Optional

pincodestring · max: 100Optional

landmarkstring · max: 100Optional

latitudenumber · floatOptional

longitudenumber · floatOptional

districtstring · max: 100Optional

address_typestring · max: 255Optional

is_cibooleanOptional

base_radiusnumber · floatOptional

is_preconfiguredbooleanOptional

Responses

application/json

objectOptional

Serializes organization location querysets.

post

HTTPcURLJavaScriptPython

POST /ux/common/org/location/create-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 348

{
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializes organization location querysets.

idstringRead-onlyRequired

location_idstring · max: 25Required

regionstring · max: 100Optional

location_namestring · max: 256Optional

descriptionstring · max: 1000Optional

countrystring · max: 100Optional

statestring · max: 100Optional

citystring · max: 100Optional

areastring · max: 100Optional

subareastring · max: 100Optional

addressstring · max: 1000Optional

city_bbstring · max: 100Optional

pincodestring · max: 100Optional

landmarkstring · max: 100Optional

latitudenumber · floatOptional

longitudenumber · floatOptional

districtstring · max: 100Optional

address_typestring · max: 255Optional

is_cibooleanOptional

base_radiusnumber · floatOptional

is_preconfiguredbooleanOptional

Responses

application/json

objectOptional

Serializes organization location querysets.

post

HTTPcURLJavaScriptPython

POST /ux/common/org/location/csv_cols/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 348

{
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializes organization location querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/org/location/download_csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializes organization location querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/org/location/location_details/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

get

API endpoint that allows users to be viewed or edited.

Authorizations

Responses

application/json

objectOptional

Serializes organization location querysets.

get

HTTPcURLJavaScriptPython

GET /ux/common/org/location/team_location/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "text",
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

post

API endpoint that allows users to be viewed or edited.

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Serializes organization location querysets.

idstringRead-onlyRequired

location_idstring · max: 25Required

regionstring · max: 100Optional

location_namestring · max: 256Optional

descriptionstring · max: 1000Optional

countrystring · max: 100Optional

statestring · max: 100Optional

citystring · max: 100Optional

areastring · max: 100Optional

subareastring · max: 100Optional

addressstring · max: 1000Optional

city_bbstring · max: 100Optional

pincodestring · max: 100Optional

landmarkstring · max: 100Optional

latitudenumber · floatOptional

longitudenumber · floatOptional

districtstring · max: 100Optional

address_typestring · max: 255Optional

is_cibooleanOptional

base_radiusnumber · floatOptional

is_preconfiguredbooleanOptional

Responses

application/json

objectOptional

Serializes organization location querysets.

post

HTTPcURLJavaScriptPython

POST /ux/common/org/location/upload-csv/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 348

{
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": "text",
  "location_id": "text",
  "region": "text",
  "location_name": "text",
  "description": "text",
  "country": "text",
  "state": "text",
  "city": "text",
  "area": "text",
  "subarea": "text",
  "address": "text",
  "city_bb": "text",
  "pincode": "text",
  "landmark": "text",
  "latitude": 1,
  "longitude": 1,
  "district": "text",
  "address_type": "text",
  "is_ci": true,
  "base_radius": 1,
  "is_preconfigured": true
}