Location Management

Create-Location

post

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.
Header parameters
AuthorizationstringRequired

To make use of any Location API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Example: {{authorization}}
Body
Responses
200

SUCCESS. The Create location operation was successful!

application/json
post
/data/v1/location/create

Search-Location

post

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.
Header parameters
AuthorizationstringRequired

To make use of any Location API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Example: {{authorization}}
Body
Responses
200

SUCCESS. The Search location operation was successful!

application/json
post
/data/v1/location/search

Update-Location

patch

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.
Header parameters
AuthorizationstringRequired

To make use of any Location API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Example: {{authorization}}
Body
Responses
200

SUCCESS. The Update location operation was successful!

application/json
patch
/data/v1/location/update

Delete-Location

delete

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.
Path parameters
locationIdstringRequired

Location id of location

Header parameters
AuthorizationstringRequired

To make use of any Location API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

Example: {{authorization}}
Responses
200

SUCCESS. The Delete location operation was successful!

application/json
delete
/data/v1/location/delete/{locationId}

Last updated

Was this helpful?