OnAutomate API V1.1.1
Welcome to onautomate Api docs.
Location
GET /v1/locations/
https://link.amtssl.com/v1/locations/
Get all agency locations.
Authorization:
Provide your location api key (Bearer Token).
AUTHORIZATION
Bearer Token
Token
<token>
Example Request
curl --location --request GET 'https://link.amtssl.com/v1/locations/' \
--header 'Authorization: Bearer <token>'
Example Response
Bad Request. please contact support!
Unauthorized
400 Bad Request
BODY
{
"msg": "Bad Request"
}
401 Unauthorized
BODY
{
"msg": "Unauthorized"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Successful response
200 OK
BODY
Headers
Content-Type: application/json
POST /v1/locations/
https://link.amtssl.com/v1/locations/
Create a Location.
VALIDATIONS:
These field are required to create a location
SNAPSHOTS:
API will allow you to import snapshots on create location. for the importing snapshot below field are required.
{ "snapshot": { "id": "xxx" "type": "vertical" } }
Field Description
1. id: Snapshot id you can find from snapshot api.
2. type: Type also you can find from snapshot api. we allow 3 types:
TWILIO:
API will allow to authenticate your Twilio account with new location. For the authentication Twilio account required below fields.
{ "twilio": { "sid": "xxx" "authToken": "xxx" } }
Field Description
1. sid: Twilio Account SID
2. authToken: Twilio Auth Token
TIMEZONE:
We will allow these option.
Etc/GMT+12,
Pacific/Midway,
Pacific/Honolulu,
America/Juneau,
US/Alaska,
America/Dawson,
America/Los_Angeles,
America/Phoenix,
America/Tijuana,
US/Arizona,
America/Belize,
America/Boise,
America/Chihuahua,
America/Denver,
America/Edmonton,
America/Guatemala,
America/Managua,
America/Regina,
Canada/Saskatchewan,
US/Mountain,
America/Bahia_Banderas,
America/Bogota,
America/Chicago,
America/Mexico_City,
US/Central,
America/Caracas,
America/Detroit,
America/Indiana/Indianapolis,
America/Louisville,
America/Manaus,
America/New_York,
America/Santiago,
America/Santo_Domingo,
America/Toronto,
US/East-Indiana,
US/Eastern,
America/Argentina/Buenos_Aires,
America/Glace_Bay,
America/Montevideo,
America/Sao_Paulo,
Canada/Atlantic,
America/St_Johns,
Canada/Newfoundland,
America/Godthab,
America/Noronha,
Etc/GMT+2,
Atlantic/Cape_Verde,
Atlantic/Azores,
Etc/Greenwich,
GMT,
UTC,
Africa/Algiers,
Africa/Casablanca,
Africa/Lagos,
Atlantic/Canary,
Europe/London,
Africa/Cairo,
Africa/Harare,
Europe/Amsterdam,
Europe/Belgrade,
Europe/Brussels,
Europe/Madrid,
Europe/Oslo,
Europe/Sarajevo,
Africa/Nairobi,
Asia/Amman,
Asia/Baghdad,
Asia/Jerusalem,
Asia/Kuwait,
Asia/Qatar,
Europe/Athens,
Europe/Bucharest,
Europe/Helsinki,
Europe/Moscow,
Asia/Baku,
Asia/Dubai,
Asia/Kabul,
Asia/Tehran,
Asia/Karachi,
Asia/Yekaterinburg,
Asia/Colombo,
Asia/Kolkata,
Asia/Kathmandu,
Asia/Almaty,
Asia/Dhaka,
Asia/Rangoon,
Asia/Bangkok,
Asia/Krasnoyarsk,
Asia/Irkutsk,
Asia/Kuala_Lumpur,
Asia/Shanghai,
Asia/Taipei,
Australia/Perth,
Asia/Seoul,
Asia/Tokyo,
Asia/Yakutsk,
Australia/Adelaide,
Australia/Darwin,
Asia/Vladivostok,
Australia/Brisbane,
Australia/Canberra,
Australia/Hobart,
Australia/Sydney,
Pacific/Guam,
Asia/Magadan,
Pacific/Auckland,
Pacific/Fiji,
Pacific/Tongatapu
Authorization:
Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys
AUTHORIZATION
Bearer Token
Token
<token>
HEADERS
Content-Type
application/json
BODY raw
Example Request
Example Response
Bad Request. please contact support!
Unauthorized
400 Bad Request
Body
{
"msg": "Bad Request"
}
401 Unauthorized
Body
{
"msg": "Unauthorized"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Successful Response
200 OK
BODY
Headers
Content-Type: application/json
Unprocessable Entity
422 Unprocessable Entity (WebDAV) (RFC 4918)
Headers
Content-Type: application/json
GET /v1/locations/:locationId
https://link.amtssl.com/v1/locations/:locationId
Get location by location id.
Authorization:
Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys
AUTHORIZATION
Bearer Token
Token
<token>
PATH VARIABLES
customValueId
i2SpAtBVHSVea1sL6oah
(Required) Location Id
Example Request
curl --location --request GET 'https://link.amtssl.com/v1/locations/:locationId' \
--header 'Authorization: Bearer <token>'
Example Response
Bad Request. please contact support!
Unauthorized
400 Bad Request
BODY
{
"msg": "Bad Request"
}
401 Unauthorized
BODY
{
"msg": "Unauthorized"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Successful Response
200 OK
BODY
Headers
Content-Type: application/json
PUT /v1/locations/:locationId
https://link.amtssl.com/v1/locations/:locationId
Update a Location.
VALIDATIONS:
These field are required to update a location
TIMEZONE:
We will allow these option.
Etc/GMT+12,
Pacific/Midway,
Pacific/Honolulu,
America/Juneau,
US/Alaska,
America/Dawson,
America/Los_Angeles,
America/Phoenix,
America/Tijuana,
US/Arizona,
America/Belize,
America/Boise,
America/Chihuahua,
America/Denver,
America/Edmonton,
America/Guatemala,
America/Managua,
America/Regina,
Canada/Saskatchewan,
US/Mountain,
America/Bahia_Banderas,
America/Bogota,
America/Chicago,
America/Mexico_City,
US/Central,
America/Caracas,
America/Detroit,
America/Indiana/Indianapolis,
America/Louisville,
America/Manaus,
America/New_York,
America/Santiago,
America/Santo_Domingo,
America/Toronto,
US/East-Indiana,
US/Eastern,
America/Argentina/Buenos_Aires,
America/Glace_Bay,
America/Montevideo,
America/Sao_Paulo,
Canada/Atlantic,
America/St_Johns,
Canada/Newfoundland,
America/Godthab,
America/Noronha,
Etc/GMT+2,
Atlantic/Cape_Verde,
Atlantic/Azores,
Etc/Greenwich,
GMT,
UTC,
Africa/Algiers,
Africa/Casablanca,
Africa/Lagos,
Atlantic/Canary,
Europe/London,
Africa/Cairo,
Africa/Harare,
Europe/Amsterdam,
Europe/Belgrade,
Europe/Brussels,
Europe/Madrid,
Europe/Oslo,
Europe/Sarajevo,
Africa/Nairobi,
Asia/Amman,
Asia/Baghdad,
Asia/Jerusalem,
Asia/Kuwait,
Asia/Qatar,
Europe/Athens,
Europe/Bucharest,
Europe/Helsinki,
Europe/Moscow,
Asia/Baku,
Asia/Dubai,
Asia/Kabul,
Asia/Tehran,
Asia/Karachi,
Asia/Yekaterinburg,
Asia/Colombo,
Asia/Kolkata,
Asia/Kathmandu,
Asia/Almaty,
Asia/Dhaka,
Asia/Rangoon,
Asia/Bangkok,
Asia/Krasnoyarsk,
Asia/Irkutsk,
Asia/Kuala_Lumpur,
Asia/Shanghai,
Asia/Taipei,
Australia/Perth,
Asia/Seoul,
Asia/Tokyo,
Asia/Yakutsk,
Australia/Adelaide,
Australia/Darwin,
Asia/Vladivostok,
Australia/Brisbane,
Australia/Canberra,
Australia/Hobart,
Australia/Sydney,
Pacific/Guam,
Asia/Magadan,
Pacific/Auckland,
Pacific/Fiji,
Pacific/Tongatapu
Authorization:
Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys
AUTHORIZATION
Bearer Token
Token
<token>
HEADERS
Content-Type
application/json
PATH VARIABLES
locationId
i2SpAtBVHSVea1sL6oah
(Required) Location Id
BODY raw
Example Request
Example Response
Bad Request. please contact support!
Unauthorized
400 Bad Request
Body
{
"msg": "Bad Request"
}
401 Unauthorized
Body
{
"msg": "Unauthorized"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Successful Response
200 OK
BODY
Headers
Content-Type: application/json
Unprocessable Entity
422 Unprocessable Entity (WebDAV) (RFC 4918)
BODY
Headers
Content-Type: application/json
PUT /v1/custom-values/:customValueId
https://link.amtssl.com/v1/locations/:locationId/load-snapshot/:snapshotId
Load Snapshot.
FIELDS
1. override*: We will allow true or false. If you want override all conflict assets then pass true. By default it false. By default it false
AUTHORIZATION:
Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys
AUTHORIZATION
Bearer Token
Token
<token>
HEADERS
Content-Type
application/json
PATH VARIABLES
locationId
i2SpAtBVHSVea1sL6oah
(Required) Location Id
snapshotId
5bFKHqudfotv3c1xFUuP
(Required) Snapshot Id
BODY raw
{
"override": false
}
Example Request
curl --location --request PUT 'https://link.amtssl.com/v1/locations/:locationId/load-snapshot/:snapshotId' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"override": false
}'
Example Response
Successful response
Bad Request. please contact support!
Unauthorized
200 OK
BODY
{
"msg": "Copying the data, we will send a notification once it's completed."
}
200 OK
BODY
{
"msg": "Copying the data, we will send a notification once it's completed."
}
200 OK
BODY
{
"msg": "Copying the data, we will send a notification once it's completed."
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Unprocessable Entity
422 Unprocessable Entity (WebDAV) (RFC 4918)
BODY
Headers
Content-Type: application/json