Create a new location

1min

POST
Asynchronous API for creating a new Location:
ParameterDescriptionTypeValidation
tags
address*Address type data type which consists below fields.
ㅤ↳buildingNumberHouse number of the address.stringmaxLength: 16
ㅤ↳addressLine1*The street information of the address.stringminLength: 1 maxLength: 128
ㅤ↳addressLine2An optional additional field for the street address.stringmaxLength: 128
ㅤ↳addressLine3Another optional additional field for the street address of the billing address.stringmaxLength: 128
ㅤ↳apartmentNumberThe Apartment Number of the address.string
ㅤ↳floorThe Floor Number of the addressstring
ㅤ↳city*The city, town, or village of the address.stringpattern: It should match a through z or A through Z, inclusive (range)Also, length must be between 2 to 64.
ㅤ↳stateState of the address.stringpattern: It should match a through z or A through Z, inclusive (range)Also, max length allowed is 64 characters.
ㅤ↳countydistrict or county of the address.stringpattern: It should match a through z or A through Z, inclusive (range)Also, max length allowed is 64 characters.
ㅤ↳zipCodePostal/zip code of the address.stringmaxLength: 10pattern: It should be alphanumeric.
ㅤ↳country*Country consists code and name.
ㅤㅤㅤ↳code*The two-letter code for the country of the address.stringpattern: It should match A through Z, inclusive (range)Also, it must be at least 2 but not more than 3 times.
ㅤㅤㅤ↳name*The name of the country of the address.stringpattern: It should match a through z or A through Z, inclusive (range)Also, it must be at least 2 but not more than 64 times.
geolocationExample: OrderedMap { "latitude": "30.3752° N","longitude": "76.7821° E" }
ㅤ↳long*Range of longitude is -180 to 180.stringExample: 76.7821° E
ㅤ↳lat*Range of latitude is -90 to 90.stringExample: 30.3752° N
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedUser is not authenticated.
403 - ForbiddenUser is not allowed to perform operation.
503 - Service unavailableSome unexpected error occurred.
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-USERINFO
string
X-COREOS-ACCESS
string
*
Body Parameters
body
LocationRequest
*
Description
Create a location
tags
object
address
Address
*
geolocation
GeoCode
Responses
201
OK
SuccessResponse
All Of
object  +
request
Request
data
object
400
Error Occurred
PostErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
401
Error Occurred
PostErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
403
Error Occurred
PostErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
503
Error Occurred
PostErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/locations/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "address": {
    "addressLine1": "",
    "city": "",
    "country": {
      "code": "",
      "name": ""
    }
  },
  "geolocation": {
    "long": "",
    "lat": ""
  }
}'
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/locations/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "address": {
    "addressLine1": "",
    "city": "",
    "country": {
      "code": "",
      "name": ""
    }
  },
  "geolocation": {
    "long": "",
    "lat": ""
  }
}'
Responses
201
400
401
403
503
// OK 
{
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿

Parameter	Description	Type	Validation
`tags`
`address`*	Address type data type which consists below fields.
ㅤ↳`buildingNumber`	House number of the address.	string	maxLength: 16
ㅤ↳`addressLine1`*	The street information of the address.	string	minLength: 1 maxLength: 128
ㅤ↳`addressLine2`	An optional additional field for the street address.	string	maxLength: 128
ㅤ↳`addressLine3`	Another optional additional field for the street address of the billing address.	string	maxLength: 128
ㅤ↳`apartmentNumber`	The Apartment Number of the address.	string
ㅤ↳`floor`	The Floor Number of the address	string
ㅤ↳`city`*	The city, town, or village of the address.	string	pattern: It should match a through z or A through Z, inclusive (range)Also, length must be between 2 to 64.
ㅤ↳`state`	State of the address.	string	pattern: It should match a through z or A through Z, inclusive (range)Also, max length allowed is 64 characters.
ㅤ↳`county`	district or county of the address.	string	pattern: It should match a through z or A through Z, inclusive (range)Also, max length allowed is 64 characters.
ㅤ↳`zipCode`	Postal/zip code of the address.	string	maxLength: 10pattern: It should be alphanumeric.
ㅤ↳`country`*	Country consists code and name.
ㅤㅤㅤ↳`code`*	The two-letter code for the country of the address.	string	pattern: It should match A through Z, inclusive (range)Also, it must be at least 2 but not more than 3 times.
ㅤㅤㅤ↳`name`*	The name of the country of the address.	string	pattern: It should match a through z or A through Z, inclusive (range)Also, it must be at least 2 but not more than 64 times.
`geolocation`			Example: OrderedMap { "latitude": "30.3752° N","longitude": "76.7821° E" }
ㅤ↳`long`*	Range of longitude is -180 to 180.	string	Example: 76.7821° E
ㅤ↳`lat`*	Range of latitude is -90 to 90.	string	Example: 30.3752° N
*This is required.

HTTP Status Code Summary

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	User is not authenticated.
403 - Forbidden	User is not allowed to perform operation.
503 - Service unavailable	Some unexpected error occurred.

Updated 27 Sep 2023

Did this page help you?

Onboard a tenant

update an existing location