Перейти к основному содержимому

Проверка статуса сервиса

Для проверки статуса сервиса клиент отправляет пакет provideServiceStatusRequest. В ответ провайдер отправляет клиенту пакет provideServiceStatusResponse.

Пакет provideServiceStatusRequest​

Для получения статуса сервиса клиент передает на платформу только аутентификационные данные.

Структура пакета​

<provideServiceStatusRequest>
<header>
<auth>
<login>string</login>
<password>string</password>
</auth>
</header>
<payload/>
</provideServiceStatusRequest>
Полная XML-схема пакета provideServiceStatusRequest
<xsd:schema>
<xsd:element name="provideServiceStatusRequest">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="header">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="auth">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="login" type="xsd:string"/>
<xsd:element name="password" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="payload" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>

Пример пакета​

<provideServiceStatusRequest>
<header>
<auth>
<login>test</login>
<password>test</password>
</auth>
</header>
<payload/>
</provideServiceStatusRequest>

Пакет provideServiceStatusResponse​

В пакете provideServiceStatusResponse провайдер сообщает клиенту статус сервиса.

Структура пакета​

<provideServiceStatusResponse>
<header/>
<payload>
<code>ok</code>
<serviceStatus>ok</serviceStatus>
</payload>
</provideServiceStatusResponse>
Полная XML-схема пакета provideServiceStatusResponse
<xsd:schema>
<xsd:element name="provideServiceStatusResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="header" type="xsd:string"/>
<xsd:element name="payload">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="code">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ok"/>
<xsd:enumeration value="error-syntax"/>
<xsd:enumeration value="error-auth"/>
<xsd:enumeration value="error-permission"/>
<xsd:enumeration value="error-system"/>
<xsd:enumeration value="error-account-locked"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="serviceStatus" minOccurs="0">
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="ok"/>
<xsd:enumeration value="error-account"/>
<xsd:enumeration value="error-system"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>

Параметры пакета​

к сведению

Все параметры в таблице входят в объект payload.

ПараметрТипХарактерОписание
codeStringОбязательныйКод результата обработки пакета provideServiceStatusRequest. File IconОтвет на ошибочный пакет
serviceStatusStringОбязательныйКод статуса сервиса.
Возможные значения:
- ok — сервис готов обрабатывать запросы;
- error-system — технический сбой, сервис не может обрабатывать запросы;
- error-account — сервис не может обрабатывать запросы с указанного аккаунта.

Пример пакета​

<provideServiceStatusResponse>
<header/>
<payload>
<code>ok</code>
<serviceStatus>ok</serviceStatus>
</payload>
</provideServiceStatusResponse>