Centrum pomocyIntegracje

Dla: Administratorzy

Dodawaj i usuwaj członków sprawy za pomocą klucza zarządzania

Przydzielaj ludziom sprawy, określając ich rolę i stanowisko, wysyłaj e-maile z zaproszeniami, sprawdzaj, kto zajmuje się sprawą, lub zdejmuj kogoś ze sprawy.

W tym artykule8 sekcji

Zanim zaczniesz

Ta strona opisuje działania związane z przyjmowaniem i usuwaniem osób z listy „case”. Drogi do tego procesu znajdują się pod https://prd-api-manage.caseactive.com/v1/<hub id>. Osoba musi już znajdować się na twoim hubie; informacje na temat dodawania i aktualizowania użytkowników z pomocą klucza zarządzającego można znaleźć w sekcji „Dodawanie i aktualizowanie użytkowników za pomocą klucza zarządzającego”.

Połączenia

DzwonićCo to robi
GET /cases/permissions?case_id=<case_id>Lista wszystkich osób związanych z danym przypadkiem
POST /cases/permissionsKtoś wprowadza kogoś do jakiegoś przypadku.
GET /cases/permissions/<case_id>/<user_id>Wykorzystuje miejsce danej osoby w danym przypadku.
PUT /cases/permissions/<case_id>/<user_id>Zmiana nazwy sprawy przez danej osobę
DELETE /cases/permissions/<case_id>/<user_id>Odkrywa kogoś z jakiegoś „case’u”.

Nie ma potrzeby zmieniania roli kogoś w danej sprawie, ani też wysyłania ponownych zaproszeń. Wystarczy usunąć go z listy osób akceptowanych do pracy, a potem ponownie go dodać do listy takich osób. To dotyczy również reguł przyjmujących tych osoby do pracy.

Dodawanie kogoś

PoleCo to robiWymaganyDomyślny
case_idTen przypadek pochodzi z twojego miejsca zamieszkania.Tak.–
user_idTa osoba pochodzi z twojego miasta. Ktoś, kto ma niepełnosprawność w twoim mieście, nie może zostać przyjęty.Tak.–
case_role_idIch rolaRola Zestaw uprawnień decydujący o tym, co dana osoba może zobaczyć i zrobić w danej sprawie, np. pracownicy lub klienci. w tym przypadku – w pełnym zakresie: role::clients, role::staff lub jedna z twoich specjalnych ról z GET /roles. role::bots Wirtualnego Asystenta jest odrzucone.Tak.–
case_notifytrue wysyła im zaproszenie do swojego przypadku.Tak.–
staff_designationDla role::staff oraz twoich specjalnych rolí: primary, attorney, paralegal, case_manager, lead_attorney lub lead_paralegalNieprimary
client_designationDla role::clients: primary lub guardianNieprimary

NazwaOznaczenie Etykieta określająca czyjeś obowiązki w danej sprawie, np. Główny prawnik, Pomocnik prawny lub Opiekun. określa, kim jest osoba odpowiedzialna za dany przypadek. Dlatego szablony mogą określić np. głównego klienta danego przypadku. role::clients zachowuje client_designation, a wszystkie inne role zachowują staff_designation. Pozostaw drugą rolę bez wyrażenia, albo wysłać primary: guardian z jakąkolwiek inną rolą, lub nazwę osoby pracowniczej z role::clients – takie informacje zostaną odrzucone na tym polu, a żadna osoba nie zostanie dodana do listy.

curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/permissions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_id": "cc-1a2b3c4d5e6f70", "user_id": "cu-4f1c2a9e8b7d60", "case_role_id": "role::clients", "case_notify": true, "client_designation": "primary"}'

Odpowiada na 201 za pomocą case_id i user_id.

  • W tym pojeździe znajduje się 20 osób, w tym również Assistent wirtualnyAsystent wirtualny Automatyczny członek zespołu, który publikuje wiadomości powitalne, meldunki i wpisy dotyczące etapów rozwoju firmy. Jego wpisy są oznaczone odznaką wirtualnego asystenta.. To oznacza, że jest tam jeszcze 19 osób.
  • Zamknięty przypadek nie zajmuje czasu nikogo. Najpierw otwórz go ponownie; patrz Jak tworzyć i aktualizować przypadki za pomocą narzędzia „Manage Cases”.
  • Osoba ta od razu widzi tę sprawę na swoim portalu.

Co się stanie dalej?

  • Gdy case_notify zostanie ustawiony na true, osoba ta otrzyma zaproszenie do udziału w sprawie przedstawionej przez twoją firmę. Zaproszenie zawiera link, który umożliwia jej dostęp do danej sprawy. Link ten trafia na jej aktywną adres e-mail, albo jako wiadomość na jej aktywny numer telefonu, jeśli nie ma żadnego adresu e-mail. Jeśli żadna z tych informacji nie jest dostępna, nic nie zostanie wysłane. Osoba, która wyłączyła dostęp do twojej firmy, nie otrzyma żadnych informacji.
  • Zasady przywitania klientów w ramach ich roli dodają odpowiednie szablony do danej sprawy; patrz Przywitawanie klientów po tym, jak dołączą do sprawy.
  • Ktoś nie zamieścił żadnych informacji na temat samego przypadku. Choć zostały opublikowane szablony postów związanych z regulacjami, to żaden webhook nie został wysłany.

