Report Device Access Code Constraints

Report access code-related constraints for a device.

POST /access_codes/report_device_constraints ⇒ void

Enables you to report access code-related constraints for a device.

Currently, this endpoint supports reporting supported code length constraints for SmartThings devices. Specify either supported_code_lengths or min_code_length/max_code_length.

Report Supported Code Lengths

Python

Request:

seam.access_codes.report_device_constraints(
  device_id = "11111111-1111-1111-1111-444444444444",
  supported_code_lengths = [4, 5, 6]
)

Response:

None

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/access_codes/report_device_constraints' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "device_id": "11111111-1111-1111-1111-444444444444",
    "supported_code_lengths": [4, 5, 6]
}'

Response:

{
  "ok": true
}

JavaScript

Request:

await seam.accessCodes.reportDeviceConstraints({
  device_id: "11111111-1111-1111-1111-444444444444",
  supported_code_lengths: [4, 5, 6]
});

Response:

void

Ruby

Request:

client.access_codes.report_device_constraints(
  device_id: "11111111-1111-1111-1111-444444444444",
  supported_code_lengths: [4, 5, 6]
)

Response:

void

PHP

Request:

$seam->access_codes->report_device_constraints(
  device_id: "11111111-1111-1111-1111-444444444444",
  supported_code_lengths: [4, 5, 6]
);

Response:

void

C#

Request:

List<int> codeLengths = new() { 4, 5, 6 };

seam.AccessCodes.reportDeviceConstraints(
  deviceId: "11111111-1111-1111-1111-444444444444",
  supportedCodeLengths: codeLengths
);

Response:

void

Java

Request:

seam.accessCodes()
  .reportDeviceConstraints(AccessCodesReportDeviceConstraintsRequest.builder()
    .deviceId("11111111-1111-1111-1111-444444444444")
    .supportedCodeLengths(List.of(4, 5, 6))
    .build());

Response:

void

Go

Request:

codeLengths := []int { 4, 5, 6 }

client.AccessCodes.ReportDeviceConstraints(
  context.Background(),
  &api.AccessCodesReportDeviceConstraintsRequest{
    DeviceId: "11111111-1111-1111-1111-444444444444",
    SupportedCodeLengths: codeLengths,
  },
)

if uErr != nil {
    return uErr
}

return nil

Response:

void

Report Minimum and Maximum Supported Code Lengths

Python

Request:

seam.access_codes.report_device_constraints(
  device_id = "11111111-1111-1111-1111-444444444444",
  min_code_length = 4,
  max_code_length = 6
)

Response:

None

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/access_codes/report_device_constraints' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${SEAM_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "device_id": "11111111-1111-1111-1111-444444444444",
    "min_code_length": 4,
    "max_code_length": 6
}'

Response:

{
  "ok": true
}

JavaScript

Request:

await seam.accessCodes.reportDeviceConstraints({
  device_id: "11111111-1111-1111-1111-444444444444",
  min_code_length: 4,
  max_code_length: 6
});

Response:

void

Ruby

Request:

client.access_codes.report_device_constraints(
  device_id: "11111111-1111-1111-1111-444444444444",
  min_code_length: 4,
  max_code_length: 6
)

Response:

void

PHP

Request:

$seam->access_codes->report_device_constraints(
  device_id: "11111111-1111-1111-1111-444444444444",
  min_code_length: 4,
  max_code_length: 6
);

Response:

void

C#

Request:

seam.AccessCodes.reportDeviceConstraints(
  deviceId: "11111111-1111-1111-1111-444444444444",
  minCodeLength: 4,
  maxCodeLength: 6
);

Response:

void

Java

Request:

seam.accessCodes()
  .reportDeviceConstraints(AccessCodesReportDeviceConstraintsRequest.builder()
    .deviceId("11111111-1111-1111-1111-444444444444")
    .minCodeLength(4)
    .maxCodeLength(6)
    .build());

Response:

void

Go

Request:

client.AccessCodes.ReportDeviceConstraints(
  context.Background(),
  &api.AccessCodesReportDeviceConstraintsRequest{
    DeviceId: "11111111-1111-1111-1111-444444444444",
    MinCodeLength: 4,
    MaxCodeLength: 6
  },
)

if uErr != nil {
    return uErr
}

return nil

Response:

void

Request Parameters

device_id

Type: string Required: Yes

ID of the device for which to report constraints.

---

supported_code_lengths

Type: string Required: No

Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either supported_code_lengths or min_code_length/max_code_length.

---

min_code_length

Type: integer Required: No

Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either min_code_length/max_code_length or supported_code_lengths.

---

max_code_length

Type: integer Required: No

Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either min_code_length/max_code_length or supported_code_lengths.

Return Type

void