GetMaketStatus

Назначение	Проверяет наличие макета чека/пречека в r_keeper и возвращает его статус
Поддерживаемая версия агента	v2 с версии 2.9.3.6+
PluggetSystemType	RKRef

ФОРМАТ ЗАПРОСА

ФОРМАТ ЗАПРОСА

Запрос

{
  "taskType": "GetMaketStatus",
  "params": {
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "maketName": "string"
  }
}

CODE

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
taskType	string	да	Тип задачи
sync			Синхронный вызов метода (либо синхронный, либо асинхронный. Для этого изменить на "async")
objectId	int	да	Код ресторана в системе лицензирования
timeout	int	-	Время ожидания ответа в секундах	120 секунд
maketName	string	+	Наименование макета

ФОРМАТ ОТВЕТА

ФОРМАТ ОТВЕТА

Успешный ответ

{
    "taskResponse": {
        "makets": [
            {
                "name": "string",
                "status": "string",
                "id": number
            }
        ]
    },
...
},
    "responseCommon": {
        "taskGuid": "string",
        "taskType": "GetMaketStatus",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

CODE

Ответ с ошибкой. Ошибка агента или сервера

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetMaketStatus",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

CODE

Параметр

Тип

Обязательный

Описание

taskResponse

object

makets

array

+

Список найденных макетов с указанным именем.

Так как имя макета не уникально, то возвращаются все макеты с указанным именем.

Если макетов с указанным именем не существует – возвращается пустой массив

|- id

number

+

Идентификатор макета в r_keeper

|- name

string

+

Наименование макета

|- status

enum (string)

+

Статус макета. Принимает следующие значения:

Deleted — макет помечен как удаленный
Draft — макет помечен как черновик
Inactive/NotActive — макет помечен как не активный
Active — макет помечен как активный

responseCommon

object

Информация по задаче

taskGuid

guid

Уникальный код этой задачи используется при получении задачи через очередь

taskType

string

Тип задачи

objectId

int

Код ресторана в системе лицензирования

error

object

Контейнер ошибок, см Описание ошибок

wsError		Ошибка от сервера
agentError		Ошибка от агента

ПРИМЕРЫ СТРУКТУРЫ ЗАПРОСОВ

ПРИМЕРЫ СТРУКТУРЫ ЗАПРОСОВ

{
  "taskType": "GetMaketStatus",
  "params": {
    "sync": {
      "objectId": 199990246,
      "timeout": 120
    },
    "maketName": "QR-код"
  }
}

{
    "taskResponse": {
        "makets": [
            {
                "name": "QR-код",
                "status": "Active",
                "id": 13023
            }
        ]
    },
    "responseCommon": {
        "taskGuid": "7eebf417-0580-4770-9153-a694eb4a132d",
        "taskType": "GetMaketStatus",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

{
  "taskResponse": {
    "makets": []
  },
  "responseCommon": {
    "taskGuid": "adad07e1-697b-4ef2-abf7-f59f37c55f5c",
    "taskType": "GetMaketStatus",
    "objectId": 199990246,
    "agentGuid": "3bee8cde-d8dd-4609-9de7-bb42c5a722ef"
  }
}

{
  "responseCommon": {
    "taskGuid": "46f146fd-bb2c-41a8-b4aa-6587007bd0b4",
    "taskType": "GetMaketStatus",
    "objectId": 199990246
  },
  "error": {
    "wsError": {
      "code": "Timeout",
      "desc": "Agent is offline or has been unresponsive"
    }
  }
}