Zmiana oznaczenia

PUT /cases/permissions/<case_id>/<user_id> przy {"case_designation": "lead_attorney"} otrzymuje 204. To zmienia nazwę osoby w tym przypadku, ale nic więcej się nie zmienia: osoba nadal pozostaje na tym samym poziomie, nikt nie otrzymuje żadnych danych, a żadne reguły powitania nie obowiązują. Następny post i wypełniony formularz korzysta z nowej struktury.

Nazwa musi odpowiadać ich roli w danej sytuacji: primary lub guardian dla role::clients, a sześć innych nazw jest przydatnych do określenia innych ról. Nazwy wirtualnego asystenta nie mogą być zmieniane.

curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/permissions/cc-1a2b3c4d5e6f70/cu-9d8c7b6a5f4e30 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_designation": "lead_attorney"}'

Czytanie, kto jest w sprawie

GET /cases/permissions?case_id=cc-1a2b3c4d5e6f70 odpowiada na pytania wszystkich zainteresowanych osób, w tym również na pytania związane z tą sprawą, za pomocą Asysty Wirtualnej, jak role::bots.

{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "case_role_id": "role::clients",
        "case_designation": "primary",
        "case_notify": true,
        "case_status": 1,
        "case_ref_id": "ca-7e6d5c4b3a2f10::rear-end-2026",
        "given_name": "Jane",
        "family_name": "Sample",
        "host_user_status": 1,
        "locale": "en",
        "zoneinfo": "US/Eastern",
        "created_on": "2026-10-02T14:06:30+00:00"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/permissions?case_id=cc-1a2b3c4d5e6f70"
  }
}

Każdy wpis zawiera również kopię informacji o sprawie title i description. Adresy e-mail oraz numery telefonów nie są uwzględnione: prosimy o kontakt z osobą pod adresem GET /users/relations/<user_id>. Sprawa, która nie znajduje się w twojej listy odpowiedzi, jest ignorowana.

Zabieranie kogoś

DELETE /cases/permissions/<case_id>/<user_id> odpowiada na pytania 204, nawet wtedy, gdy osoba ta nie była obecna w tym przypadku. Dlatego można to powtórzyć bez żadnych problemów. Nikomu nie informuje się o tym, ale osobie wysyłana jest informacja o odwołaniu wszystkich wydarzeń planowanych w tym przypadku, niezależnie od tego, czy zostały one już zrealizowane, czy nie. Osoba ta traci dostęp do danych związanych z tym przypadkiem na swoim portalu. Asystent wirtualny nie może zostać usunięty.

Jeśli połączenie zostanie odrzucone

StatusmessageDlaczego
400SchemaFieldsExceptionW tym polu brakuje informacji lub są one nieprawidłowe; nazwy te znajdują się w wyrazie errors. Nazwa, osoba lub rola, która nie znajduje się w swoim „hubie”, jest oznaczona jako FieldValidatorFailedException w tym polu. Również tak jest w przypadku nazw, których rolę nie może pełnić ta osoba/rola.
400FieldUserDupsExceptionOsoba ta już jest w trakcie realizacji zadania.
400CaseUserLimitOrTransactionExceptionW tym przypadku jest już 20 osób, więc zamówienie zostało anulowane w tym momencie. Sprawdź liczbę osób, a potem spróbuj ponownie.
400TransactionCanceledExceptionBardzo pilna sytuacja uniemożliwiła realizację tego zamówienia. Spróbuj ponownie później.
400CaseUserDisabledExceptionOsoba ta ma niepełnosprawność w twoim systemie. Najpierw należy ją ponownie aktywować.
403CaseClosedExceptionSprawa jest zamknięta, ponieważ nie ma potrzeby wprowadzenia żadnych zmian w nazwie lub charakterystyce produktu.
403DatabaseTransactionConditionalCheckFailedPróbowałeś usunąć Tę Wirtualną Asystentkę.
404ItemNotFoundExceptionCzytanie informacji o jednej osobie lub zmiana jej nazwy: ta osoba nie znajduje się w danej sprawie, albo sprawa nie należy do twojego hube. Dodawanie nowej osoby lub zmiana jej nazwy: sprawa zostaje usunięta.

Informacje dotyczące kodu błędów oraz pozostałych kodów znajdują się w sekcji Obsługa błędów API i kodów statusowych.

Powiązane artykuły

Twórz i aktualizuj sprawy za pomocą klucza zarządzaniaTwórz, twórz, czytaj, aktualizuj i usuwaj sprawy swojego huba z poziomu własnego oprogramowania, łącznie z ich etapami i polami niestandardowymi.IntegracjeDodawaj i aktualizuj użytkowników za pomocą klucza zarządzaniaWyświetl listę osób w swoim centrum, dodaj klientów, przeczytaj dane i sprawy poszczególnych osób, a także wyłącz lub ponownie włącz ich dostęp.IntegracjePrzeczytaj role za pomocą klucza zarządzaniaWypisz role swojego centrum i przeczytaj uprawnienia jednej roli, tak aby Twoje oprogramowanie mogło przydzielać do spraw osoby z odpowiednią rolą.Integracje