Create a Geozone

post https://qa.connect.calamp.com/connect/services/geozones

Create a Geozone

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

groups

array of objects

Links to Groups to which the resource belongs.

groups

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

address

object

Represents an Address in the system

country

string

Name of the country. Max length = 64 characters

block

string

subdistrict

string

subblock

string

houseNumber

string

street2

string

The street2 address. Max length = 128 characters

city

string

required

Required along with StateProvinceCd if a Zip is not provided. Max length = 64 characters

stateProvince

string

Name of the state/province. Max length = 64 characters

countryCd

string

The international country code. If not specified, default 'US' is used. Max length = 3 characters

zip

string

required

Either this field or the City+State fields should be provided for a valid address. Max length = 10 characters

street

string

The street address, including house number. Max length = 128 characters

district

string

stateProvinceCd

string

Required along with City if a Zip is not provided. Max Length = 8 characters.

addressType

string

required

BILLING MAILING SHIPPING

name

string

required

The name of the device. Max length = 32 characters

int64

Required for PUT requests with resource object in the request body. Forbidden for POST requests with resource object in the request body. Will result in an HTTP 400 - Bad Request response.

type

string

GeoZoneType. Default's to 'GEOZONE'. Maxlength:32 characters

GEOZONE LANDMARK

category

string

The category of the device. Max length:32 characters

active

boolean

For zone of type "GEOZONE" this value is really read only , and such a zone becomes active once it is deployed to a device.

description

string

The description of the device. Max length:255 characters

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

inheritable

boolean

required

Defaults to false.

true

geoLocation

object

required

GeoLocation information

shape

string

required

Maxlength:32 characters

CIRCLE RECTANGLE POLYGON MULTIPOLYGON

coordinates

string

required

Coordinates of the location

circleRadius

double

required

Circle radius of the Geozone.Required if the shape is 'CIRCLE'

hysteresis

int32

geozoneDeployments

array of objects

The set of Geozone deployment information, each includes the link to a device that the geozone is deployed to, and the report type for geozone entry/exit event. Read-only.

geozoneDeployments

object

device

object

required

Represents a resource in the system

reportType

string

Report type of the device by geozone. MaxLength:16 characters

ENTRY EXIT ENTRY_EXIT

deploymentStatus

string

Deployment status of the device. MaxLength:16 characters

PENDING COMPLETED FAILED CANCELLED

pegzoneIndex

int32

Pegzone index of the device

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

status

string

Status of the Geozone. Default value is 'Enabled'. Maxlength:16 characters

Enabled Disabled Suspended Deleted Pending_Delete

400

Invalid request.

405

Geozone can only be created via the entity URI that the preferences are for.

500

Server error

Language

Credentials


xxxxxxxxxx
18
1
curl --request POST \
2
     --url https://qa.connect.calamp.com/connect/services/geozones \
3
     --header 'accept: */*' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "geozone": {
8
    "address": {
9
      "addressType": "BILLING"
10
    },
11
    "inheritable": true,
12
    "geoLocation": {
13
      "shape": "CIRCLE"
14
    },
15
    "version": 0
16
  }
17
}
18
'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200successful operation