My Project

CreateAddress

POST

/api/addresses/create/

Location/Address

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/addresses/create/' \
--form 'point=""' \
--form 'description=""' \
--form 'location_type=""'

Response Example

201 - Example 1

{
    "id": 0,
    "description": "string",
    "location_type": "HOME",
    "point": {
        "type": "Point",
        "coordinates": [
            12.9721,
            77.5933
        ]
    },
    "map_description": "string",
    "map_image": "http://example.com"
}

Request

Body Params multipart/form-data

point

object

Location Point

required

type

enum<string>

optional

Allowed value:

Point

coordinates

array[number <float>]

optional

>= 2 items<= 3 items

Example:

[12.9721,77.5933]

description

string

required

>= 1 characters

map_description

string

optional

Description for the map view

>= 1 characters

location_type

enum<string>

required

HOME - Home

WORK - Work

Allowed values:

HOMEWORK

map_image

file

optional

Image of the location on the map

Responses

🟢201Created

application/json

Body

integer

read-onlyrequired

description

string

required

location_type

enum<string>

required

HOME - Home

WORK - Work

Allowed values:

HOMEWORK

point

object

Location Point

required

type

enum<string>

optional

Allowed value:

Point

coordinates

array[number <float>]

optional

>= 2 items<= 3 items

Example:

[12.9721,77.5933]

map_description

string

optional

Description for the map view

map_image

string <uri> | null

optional

Image of the location on the map

🟠400Bad Request

🟠401Unauthorized

🟠405405

🟠406406

🟠415415

🟠429429

🔴500Server Error

ListAddresses

UpdateAddress