Подписка Advanced Integrated Visibility по клиентскому номеру предназначена для того, чтобы подписчики Advanced Integrated Visibility могли управлять своими проектами на основе клиентского номера и выполнять связанные с проектами операции, такие как редактирование или просмотр сведений о заданиях с помощью конечных точек API.

Примечание:

• Необходимо иметь права администратора для проекта API, в котором включен этот API.
• Дополнительную информацию об Advanced Integrated Visibility и связанных функциях см. на странице документации по Advanced Integrated Visibility.

Подписка Advanced Integrated Visibility оп клиентскому номеру следующие преимущества.

• Вы можете легко обновлять и управлять вашим проектом Advanced Integrated Visibility через конечные точки API.
• Этот API позволяет связать с проектом несколько счетов с помощью одной транзакции API, а не выбирать их по отдельности.

Указанные ниже конечные точки используются для управления проектом Advanced Integrated Visibility.

Обновление проекта Advanced Integrated Visibility

Эта конечная точка позволяет обновить сведения о проекте Advanced Integrated Visibility в вашей организации.

Для выполнения этого запроса требуются перечисленные ниже исходные данные.

• requestType: укажите тип запроса на обновление: 
  • ADD_ACCOUNTS: с помощью этого параметра можно добавлять новые счета в существующий проект, если организация уже связана с проектом Advanced Integrated Visibility для всех счетов.
  • DELETE_ACCOUNTS: с помощью этого параметра можно удалить счет из проекта;
  • UPDATE_ALL: этот параметр позволяет выполнять регулярное обновление проекта;
Примечание. Это необязательный элемент, и если пользователь не выбирает настройки, по умолчанию устанавливается параметр UPDATE_ALL.
• category: укажите категорию функции, которую необходимо обновить для проекта (например, RETRY_POLICY, PROOF_OF_DELIVERY и т. д.).
• subCategories: выберите отдельные функции для выбранной категории (например, BASIC_HRS, PPOD, SPOD, SHIP, TRAN и т. д.).

При успешном выполнении запроса ответ содержит идентификатор подписки, указание на то, что проект был обновлен для всех счетов в организации, и метку времени для обновленного проекта.

Получение сведений о проекте

Эта конечная точка позволяет получать сведения о выбранном проекте Advanced Integrated Visibility в постраничном режиме.

Для выполнения этого запроса требуются следующие исходные данные:

• authorization: укажите токен авторизации.
• subscriptionId: укажите идентификатор подписки для проекта Advanced Integrated Visibility, сведения о котором необходимо извлечь.

При успешном выполнении запроса на экран выводятся сведения для указанного проекта Webhook в постраничном режиме, а в случае сбоя отображается предупреждение или сведения об ошибке.

• В каждом запросе к проекту Advanced Integrated Visibility можно привязать не более 30 000 клиентских номеров.