Cleverciti RestAPI Version 2.0

<back to all web services

LimitedGapEdit

The following routes are available for this service:
PATCH/ccs/city/view/limited/gap/edit
LimitedGapEdit Parameters:
NameParameterData TypeRequiredDescription
idqueryGuidYesUnique View ID
useridquerystringYesUserID that access the Service
GapIdqueryGuidYesUnique Gap ID
NamequerystringYesName of the Gap
CommentquerystringYesComment of the Gap
axquerydoubleYesLongitude x1
ayquerydoubleYesLatitude y1
bxquerydoubleYesLongitude x2
byquerydoubleYesLatitude y2
cxquerydoubleYesLongitude x3
cyquerydoubleYesLatitude y3
dxquerydoubleYesLongitude x4
dyquerydoubleYesLatitude y4
intervallqueryList<NotificationLength>Yesmax stay duration in Minutes
framesqueryList<ccsFrameReference>Yeslist of cleverciti sensor frames
rawDataRefquerystringYesComma seperated list of references to the RawData Object
AltitudeRefquerystringYesAltitude Reference
AltitudequerydoubleNoAltitude
NotificationLength Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
fromformintNo
toformintNo
rgbformstringNo
emailNotificationformList<string>No
_idformObjectIdNo
ccsFrameReference Parameters:
NameParameterData TypeRequiredDescription
SensorNameformstringNo
SensorIPformstringNo
TerminatorHostformstringNo
FrameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /ccs/city/view/limited/gap/edit HTTP/1.1 
Host: 188.138.100.94 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":"00000000000000000000000000000000","userid":"String","GapId":"00000000000000000000000000000000","Name":"String","Comment":"String","ax":0,"ay":0,"bx":0,"by":0,"cx":0,"cy":0,"dx":0,"dy":0,"intervall":[{}],"frames":[{"SensorName":"String","SensorIP":"String","TerminatorHost":"String","Frame":"String"}],"rawDataRef":"String","AltitudeRef":"String","Altitude":0}