Create an address

POST

https://ssuccessv2.com/app/api/v1/address/create

POST

/app/api/v1/address/create

$ curl -X POST https://ssuccessv2.com/app/api/v1/address/create \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "components": [],
>   "formatted": "1200 Main Street, Springfield, NY 10001",
>   "latitude": 40.7128,
>   "longitude": -74.006,
>   "tag": "Home",
>   "students_id": [
>     501
>   ]
> }'

1 {
2   "status": "success",
3   "message": "Saved successfully.",
4   "data": {
5     "id": 8801,
6     "components": [],
7     "splitted": [],
8     "formatted": "1200 Main Street",
9     "longitude": -74.006,
10     "latitude": 40.7128,
11     "custom_longitude": null,
12     "custom_latitude": null,
13     "original_longitude": null,
14     "original_latitude": null,
15     "tag": "Home",
16     "Springfield": null,
17     "NY 10001": null
18   }
19 }

Creates an address in the active school and optionally attaches it to students, parents, relatives, emergency contacts, or staff members.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects an object.

componentslist of anyRequired

Address-provider components.

formattedstringRequired<=255 characters

latitudedoubleRequired-90-90

longitudedoubleRequired-180-180

tagstring or nullOptional<=255 characters

students_idlist of integers or nullOptional

parents_idlist of integers or nullOptional

relatives_idlist of integers or nullOptional

emergency_contacts_idlist of integers or nullOptional

staff_members_idlist of integers or nullOptional

Response

Address created.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

422

Unprocessable Entity Error