Counter

Zwraca liczniki dla wybranych obiektów i opcjonalnie typów.

Endpointy obsługujące żądanie:

  • https://api.5ways.com

Dostępne parametry

Parametr Opis
object Nazwa obiektu, dla którego mają zostać zwrócone liczniki. Dostępne wartości: Issue, MailReceivedMysqlMessage. Bez tego parametru zwracane są liczniki dla wszystkich obiektów
type Typ licznika w ramach danego obiektu. Pozwala pobrać pojedynczy licznik zamiast wszystkich. Dostępne wartości zależą od object (patrz tabele poniżej)
groupIds Lista identyfikatorów użytkowników (rozdzielonych przecinkami) do filtrowania liczników spraw

Dostępne wartości type dla object=Issue:

Wartość Opis
my Sprawy przypisane do bieżącego użytkownika
unassigned Sprawy nieprzypisane
unaccepted Sprawy niezaakceptowane
delegated Sprawy delegowane

Dostępne wartości type dla object=MailReceivedMysqlMessage:

Wartość Opis
clients Nieprzeczytane wiadomości w folderze Klienci
others Nieprzeczytane wiadomości w folderze Inne
drafts Wersje robocze
offices Nieprzeczytane wiadomości w folderze Urzędy
providers Nieprzeczytane wiadomości w folderze Dostawcy
leads Nieprzeczytane wiadomości w folderze Leady
customFolders Nieprzeczytane wiadomości w folderach customowych (mapa folderId -> liczba)

Pobieranie liczników

GET /rest/counter

Zwracane dane
{
  "Counter": {
    "Issue": {
        "my": 0,
        "unassigned": 0,
        "unaccepted": 0,
        "delegated": 0
    },
    "MailReceivedMysqlMessage": {
        "clients": 0,
        "others": 0,
        "drafts": 0,
        "offices": 0,
        "providers": 0,
        "leads": 0,
        "customFolders": {
            "123": 5,
            "456": 0
        }
    }
  }
}

Opis pól MailReceivedMysqlMessage:

Pole Opis
clients Liczba nieprzeczytanych wiadomości w folderze Klienci
others Liczba nieprzeczytanych wiadomości w folderze Inne
drafts Całkowita liczba wersji roboczych
offices Liczba nieprzeczytanych wiadomości w folderze Urzędy
providers Liczba nieprzeczytanych wiadomości w folderze Dostawcy
leads Liczba nieprzeczytanych wiadomości w folderze Leady
customFolders Mapa folderId -> liczba nieprzeczytanych dla folderów customowych użytkownika. Klucze to identyfikatory folderów (int), wartości to liczba nieprzeczytanych wiadomości

Pobieranie liczników dla określonego obiektu

GET /rest/counter?object=Issue

Zwracane dane
{
  "Counter": {
    "Issue": {
        "my": 0,
        "unassigned": 0,
        "unaccepted": 0,
        "delegated": 0
    }
  }
}

Pobieranie liczników dla określonego obiektu i typu

GET /rest/counter?object=Issue&type=my

Zwracane dane
{
  "Counter": {
    "Issue": {
        "my": 0
    }
  }
}

Pobieranie liczników dla określonego obiektu i grupy użytkowników (ids użytkowników)

GET /rest/counter?object=Issue&groupIds=99,5334,3253

Zwracane dane
{
  "Counter": {
    "Issue": {
        "my": 0,
        "unassigned": 0,
        "unaccepted": 0,
        "delegated": 0
    }
  }
}

Pobieranie liczników mailowych

GET /rest/counter?object=MailReceivedMysqlMessage

Zwracane dane
{
  "Counter": {
    "MailReceivedMysqlMessage": {
        "clients": 0,
        "others": 0,
        "drafts": 0,
        "offices": 0,
        "providers": 0,
        "leads": 0,
        "customFolders": {
            "123": 5,
            "456": 0
        }
    }
  }
}

Pobieranie licznika mailowego dla określonego typu

GET /rest/counter?object=MailReceivedMysqlMessage&type=clients

Zwracane dane
{
  "Counter": {
    "MailReceivedMysqlMessage": {
        "clients": 0
    }
  }
}

Pobieranie liczników folderów customowych

GET /rest/counter?object=MailReceivedMysqlMessage&type=customFolders

Zwracane dane
{
  "Counter": {
    "MailReceivedMysqlMessage": {
        "customFolders": {
            "123": 5,
            "456": 0
        }
    }
  }
}