get_token_by_serial

Данный метод предназначен для получения информации об СКО по серийному номеру.

Необходимость во входных данных отсутствует, однако серийный номер требуется к передаче в заголовке token.

Так же, опционально может быть передан заголовок tokens.refresh со следующими значениями:

• "true" - будет совершено обновление сканирование USB-устройств
• "false" (по умолчанию) - сканирование USB-устройств совершено не будет
• В случае, если передано иное значение, будет возвращена ошибка TSRV_INVALID_HEADER

Возвращаемое значение: TokenInformation, либо ошибка TSRV_TOKEN_NOT_FOUND, если СКО не было найдено

Важно: если этот метод был вызван без передачи заголовка tokens.refresh, либо со значением "false", а СКО не было помечено как доступное к использованию, например методом get_tokens, то будет отдана ошибка TSRV_TOKEN_NOT_FOUND

Примеры

Пример с ошибкой

Запрос, без tokens.refresh:

{
  "type": "send",
  "address": "ik.service.token",
  "reply_address": "example",
  "data": null,
  "headers": {
    "token": "AVQ11031010703",
    "action": "get_token_by_serial"
  }
}

Ответ:

{
  "type": "error",
  "address": null,
  "reply_address": null,
  "data": {
    "description": "token was not found. available: [])",
    "name": "TSRV_TOKEN_NOT_FOUND"
  },
  "headers": null
}

Пример успешного выполнения

Запрос с заголовком tokens.refresh:

{
  "type": "send",
  "address": "ik.service.token",
  "reply_address": "example",
  "data": null,
  "headers": {
    "action": "get_token_by_serial",
    "tokens.refresh": "true",
    "token": "AVQ11031010703"
  }
}

Ответ:

{
  "type": "send",
  "address": "example",
  "reply_address": null,
  "data": {
    "device_id": 131010703,
    "operator_code": 5,
    "organization": "ИП Моров А.М.",
    "pin_code_length": 5,
    "puk_code_length": 8,
    "serial": "AVQ11031010703",
    "tax_number": 191832203
  },
  "headers": null
}

Пример неверного значения tokens.refresh

Запрос:

{
  "type": "send",
  "address": "ik.service.token",
  "reply_address": "example",
  "data": null,
  "headers": {
    "action": "get_token_by_serial",
    "token": "AVQ11031010703",
    "tokens.refresh": "truefalse"
  }
}

Ответ:

{
  "type": "error",
  "address": "example",
  "reply_address": null,
  "data": {
    "description": "invalid header value. header: 'tokens.refresh', error: provided string was not `true` or `false`",
    "name": "TSRV_INVALID_HEADER"
  },
  "headers": null
}