iMIS
iMIS, specjalnie utworzony system zarządzania zakontraktowaniem dla skojarzeń i organizacji non-profit.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Computer System Innovation, Inc. |
| adres URL | https://csiinc.com/support |
| support@csiinc.com |
| Metadane łącznika | |
|---|---|
| Publisher | Computer System Innovation, Inc. |
| Witryna internetowa | https://www.csiinc.com/ |
| Zasady ochrony prywatności | https://www.csiinc.com/privacy |
| Kategorie | Dane; Sprzedaż i CRM |
Usługa iMIS to jedyny na świecie system zarządzania zakontraktowaniem (EMS), który został utworzony specjalnie, aby zaspokoić unikatowe potrzeby organizacji i wspierać ciągłe ulepszanie wydajności. Rozszerzanie danych usługi iMIS — kontaktów, działań, paneli, IQAs i nie tylko — do ekosystemu usług Power Automate i Logic Apps za pomocą wyzwalaczy i akcji dostępnych w tym łączniku.
Wymagania wstępne
Do korzystania z tego łącznika będzie potrzebne aktywne wystąpienie iMIS oraz subskrypcja. Aby uzyskać więcej informacji, zobacz: https://csi.ms/paprerequisites
Jak uzyskać poświadczenia
Do korzystania z tego łącznika będzie potrzebny klucz interfejsu API. (Uwaga: nie jest to samo co poświadczenia interfejsu API iMIS). Aby uzyskać instrukcje dotyczące uzyskiwania klucza interfejsu API, zobacz: https://csi.ms/paapikey
Wprowadzenie do łącznika
Skorzystaj z naszego prostego przewodnika, aby rozpocząć pracę z usługami iMIS i Power Automate tutaj: https://csi.ms/pagettingstarted
Po pomyślnym nawiązaniu połączenia przejrzyj naszą bibliotekę Idea Library usługi Automation, aby zapoznać się z pomysłami dotyczącymi automatyzacji, które można tworzyć za pomocą usług iMIS i Power Automate: http://csi.ms/paideas
Znane problemy i ograniczenia
Aby uzyskać pełną listę znanych ograniczeń i bieżących problemów, zapoznaj się z tematem: https://csi.ms/palimitations
Typowe błędy i środki zaradcze
401 Brak autoryzacji
Po zwróceniu tego kodu stanu sprawdź treść odpowiedzi i poszukaj nagłówka niestandardowego X-CSI-Error-Msg . Pomoże to zdiagnozować problem.
Aby uzyskać pełną listę typowych kroków rozwiązywania problemów, zobacz: https://csi.ms/palimitations
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API CSI | securestring | Wprowadź klucz interfejsu API CSI znajdujący się na pulpicie nawigacyjnym chmury CSI. | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie adresu e-mail kontaktu |
Aktualizuje adres e-mail kontaktu w usłudze iMIS. |
| Aktualizowanie działania |
Aktualizowanie rekordu aktywności w usłudze iMIS |
| Aktualizowanie kontaktu |
Aktualizuje rekord kontaktu (osoby) w usłudze iMIS. Identyfikator iMIS jest wymagany w treści żądania i zostanie użyty do znalezienia kontaktu w celu zaktualizowania. Zostaną zaktualizowane tylko pola z wartościami. Jeśli pole pozostanie puste, nie zostanie zaktualizowane. |
| Aktualizowanie rekordu panelu pojedynczego wystąpienia |
Aktualizowanie rekordu panelu pojedynczego wystąpienia w usłudze iMIS. |
| Aktualizowanie rekordu panelu z wieloma wystąpieniami |
Aktualizuje rekord panelu z wieloma wystąpieniami w usłudze iMIS. |
| Pobieranie działania według sekwencji |
Pobiera pojedynczy rekord działania według wartości sekwencji (SEQN) |
| Pobieranie obrazu kontaktu |
Pobiera obraz profilu kontaktu według identyfikatora iMIS. |
| Pobieranie wszystkich adresów kontaktu |
Pobiera listę adresów kontaktu. |
| Tworzenie działania |
Tworzenie nowego rekordu aktywności w usłudze iMIS |
| Tworzenie kontaktu |
Tworzy rekord kontaktu (osoby) w usłudze iMIS. |
| Tworzenie organizacji |
Tworzy rekord kontaktu (organizacji) w usłudze iMIS. |
| Tworzenie rekordu panelu z wieloma wystąpieniami |
Tworzy rekord panelu z wieloma wystąpieniami w usłudze iMIS. |
| Usuwanie rekordu panelu z jednym wystąpieniem |
Usuwa rekord panelu pojedynczego wystąpienia w usłudze iMIS. |
| Usuwanie rekordu panelu z wieloma wystąpieniami |
Usuwa rekord panelu z wieloma wystąpieniami w usłudze iMIS. |
| Uzyskiwanie adresu kontaktu |
Pobiera adres kontaktu. |
| Uzyskiwanie kontaktu |
Pobiera jeden rekord kontaktu według identyfikatora iMIS. |
| Uzyskiwanie rekordu panelu pojedynczego wystąpienia |
Pobiera rekord panelu pojedynczego wystąpienia w usłudze iMIS. |
| Uzyskiwanie rekordu panelu z wieloma wystąpieniami |
Pobiera rekord panelu z wieloma wystąpieniami w usłudze iMIS. |
| Wykonywanie IQA |
Wykonuje iMIS IQA w podanej ścieżce. |
| Zaktualizuj organizację |
Aktualizuje rekord kontaktu (organizacji) w usłudze iMIS. |
| Znajdowanie działań |
Wyszukiwanie działań według typu, identyfikatora iMIS i innych |
| Znajdowanie kontaktów |
Znajduje rekordy kontaktów iMIS według różnych kryteriów. Większość pól wyszukiwania obsługuje filtry wyszukiwania, takie jak "startsWith:x" lub "contains:x". Zapoznaj się z dokumentacją, aby uzyskać pełną listę. |
| Znajdowanie rekordów panelu |
Znajduje rekordy panelu iMIS według różnych kryteriów. Większość pól wyszukiwania obsługuje filtry wyszukiwania, takie jak "startsWith:x" lub "contains:x". Zapoznaj się z dokumentacją, aby uzyskać pełną listę. |
Aktualizowanie adresu e-mail kontaktu
Aktualizuje adres e-mail kontaktu w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator usługi iMIS
|
id | True | string |
Identyfikator iMIS adresu do aktualizacji |
|
Adres 1
|
address1 | string |
Linia adresowa 1 |
|
|
Adres 2
|
address2 | string |
Wiersz adresu 2 |
|
|
Nazwa miasta
|
city | string |
Nazwa miasta na adresie |
|
|
Kod stanu/prowincji
|
stateProvinceCode | string |
Skrócony kod dla stanu/prowincji |
|
|
Kod pocztowy
|
postalCode | string |
Kod pocztowy lub pocztowy |
|
|
Kod kraju
|
countryCode | string |
Skrócony kod kraju |
|
|
Numer telefonu
|
phone | string |
Sformatowany numer telefonu dla tego adresu |
|
|
Adres e-mail
|
string |
Adres e-mail dla tego adresu |
||
|
Adres 3
|
address3 | string |
Wiersz adresu 3 |
|
|
Numer faksu
|
fax | string |
Sformatowany numer faksu dla tego adresu |
Zwraca
- Body
- AddressDTO
Aktualizowanie działania
Aktualizowanie rekordu aktywności w usłudze iMIS
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kody akcji
|
actionCodes | string | ||
|
Typ działania
|
activityType | string | ||
|
Kwota
|
amount | double | ||
|
Sekwencja załączników
|
attachSeqn | integer | ||
|
Suma załącznika
|
attachTotal | double | ||
|
Numer partii
|
batchNum | string | ||
|
Kod kampanii
|
campaignCode | string | ||
|
Kategoria
|
category | string | ||
|
Identyfikator współtworzenia
|
coId | string | ||
|
Description
|
description | string | ||
|
Data wejścia w życie
|
effectiveDate | date | ||
|
Ulgowe
|
gracePeriod | integer | ||
|
Intencja edycji
|
intentToEdit | string | ||
|
Kod pamięci/hołdu
|
memTribCode | string | ||
|
Typ elementu członkowskiego
|
memberType | string | ||
|
Następna data instalacji
|
nextInstallDate | date | ||
|
Uwaga / Notatka
|
note | string | ||
|
Uwaga 2
|
note2 | string | ||
|
Object
|
object | string | ||
|
Kod organizacji
|
orgCode | string | ||
|
Numer trans źródłowy
|
originatingTransNum | integer | ||
|
Inny kod
|
otherCode | string | ||
|
Inny identyfikator
|
otherId | string | ||
|
Metoda płatności
|
payMethod | string | ||
|
Kod produktu
|
productCode | string | ||
|
Ilość
|
quantity | double | ||
|
Żądanie cykliczne
|
recurringRequest | boolean | ||
|
Kolejność
|
seqn | True | integer | |
|
Identyfikator adwokata
|
solicitorId | string | ||
|
Kod źródłowy
|
sourceCode | string | ||
|
System źródłowy
|
sourceSystem | string | ||
|
Kod stanu
|
statusCode | string | ||
|
Wartość podatna na opodatkowanie
|
taxableValue | double | ||
|
Data przepusty
|
thruDate | date | ||
|
Data znacznika
|
ticklerDate | date | ||
|
Data transakcji
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
Pole użytkownika 1 (ciąg) |
|
|
UF2
|
uF2 | string |
Pole użytkownika 2 (ciąg) |
|
|
UF3
|
uF3 | string |
Pole użytkownika 3 (ciąg) |
|
|
UF4
|
uF4 | double |
Pole użytkownika 4 (dziesiętne) |
|
|
UF5
|
uF5 | double |
Pole użytkownika 5 (dziesiętne) |
|
|
UF6
|
uF6 | date |
Pole użytkownika 6 (data) |
|
|
UF7
|
uF7 | date |
Pole użytkownika 7 (data) |
|
|
Units
|
units | double |
Zwraca
- Body
- ActivityDTO
Aktualizowanie kontaktu
Aktualizuje rekord kontaktu (osoby) w usłudze iMIS. Identyfikator iMIS jest wymagany w treści żądania i zostanie użyty do znalezienia kontaktu w celu zaktualizowania. Zostaną zaktualizowane tylko pola z wartościami. Jeśli pole pozostanie puste, nie zostanie zaktualizowane.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator usługi iMIS
|
id | True | string |
Identyfikator iMIS (nazywany również identyfikatorem kontaktu, identyfikatorem strony) |
|
Prefiks nazwy
|
namePrefix | string |
Prefiks nazwy kontaktu (np. "Pani"). |
|
|
Imię
|
firstName | string |
Imię kontaktu |
|
|
Nazwa nieformalna
|
informalName | string |
Nieformalna nazwa kontaktu (lub pseudonim) |
|
|
Drugie imię
|
middleName | string |
Imię i nazwisko osoby kontaktowej |
|
|
Nazwisko
|
lastName | string |
Nazwisko kontaktu |
|
|
Sufiks nazwy
|
nameSuffix | string |
Sufiks nazwy kontaktu (np. "Jr.") |
|
|
Tytuł funkcjonalny
|
functionalTitle | string |
Wartość kodu tytułu funkcjonalnego kontaktu |
|
|
Identyfikator organizacji nadrzędnej
|
parentOrganizationId | string |
Określ identyfikator iMIS organizacji nadrzędnej, aby połączyć tę osobę z |
|
|
Email
|
string |
Podstawowy adres e-mail kontaktu |
||
|
Telefon służbowy
|
workPhone | string |
Numer telefonu służbowego kontaktu |
|
|
Telefon domowy
|
homePhone | string |
Numer telefonu domowego kontaktu |
|
|
Telefon komórkowy
|
mobilePhone | string |
Numer telefonu komórkowego kontaktu |
|
|
Faks
|
fax | string |
Numer faksu kontaktu |
|
|
Gender
|
gender | string |
Kod płci kontaktu (np. "M", "F" lub inne zdefiniowane kody) |
|
|
Typ elementu członkowskiego
|
memberType | string |
Kod typu elementu członkowskiego kontaktu (np. "NM" lub "WEB") |
|
|
Kategoria rozliczeń
|
billingCategory | string |
Nazwa kategorii rozliczeń kontaktu |
|
|
Klucz główny
|
majorKey | string |
Główne pole klucza kontaktu |
|
|
Status
|
status | string |
Kod stanu kontaktu (np. "A", "D", "X") |
Zwraca
- Body
- ContactDTO
Aktualizowanie rekordu panelu pojedynczego wystąpienia
Aktualizowanie rekordu panelu pojedynczego wystąpienia w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa panelu
|
panelNameSingleUpdate | string |
Nazwa panelu do zaktualizowania. |
|
|
body
|
body | dynamic |
Schemat wygenerowany przez getPanelSchema. |
Zwraca
Aktualizowanie rekordu panelu z wieloma wystąpieniami
Aktualizuje rekord panelu z wieloma wystąpieniami w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa panelu
|
panelNameMultiUpdate | string |
Nazwa panelu do zaktualizowania. |
|
|
body
|
body | dynamic |
Schemat wygenerowany przez getPanelUpdateSchema. |
Zwraca
Pobieranie działania według sekwencji
Pobiera pojedynczy rekord działania według wartości sekwencji (SEQN)
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer sekwencji
|
sequenceNumber | True | integer |
Numer sekwencji |
Zwraca
- Body
- ActivityDTO
Pobieranie obrazu kontaktu
Pobiera obraz profilu kontaktu według identyfikatora iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator usługi iMIS
|
contactId | True | string |
Identyfikator usługi iMIS |
Zwraca
Reprezentuje obraz profilu kontaktu
- Body
- ContactPictureDTO
Pobieranie wszystkich adresów kontaktu
Pobiera listę adresów kontaktu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator usługi iMIS
|
contactId | True | string |
Identyfikator iMIS umożliwiający pobranie adresów dla |
Zwraca
- Body
- AddressListDTO
Tworzenie działania
Tworzenie nowego rekordu aktywności w usłudze iMIS
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Kody akcji
|
actionCodes | string | ||
|
Typ działania
|
activityType | True | string | |
|
Kwota
|
amount | double | ||
|
Sekwencja załączników
|
attachSeqn | integer | ||
|
Suma załącznika
|
attachTotal | double | ||
|
Numer partii
|
batchNum | string | ||
|
Kod kampanii
|
campaignCode | string | ||
|
Kategoria
|
category | string | ||
|
Identyfikator współtworzenia
|
coId | string | ||
|
Description
|
description | string | ||
|
Data wejścia w życie
|
effectiveDate | date | ||
|
Ulgowe
|
gracePeriod | integer | ||
|
Identyfikator usługi iMIS
|
id | True | string | |
|
Intencja edycji
|
intentToEdit | string | ||
|
Kod pamięci/hołdu
|
memTribCode | string | ||
|
Typ elementu członkowskiego
|
memberType | string | ||
|
Następna data instalacji
|
nextInstallDate | date | ||
|
Uwaga / Notatka
|
note | string | ||
|
Uwaga 2
|
note2 | string | ||
|
Object
|
object | string | ||
|
Kod organizacji
|
orgCode | string | ||
|
Numer trans źródłowy
|
originatingTransNum | integer | ||
|
Inny kod
|
otherCode | string | ||
|
Inny identyfikator
|
otherId | string | ||
|
Metoda płatności
|
payMethod | string | ||
|
Kod produktu
|
productCode | string | ||
|
Ilość
|
quantity | double | ||
|
Żądanie cykliczne
|
recurringRequest | boolean | ||
|
Identyfikator adwokata
|
solicitorId | string | ||
|
Kod źródłowy
|
sourceCode | string | ||
|
System źródłowy
|
sourceSystem | string | ||
|
Kod stanu
|
statusCode | string | ||
|
Wartość podatna na opodatkowanie
|
taxableValue | double | ||
|
Data przepusty
|
thruDate | date | ||
|
Data znacznika
|
ticklerDate | date | ||
|
Data transakcji
|
transactionDate | date | ||
|
UF1
|
uF1 | string |
Pole użytkownika 1 (ciąg) |
|
|
UF2
|
uF2 | string |
Pole użytkownika 2 (ciąg) |
|
|
UF3
|
uF3 | string |
Pole użytkownika 3 (ciąg) |
|
|
UF4
|
uF4 | double |
Pole użytkownika 4 (dziesiętne) |
|
|
UF5
|
uF5 | double |
Pole użytkownika 5 (dziesiętne) |
|
|
UF6
|
uF6 | date |
Pole użytkownika 6 (data) |
|
|
UF7
|
uF7 | date |
Pole użytkownika 7 (data) |
|
|
Units
|
units | double |
Zwraca
- Body
- ActivityDTO
Tworzenie kontaktu
Tworzy rekord kontaktu (osoby) w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Prefiks nazwy
|
namePrefix | string |
Prefiks nazwy kontaktu (np. "Pani"). |
|
|
Imię
|
firstName | string |
Imię kontaktu |
|
|
Nazwa nieformalna
|
informalName | string |
Nieformalna nazwa kontaktu (lub pseudonim) |
|
|
Drugie imię
|
middleName | string |
Imię i nazwisko osoby kontaktowej |
|
|
Nazwisko
|
lastName | string |
Nazwisko kontaktu |
|
|
Sufiks nazwy
|
nameSuffix | string |
Sufiks nazwy kontaktu (np. "Jr.") |
|
|
Tytuł funkcjonalny
|
functionalTitle | string |
Wartość kodu tytułu funkcjonalnego kontaktu |
|
|
Identyfikator organizacji nadrzędnej
|
parentOrganizationId | string |
Określ identyfikator iMIS organizacji nadrzędnej, aby połączyć tę osobę z |
|
|
Nazwa organizacji
|
organizationName | string |
Nazwa organizacji, do którego należy ten kontakt (nie jest używana, jeśli ustawiono identyfikator organizacji nadrzędnej) |
|
|
Email
|
string |
Podstawowy adres e-mail kontaktu |
||
|
Telefon służbowy
|
workPhone | string |
Numer telefonu służbowego kontaktu |
|
|
Telefon domowy
|
homePhone | string |
Numer telefonu domowego kontaktu |
|
|
Telefon komórkowy
|
mobilePhone | string |
Numer telefonu komórkowego kontaktu |
|
|
Faks
|
fax | string |
Numer faksu kontaktu |
|
|
Gender
|
gender | string |
Kod płci kontaktu (np. "M", "F" lub inne zdefiniowane kody) |
|
|
Typ elementu członkowskiego
|
memberType | string |
Kod typu elementu członkowskiego kontaktu (np. "NM" lub "WEB") |
|
|
Kategoria rozliczeń
|
billingCategory | string |
Nazwa kategorii rozliczeń kontaktu |
|
|
Klucz główny
|
majorKey | string |
Główne pole klucza kontaktu |
|
|
Status
|
status | string |
Kod stanu kontaktu (np. "A", "D", "X") |
|
|
Data urodzenia
|
birthDate | date |
Data urodzenia kontaktu |
|
|
Data dołączenia
|
joinDate | date |
Data dołączenia kontaktu |
Zwraca
- Body
- ContactDTO
Tworzenie organizacji
Tworzy rekord kontaktu (organizacji) w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa organizacji
|
organizationName | string |
Nazwa tej organizacji |
|
|
Adres URL witryny internetowej
|
websiteUrl | string |
Adres URL witryny sieci Web dla strony głównej tej organizacji |
|
|
Email
|
string |
Podstawowy adres e-mail organizacji |
||
|
Telefon służbowy
|
workPhone | string |
Numer telefonu służbowego organizacji |
|
|
Faks
|
fax | string |
Numer faksu organizacji |
|
|
Typ elementu członkowskiego
|
memberType | string |
Kod typu członka organizacji (np. "NM" lub "WEB") |
|
|
Kategoria rozliczeń
|
billingCategory | string |
Nazwa kategorii rozliczeń organizacji |
|
|
Klucz główny
|
majorKey | string |
Główne pole klucza organizacji |
|
|
Status
|
status | string |
Kod stanu organizacji (np. "A", "D", "X") |
|
|
Data dołączenia
|
joinDate | date |
Data dołączenia organizacji |
Zwraca
- Body
- ContactDTO
Tworzenie rekordu panelu z wieloma wystąpieniami
Tworzy rekord panelu z wieloma wystąpieniami w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa panelu
|
panelNameMultiCreate | string |
Nazwa panelu do utworzenia. |
|
|
body
|
body | dynamic |
Schemat wygenerowany przez polecenie GetPanelCreateSchema. |
Zwraca
Usuwanie rekordu panelu z jednym wystąpieniem
Usuwa rekord panelu pojedynczego wystąpienia w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa panelu
|
panelNameSingleDelete | string |
Nazwa panelu do usunięcia. |
|
|
body
|
body | dynamic |
Schemat wygenerowany przez getPanelDeleteSchema. |
Usuwanie rekordu panelu z wieloma wystąpieniami
Usuwa rekord panelu z wieloma wystąpieniami w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa panelu
|
panelNameMultiDelete | string |
Nazwa panelu do usunięcia. |
|
|
body
|
body | dynamic |
Schemat wygenerowany przez getPanelDeleteSchema. |
Uzyskiwanie adresu kontaktu
Pobiera adres kontaktu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator usługi iMIS
|
contactId | True | string |
Identyfikator iMIS, aby uzyskać adres dla |
|
Cel adresu
|
addressPurpose | True | string |
Musi być dobrze zdefiniowaną nazwą przeznaczenia adresu w usłudze iMIS |
Zwraca
- Body
- AddressDTO
Uzyskiwanie kontaktu
Pobiera jeden rekord kontaktu według identyfikatora iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator usługi iMIS
|
contactId | True | string |
Identyfikator usługi iMIS |
Zwraca
- Body
- ContactDTO
Uzyskiwanie rekordu panelu pojedynczego wystąpienia
Pobiera rekord panelu pojedynczego wystąpienia w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa panelu
|
panelNameSingleGet | string |
Nazwa panelu do pobrania. |
|
|
body
|
body | dynamic |
Schemat wygenerowany przez getPanelGetSchema. |
Zwraca
Uzyskiwanie rekordu panelu z wieloma wystąpieniami
Pobiera rekord panelu z wieloma wystąpieniami w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa panelu
|
panelNameMultiGet | string |
Nazwa panelu do pobrania. |
|
|
body
|
body | dynamic |
Schemat wygenerowany przez getPanelGetSchema. |
Zwraca
Wykonywanie IQA
Wykonuje iMIS IQA w podanej ścieżce.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ścieżka IQA
|
iqaPath | string |
Ścieżka IQA do wykonania. |
|
|
body
|
body | dynamic |
Filtry Iqa. |
Zwraca
Zaktualizuj organizację
Aktualizuje rekord kontaktu (organizacji) w usłudze iMIS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator usługi iMIS
|
id | True | string |
Identyfikator iMIS (nazywany również identyfikatorem kontaktu, identyfikatorem strony) |
|
Nazwa organizacji
|
organizationName | string |
Nazwa tej organizacji |
|
|
Adres URL witryny internetowej
|
websiteUrl | string |
Adres URL witryny sieci Web dla strony głównej tej organizacji |
|
|
Email
|
string |
Podstawowy adres e-mail organizacji |
||
|
Telefon służbowy
|
workPhone | string |
Numer telefonu służbowego organizacji |
|
|
Faks
|
fax | string |
Numer faksu organizacji |
|
|
Typ elementu członkowskiego
|
memberType | string |
Kod typu członka organizacji (np. "NM" lub "WEB") |
|
|
Kategoria rozliczeń
|
billingCategory | string |
Nazwa kategorii rozliczeń organizacji |
|
|
Klucz główny
|
majorKey | string |
Główne pole klucza organizacji |
|
|
Status
|
status | string |
Kod stanu organizacji (np. "A", "D", "X") |
Zwraca
- Body
- ContactDTO
Znajdowanie działań
Wyszukiwanie działań według typu, identyfikatora iMIS i innych
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ działania
|
activityType | string |
Kod typu działania |
|
|
Identyfikator usługi iMIS
|
imisId | string |
Identyfikator iMIS |
|
|
Kod produktu
|
productCode | string |
Kod produktu |
|
|
Kategoria
|
category | string |
Kategoria |
|
|
Data transakcji w dniu lub przed
|
transactionDateBefore | date |
Data transakcji w dniu lub przed |
|
|
Data transakcji po
|
transactionDateAfter | date |
Data transakcji po |
|
|
Data wejścia w życie lub przed
|
effectiveDateBefore | date |
Data wejścia w życie lub przed |
|
|
Data wejścia w życie po
|
effectiveDateAfter | date |
Data wejścia w życie po |
|
|
Thru Date On lub Before
|
thruDateBefore | date |
Data 1 dnia lub wcześniej |
|
|
Data po
|
thruDateAfter | date |
Data po |
|
|
Sortuj wg
|
sortBy | string |
Nazwa właściwości do sortowania według |
|
|
Sortuj malejąco
|
sortDesc | boolean |
Jeśli kolejność sortowania powinna być malejąca (wartość domyślna to rosnąco) |
Zwraca
- Body
- ActivityListDTO
Znajdowanie kontaktów
Znajduje rekordy kontaktów iMIS według różnych kryteriów. Większość pól wyszukiwania obsługuje filtry wyszukiwania, takie jak "startsWith:x" lub "contains:x". Zapoznaj się z dokumentacją, aby uzyskać pełną listę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Imię
|
firstName | string |
Imię osoby kontaktowej (obsługuje filtry) |
|
|
Nazwisko
|
lastName | string |
Nazwisko kontaktu (obsługuje filtry) |
|
|
Pełna nazwa
|
fullName | string |
Pełna nazwa kontaktu (obsługuje filtry) |
|
|
Podstawowy adres e-mail
|
string |
Podstawowy adres e-mail kontaktu (obsługuje filtry) |
||
|
Kod typu elementu członkowskiego
|
memberType | string |
Kod typu elementu członkowskiego kontaktu (obsługuje filtry) |
|
|
Nazwa firmy
|
organization | string |
Nazwa organizacji kontaktu (obsługuje filtry) |
|
|
Filtrowanie typów rekordów
|
recordType | string |
Filtrowanie typów rekordów (osób, organizacji) |
|
|
Filtruj usunięty stan
|
deleteType | string |
Stan usunięcia filtru (oznaczony do usunięcia) |
Zwraca
- Body
- ContactListDTO
Znajdowanie rekordów panelu
Znajduje rekordy panelu iMIS według różnych kryteriów. Większość pól wyszukiwania obsługuje filtry wyszukiwania, takie jak "startsWith:x" lub "contains:x". Zapoznaj się z dokumentacją, aby uzyskać pełną listę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa panelu
|
panelNameFindPost | string |
Nazwa panelu do wykonywania zapytania. |
|
|
body
|
body | dynamic |
Schemat wygenerowany przez getPanelSchema. |
Zwraca
Wyzwalacze
| Po dodaniu działania |
Po dodaniu działania |
| Po dodaniu zamówienia |
Po dodaniu zamówienia |
Po dodaniu działania
Po dodaniu zamówienia
Definicje
ActivityDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kody akcji
|
actionCodes | string | |
|
Typ działania
|
activityType | string | |
|
Kwota
|
amount | double | |
|
Sekwencja załączników
|
attachSeqn | integer | |
|
Suma załącznika
|
attachTotal | double | |
|
Numer partii
|
batchNum | string | |
|
Kod kampanii
|
campaignCode | string | |
|
Kategoria
|
category | string | |
|
Identyfikator współtworzenia
|
coId | string | |
|
Description
|
description | string | |
|
Data wejścia w życie
|
effectiveDate | date | |
|
Ulgowe
|
gracePeriod | integer | |
|
Identyfikator usługi iMIS
|
id | string | |
|
Intencja edycji
|
intentToEdit | string | |
|
Kod pamięci/hołdu
|
memTribCode | string | |
|
Typ elementu członkowskiego
|
memberType | string | |
|
Następna data instalacji
|
nextInstallDate | date | |
|
Uwaga / Notatka
|
note | string | |
|
Uwaga 2
|
note2 | string | |
|
Object
|
object | string | |
|
Kod organizacji
|
orgCode | string | |
|
Numer trans źródłowy
|
originatingTransNum | integer | |
|
Inny kod
|
otherCode | string | |
|
Inny identyfikator
|
otherId | string | |
|
Metoda płatności
|
payMethod | string | |
|
Kod produktu
|
productCode | string | |
|
Ilość
|
quantity | double | |
|
Żądanie cykliczne
|
recurringRequest | boolean | |
|
Identyfikator adwokata
|
solicitorId | string | |
|
Kod źródłowy
|
sourceCode | string | |
|
System źródłowy
|
sourceSystem | string | |
|
Kod stanu
|
statusCode | string | |
|
Wartość podatna na opodatkowanie
|
taxableValue | double | |
|
Data przepusty
|
thruDate | date | |
|
Data znacznika
|
ticklerDate | date | |
|
Data transakcji
|
transactionDate | date | |
|
UF1
|
uF1 | string |
Pole użytkownika 1 (ciąg) |
|
UF2
|
uF2 | string |
Pole użytkownika 2 (ciąg) |
|
UF3
|
uF3 | string |
Pole użytkownika 3 (ciąg) |
|
UF4
|
uF4 | double |
Pole użytkownika 4 (dziesiętne) |
|
UF5
|
uF5 | double |
Pole użytkownika 5 (dziesiętne) |
|
UF6
|
uF6 | date |
Pole użytkownika 6 (data) |
|
UF7
|
uF7 | date |
Pole użytkownika 7 (data) |
|
Units
|
units | double | |
|
Kolejność
|
seqn | integer |
Wartość sekwencji działania (klucz podstawowy) |
ActivityListDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Lista działań
|
value | array of ActivityDTO |
Lista rekordów działań |
AddressDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator adresu
|
addressId | string |
Unikatowy identyfikator dla tego rekordu adresu. |
|
Linie adresowe
|
addressLines | string |
Linie ulicy adresowej rozdzielone nową linią. |
|
Nazwa miasta
|
city | string |
Nazwa miasta na adresie. |
|
Kod stanu/prowincji
|
stateProvinceCode | string |
Skrócony kod stanu/prowincji. |
|
Kod pocztowy
|
postalCode | string |
Kod pocztowy lub pocztowy. |
|
Kod kraju
|
countryCode | string |
Skrócony kod kraju. |
|
Numer telefonu
|
phone | string |
Sformatowany numer telefonu dla tego adresu. |
|
Adres e-mail
|
string |
Adres e-mail dla tego adresu. |
|
|
Pełny adres
|
fullAddress | string |
Pełny obliczony adres z nowymi liniami. |
|
Nazwa i pełny adres
|
nameAndFullAddress | string |
Pełny obliczony adres z nazwą kontaktu w pierwszym wierszu. |
|
Cel adresu
|
addressPurpose | string |
Nazwa przeznaczenia adresu (kategoria). |
|
Lista preferencji komunikacji
|
communicationPreferences | array of string |
Lista typów preferencji komunikacji. |
AddressListDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Lista adresów
|
addresses | array of AddressDTO |
Lista obiektów adresowych dla określonego kontaktu |
ContactDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ kontaktu
|
contactType | string |
Typ kontaktu (organizacja lub osoba) |
|
Identyfikator usługi iMIS
|
id | string |
Identyfikator iMIS (nazywany również identyfikatorem kontaktu, identyfikatorem strony) |
|
Name
|
name | string |
Imię i nazwisko osoby obliczonej lub nazwa organizacji kontaktu |
|
Prefiks nazwy
|
namePrefix | string |
Prefiks nazwy kontaktu (np. "Pani"). |
|
Imię
|
firstName | string |
Imię kontaktu |
|
Nazwa nieformalna
|
informalName | string |
Nieformalna nazwa kontaktu (lub pseudonim) |
|
Drugie imię
|
middleName | string |
Imię i nazwisko osoby kontaktowej |
|
Nazwisko
|
lastName | string |
Nazwisko kontaktu |
|
Sufiks nazwy
|
nameSuffix | string |
Sufiks nazwy kontaktu (np. "Jr.") |
|
Tytuł funkcjonalny
|
functionalTitle | string |
Tytuł funkcjonalny kontaktu, w tym wszelkie oznaczenia |
|
Jest członkiem
|
isMember | boolean |
Flaga określająca, czy ten kontakt jest członkiem organizacji |
|
Jest aktywny
|
isActive | boolean |
Flaga określająca, czy ten kontakt jest oznaczony jako aktywny (tj. nieoznaczony do usunięcia, zmarły itp.) |
|
Nazwa organizacji
|
organizationName | string |
Nazwa organizacji, do którego należy ten kontakt |
|
Identyfikator organizacji
|
organizationId | string |
W przypadku typów osób określa identyfikator organizacji nadrzędnej, który jest połączony |
|
Email
|
string |
Podstawowy adres e-mail kontaktu |
|
|
Telefon służbowy
|
workPhone | string |
Numer telefonu służbowego kontaktu |
|
Telefon domowy
|
homePhone | string |
Numer telefonu domowego kontaktu |
|
Telefon komórkowy
|
mobilePhone | string |
Numer telefonu komórkowego kontaktu |
|
Faks
|
fax | string |
Numer faksu kontaktu |
|
Gender
|
gender | string |
Kod płci kontaktu (np. "M", "F" lub inne zdefiniowane kody) |
|
Typ elementu członkowskiego
|
memberType | string |
Kod typu elementu członkowskiego kontaktu (np. "NM" lub "WEB") |
|
Kategoria rozliczeń
|
billingCategory | string |
Nazwa kategorii rozliczeń kontaktu |
|
Klucz główny
|
majorKey | string |
Główne pole klucza kontaktu |
|
Status
|
status | string |
Kod stanu kontaktu (np. "A", "D", "X") |
|
Klucz kontaktu
|
contactKey | string |
Klucz kontaktu, czasami określany jako "Identyfikator sieci" (identyfikator guid) |
|
Data urodzenia
|
birthDate | date |
Data urodzenia kontaktu |
|
Data dołączenia
|
joinDate | date |
Data dołączenia kontaktu |
|
Płatne przez
|
paidThruDate | date |
Członkostwo osoby kontaktowej wypłacane przez datę (jeśli członek) |
|
Odnawiane przez
|
renewedThruDate | date |
Data odnowienia kontaktu |
ContactListDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Lista kontaktów
|
value | array of ContactDTO |
Lista rekordów kontaktów |
ContactPictureDTO
Reprezentuje obraz profilu kontaktu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator usługi iMIS
|
id | string |
Identyfikator iMIS skojarzony z tym obrazem |
|
Dane obrazu
|
pictureData | byte |
Dane obrazu |
OrderDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wysyłka do wiersza 1
|
address1 | string | |
|
Wysyłka do wiersza 2
|
address2 | string | |
|
Wysyłka do wiersza 3
|
address3 | string | |
|
Kod formatu wysyłki do adresu
|
addressFormat | integer | |
|
Kwota salda
|
balance | double | |
|
Numer partii
|
batchNumber | string | |
|
Identyfikator rachunku za usługę iMIS
|
billToId | string | |
|
Miasto wysyłki
|
city | string | |
|
Identyfikator iMIS firmy
|
companyId | string | |
|
Typ członka firmy
|
companyMemberType | string | |
|
Nazwa firmy
|
company | string | |
|
Kod sortowania firmy
|
companySort | string | |
|
Wysyłka do kraju
|
country | string | |
|
Dokumentacja klienta
|
customerReference | string | |
|
Wyślij na adres e-mail
|
string | ||
|
Kwota frachtu 1
|
freight1 | double | |
|
Ilość frachtu 2
|
freight2 | double | |
|
Wysyłka na pełny adres
|
fullAddress | string | |
|
Wyślij do pełnej nazwy
|
fullName | string | |
|
Obsługa 1 kwoty
|
handling1 | double | |
|
Obsługa 2 Kwoty
|
handling2 | double | |
|
Kod blokady
|
holdCode | string | |
|
Wstrzymaj komentarz
|
holdComment | string | |
|
Czy odbywa się?
|
holdFlag | boolean | |
|
Numer referencyjny faktury
|
invoiceReferenceNumber | integer | |
|
Typ wysyłki do elementu członkowskiego
|
memberType | string | |
|
Notatki o zamówieniach
|
notes | string | |
|
Data zamówienia
|
orderDate | date | |
|
Numer zamówienia
|
orderNumber | double | |
|
Kod typu zamówienia
|
orderTypeCode | string | |
|
Kod jednostki
|
entityCode | string | |
|
Typ płatności
|
payType | string | |
|
Wysyłka na telefon
|
phone | string | |
|
Kod źródłowy
|
sourceCode | string | |
|
Wysyłanie do identyfikatora iMIS
|
shipToId | string | |
|
Etap zamówienia
|
stage | string | |
|
Wysyłka do stanu/prowincji
|
stateProvince | string | |
|
Stan zamówienia
|
status | string | |
|
Kwota podatku 1
|
tax1 | double | |
|
Kwota podatku 2
|
tax2 | double | |
|
Kwota podatku 3
|
tax3 | double | |
|
Stawka podatku 1
|
taxRate1 | double | |
|
Stawka podatku 2
|
taxRate2 | double | |
|
Stawka podatku 3
|
taxRate3 | double | |
|
Tytuł zamówienia
|
title | string | |
|
Łączne opłaty za zamówienie
|
totalCharges | double | |
|
Order Total Payments
|
totalPayments | double | |
|
Łączna liczba zamówień wstecznych
|
totalQuantityBackordered | integer | |
|
Łączna ilość zamówiona
|
totalQuantityOrdered | integer | |
|
Wysyłka do kodu pocztowego
|
zip | string | |
|
System źródłowy
|
sourceSystem | string | |
|
Kod rabatu
|
discountCode | string | |
|
Kod podatku VAT
|
vatTaxCodeFh | string | |
|
Suma niezliczona
|
undiscountedTotal | double | |
|
Kod terminów
|
termsCode | string | |
|
Stawka podatkowa
|
taxRateFh | double | |
|
Autor podatku 1
|
taxAuthor1 | string | |
|
Tax 2 Author
|
taxAuthor2 | string | |
|
Tax 3 Author
|
taxAuthor3 | string | |
|
Zwolnienie z podatku
|
taxExempt | string | |
|
Wpływa na spis?
|
affectInventory | boolean | |
|
Kwota podatku towarowego
|
freightTax | double | |
|
Obsługa kwoty podatku
|
handlingTax | double | |
|
Data faktury
|
invoiceDate | date | |
|
Numer faktury
|
invoiceNumber | integer | |
|
Łączna kwota wiersza
|
lineTotal | double | |
|
Metoda wysyłki
|
shipMethod | string | |
|
Data wysyłki dokumentów
|
shipPapersDateTime | date | |
|
Data wysłania
|
shippedDateTime | date | |
|
Łączna waga
|
totalWeight | double | |
|
Wprowadzone przez
|
enteredBy | string | |
|
Wprowadzona data/godzina
|
enteredDateTime | date |
OrderListDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Lista zamówień
|
value | array of OrderDTO |
Lista rekordów zamówień |