Get started
  • English
  • 简体中文
Official Site
Get started
  • English
  • 简体中文
Official Site
  • Get started
  • Concepts
  • Guides
  • Device capabilities & events
  • API reference
    • Public conventions
    • Development specification
    • accessToken: Get administrator token
    • API request example
    • Return codes
    • Interface call limits
    • Account docking
    • Device APIs
      • bindDevice: Bind Device
      • unBindDevice: Unbind Device
      • Batch detail by device ID
      • Paged device detail
      • Query online status
      • Pre-bind information
      • Bind state
      • subAccountDeviceInfo
      • subAccountDeviceList
      • setDeviceSnap: Device snapshot
      • setDeviceSnapEnhanced: Device snapshot
      • timeZoneConfigByDay: Set Device Time Zone Daylight Saving Time (by time)
      • timeZoneConfigByWeek: Setting device time zone daylight saving time (per week)
      • timeZoneQueryByDay: Query device time zone daylight saving time (by date)
      • timeZoneQueryByWeek: Obtain device time zone daylight saving time (by week)
    • Device live broadcast
    • Push configuration
    • Cloud storage service
    • Resource pool quota
    • Legacy APIs (deprecated)
  • SDK and tools
  • Solutions
  • Platform and support
On this page
Function details
Request address
Request format
Input parameter note
Return data field description
Error codes
Related

timeZoneQueryByWeek (timeZoneQueryByWeek: Obtain device time zone daylight saving time (by week))

timeZoneQueryByWeek: timeZoneQueryByWeek: Obtain device time zone daylight saving time (by week)

Previous: timeZoneQueryByDay · Time zone and DST.

Function details

Obtain device time zone daylight saving time (by week).

Request address

https://openapi-[DataCenter].easy4ip.com/openapi/timeZoneQueryByWeek

Request format

HTTP POST. JSON body layout: Request conventions. Sign with Signature.

Input parameter note

Parameter ListNoteParameter TypeMandatoryDefault ValidityLegal value
tokenaccessToken or userTokenStringY
deviceIdDevice IDStringY

Sample input

{
 "id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
 "system":{
 "ver":"1.0",
 "appId":"lcdxxxxxxxxx",
 "sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
 "time":1599031074,
 "nonce":"8ec8a7bd1d1c95420de20d92422d457d"
 },
 "params": {
 "token":"At_12345678901234567890123456789012",
 "deviceId":"TESTQWERXXXX-dfXX-XX"
 }
}

Return data field description

Field nameField typeField description
areaIndexStringTime zone area index (may be omitted)
timeZoneStringDevice time zone; if omitted, the device's current configuration applies
beginSunTimeStringDaylight saving start time as month-day-weekday hour:minute:second; empty means DST disabled
endSunTimeStringDaylight saving end time, same format as beginSunTime; empty means DST disabled

Sample output

{

"id":"123456",

"result":{

 "data":{
 "areaIndex":"1",
 "timeZone":"8",
 "beginSunTime":"3-1-1 18:59:20",
 "endSunTime":"3-1-1 18:59:20"
 },

 "code":"0",

 "msg":"Operation is successful."

}

}

Return result

Error codeDescription
0Operation is successful.
SN1001Abnormal signature
SN1002Signature timeout
SN1003Signature parameter error
OP1002Parameter missing, please confirm parameter
OP1003Invalid parameter (incorrect or null), please modify parameter
OP1007Invalid method call
OP1009No right, cannot operate
OP1010Application is frozen
OP1011Today's call interface reach limit
TK1002Token expired or does not exist, please get token again
TK1003Invalid token, please upload correct token
DV1007Device offline

Error codes

This method may return the codes below. See Return codes and Capability errors for the full catalog.

Gateway and auth (SN / TK / OP)

CodeMeaningNext step
SN1001Signature errorCheck sign per Development specification
TK1002Token invalid or expiredRefresh accessToken
OP1002Missing required parameterAdd required fields
OP1003Invalid parameterMatch this page’s parameter table
OP1009Permission deniedCheck token and device bind/share grants
OP1013Total call limit exceededReduce call rate
OP1014Daily per-interface limit exceededSee Interface call limits
DV1007Device offlineWait until the device is online

See Return codes · OP/SN/TK for the full catalog.

Sub-accounts (SUB)

CodeMeaningNext step
SUB1001–SUB1002Sub-account lacks API permissionUpdate policy via addPolicy
SUB1005Sub-account token expiredRefresh subAccountToken
SUB1006No device grant for sub-accountCheck Resource and device serial
SUB1008Sub-account not bound to appCreate and bind the sub-account first

See Return codes · SUB.

Device access and channels (DV10xx)

CodeMeaningNext step
DV1007Device offline or timeoutWait for the device to come online
DV1009Device busyRetry later
DV1012Insufficient share/grant permissionCheck sub-account Permission / Resource
DV1019Capability not supportedConfirm model and capability list
DV1020Channel offlineCheck channel status
DV1026Function not supportedUse another API or upgrade firmware
DV1028Not bound or channel missingVerify deviceId / channelId

See Return codes · DV.

Related

  • Development specification
  • API conventions
  • Module index
timeZoneQueryByDay: Query device time zone daylight saving time (by date)
batchModifyLivePlan