BEMS Contact Service API Reference Brugervejledning

Kontakt Service API
Reference
december 2022

Hvad er BEMS Contact Service API?

Contact Service API giver tredjeparts BlackBerry Dynamics-apps mulighed for at forespørge, hente, oprette og opdatere kontaktoplysninger fra en brugers kontaktmappe og eventuelle mapper og undermapper, som brugeren opretter i kontaktmappen i deres postkasse. F.eksample, kan du bruge API'et til at gøre følgende:

• Opret nye kontakter
• Opret mapper og undermapper under kontaktmappen
• Hent den komplette liste over kontakter fra kontaktmappen
• Hent kontakter fra en bestemt mappe eller undermappe
• Hent en enkelt kontakt
• Hent de nye og ændrede kontakter siden en bestemt dato
• Opdater eksisterende kontaktoplysninger

Anmod om, opret og opdater format

Du skal angive BEMS-slutpunktet i API'en. Slutpunktet angiver, hvor objektadressen er placeret.

Slutpunkt: :8443/api/contact
Formatet for HTTP-anmodningen om at hente kontaktoplysninger fra en postkasse i BEMS er:
STOLPE :8443/api/contact


Formatet for HTTP-anmodningen om at oprette en kontakt i en postkasse i BEMS er:
STOLPE :8443/api/contact/create


Formatet for HTTP-anmodningen om at opdatere en kontakt i en postkasse i BEMS er:
STOLPE :8443/api/contact/update


Formatet for HTTP-anmodningen om at oprette yderligere mapper og undermapper under kontaktmappen i en
postkasse i BEMS er:
STOLPE :8443/api/folder/create


Formatet for HTTP-anmodningen om at få alle mapper og undermapper under kontaktmappen i en postkasse i BEMS er:
STOLPE :8443/api/folder/get


Følgende er somampoverskriften:
Indholdstype: application/json
X-Good-GD-AuthToken:
Anmoder om kontaktlisteoplysninger
Tredjeparts BlackBerry Dynamics-apps kan hente de kontaktoplysninger, der blev tilføjet inden for en periode, som du angiver, en specificeret kontaktperson eller kontaktlisten fra en brugers kontaktmappe i deres postkasse.
Henter egenskaber for kontaktlisteoplysninger
Følgende tabel beskriver egenskaberne for anmodningstekst, som du kan inkludere i den JSON-formaterede anmodning, når du henter kontaktlisteoplysninger fra en brugers mappe i postkassen.

API-svar
Følgende tabel beskriver de svaregenskaber, der kan vises i det JSON-formaterede API-svar, når du henter kontakter fra brugerens lokale kontaktliste.

Anmod om kontakter

Du kan hente kontakter fra en brugers hovedkontaktmappe og fra undermapper, som brugeren har oprettet.
Slettede kontakter returneres ikke. Hvis FolderId ikke er angivet af klienten i anmodningen, hentes kontakter fra hovedmappen.
I de følgende sample, BEMS henter alle kontakter til brugeren, Jamie01, undtagen eventuelle slettede kontakter, fra den specifikke undermappe. Det første svar fra BEMS inkluderer op til 100 kontakter, som specificeret af MaxNumber. Hver kontakt, der hentes, inkluderer de grundlæggende grundlæggende egenskaber, der er angivet i BEMS.
Hvis mere end 100 kontakter er tilgængelige (f.eksampDenne postkasse indeholder et TotalCount på 150 kontakter) svaret inkluderer en MoreAvailable er sand, så klientapplikationen sender yderligere anmodninger ved hjælp af NextOffset-værdien for at hente kontakter i batches, indtil MoreAvailable er falsk. I dette example, returnerer de grundlæggende egenskaber følgende oplysninger for kontakterne:

• Vist navn
• E-mailadresse
• Fornavn
• Efternavn

I det følgende example, giver klienten et FolderId og BEMS henter kontakterne fra den specifikke mappe.Hvis anmodningen lykkes, returnerer BEMS de første 100 kontakter, der opfylder forespørgselskriterierne. BEMS returnerer også en TotalCount af kontakter og NextPageOffset for at hente den næste batch af kontakter.Klienten indstiller Offset til NextPageOffset fra den forrige forespørgsel for at modtage den næste batch.
BEMS returnerer de næste 50 kontakter for i alt 150 kontakter. Ingen yderligere kontakter er tilgængelige.Anmod om kontakter ved hjælp af en e-mailadresse og forudindstillede egenskaber
Du kan hente kontakter fra en brugers kontaktmappe eller mapper og undermapper, som brugeren har oprettet i postkassen ved hjælp af flere egenskaber (f.eks.ample, hent en bruger baseret på deres e-mailadresse og medtag de forudindstillede detaljeegenskaber for kontakten). I dette example, svaret inkluderer én kontakt, og MoreAvailable er falsk. Hvis mere end 512 kontakter identificeres, indikerer svaret, at MoreAvailable er sandt, og klienten sender yderligere anmodninger om at hente kontakter i batches, indtil MoreAvailable er falsk. Hvis klienten giver et FolderId, henter BEMS kontakterne fra den specifikke mappe.Hvis anmodningen lykkes, returnerer BEMS følgende svar, og tredjeparts BlackBerry Dynamics-apps viser følgende oplysninger for kontakter med e-mailadressen jane_doe@example.com. Hvis en egenskab ikke er tilgængelig, returnerer BEMS en nulværdi, og oplysningerne er ikke inkluderet i svaret. I dette example, følgende oplysninger vises for Jane Doe:

• Vist navn
• Givet navn
• Efternavn
• Fulde navn
• Emailadresse

Anmod om kontaktlisteoplysninger ved hjælp af en bestemt ejendom
Du kan anmode om brugerens kontaktoplysninger for kontakter, der returnerer specifikke egenskaber (f.eksample, kun fornavnet på kontakterne). I de følgende sampI koden anmoder BEMS om fornavnet på alle kontakter i brugerens kontaktmappe. Svaret omfatter op til 50 kontakter. Hvis klienten angiver et FolderId, anmoder BEMS om kontakterne fra den specifikke mappe.Hvis anmodningen lykkes, returnerer BEMS følgende svar, og tredjeparts BlackBerry Dynamics-apps viser fornavnet på kontakterne.

Oprettelse og anmodning om mappe- og undermappeoplysninger

Tredjeparts BlackBerry Dynamics-apps kan hente mappe- og undermappeoplysninger, som brugeren har oprettet i deres kontaktmappe. Undermapper kan også oprettes i en bestemt mappe.
Oprettelse og opdatering af mappeparametre
Følgende tabel beskriver egenskaberne for anmodningstekst, som du kan inkludere i den JSON-formaterede anmodning, når du opretter en mappe eller undermappe i kontaktmappen i en brugers postkasse.

Opret en mappe eller undermappe
Du kan oprette mapper og undermapper i brugerens kontaktmappe. ParentFolderId er valgfrit. Når den ikke leveres, og der oprettes en mappe, vises mappen i brugerens kontaktmappe. I de følgende sampI koden oprettes mappen kaldet "Support folder" som en undermappe i det angivne ParentFolderId. Hvis anmodningen lykkes, returnerer BEMS en 201 HTTP-svarkode, hvor kontaktmappen er oprettet.
Hvis der findes en mappe med samme navn i den overordnede mappe, returnerer BEMS en 200 HTTP-svarkode, og mappen gemmes ikke.Anmod om alle mapper og undermapper under kontaktmappen
Du kan hente alle mapper og undermapper, som brugeren har oprettet i en brugers kontaktmappe. I de følgende sampkoden henter BEMS alle mapper, som brugeren har oprettet.Hvis anmodningen lykkes, returnerer BEMS følgende svar, og tredjeparts BlackBerry Dynamics-apps viser den hentede mappe.

Tilføjelse af kontaktoplysninger

Tredjeparts BlackBerry Dynamics-apps kan oprette og opdatere kontaktoplysningerne i en brugers kontaktmappe eller mapper og undermapper, som brugeren har oprettet i sin postkasse.
Egenskaber, der bruges ved oprettelse af en kontakt
Den følgende liste viser de understøttede kropsegenskaber, som du kan inkludere i den JSON-formaterede anmodning, når du opretter en kontakt i en brugers mappe i postkassen. Enhver værdi, som er null eller tom i forespørgselsteksten, gemmes ikke i kontakten.
Hvis brugeren opdaterer en eksisterende kontakt, sendes alle værdier for anmodningen, uanset om de ændres eller ej, til BEMS. Følgende værdier kan angives, når du opretter en kontakt:

• Kontakte
  • Fornavn
  • Mellemnavn
  • Efternavn
  • Mobiltelefon
  • Hjemmetelefon
  • Hjemmetelefon2
  • Hjemmefax
  • Anden fax
  • E-mailadresse1
  • E-mailadresse2
  • E-mailadresse3
  • Arbejdstelefon
  • Virksomhedstelefon2
  • Biltelefon
  • CompanyMainPhone
  • ISDN
  • Ring tilbage
  • Radiotelefon
  • Primær Telefon
  • Assistenttelefon
  • Telex
  • TtyTddPhone
• Hjemmeadresse
  • Gade
  • By
  • Stat
  • Land
  • Postnummer
• Arbejde
  • Virksomhed
  • Jobtitel
  • Afdeling
  • Kontor
  • Manager
  • Assistent
• Virksomhedsadresse
  • Gade
  • By
  • Stat
  • Land
  • Postnummer

Opret en kontakt ved hjælp af en bestemt ejendom
Du kan oprette en kontakt ved hjælp af specifikke egenskaber. I de følgende sampkoden opretter BEMS kontakten i brugerens kontaktmappe. Hvis et ParentFolderId er inkluderet, oprettes kontakten i den angivne mappe.
I dette example, brugeren opretter en kontakt ved hjælp af følgende oplysninger for kontakten:

• Fornavn
• Efternavn
• Mellemnavn
• Mobiltelefon
• Hjemmetelefon
• Arbejdstelefon
• E-mailadresse
• Firmanavn

Hvis kontakten oprettes, returnerer BEMS et unikt id, og tredjeparts BlackBerry Dynamics-apps viser de angivne kontaktoplysninger. Hvis en egenskab ikke er angivet, returnerer BEMS en nulværdi, og oplysningerne gemmes ikke i kontakten.

Opdater en kontakts listeoplysninger

Du kan opdatere oplysninger for en kontakt ved hjælp af specifikke egenskaber. I de følgende sample kode, opdaterer BEMS kontaktoplysningerne for NewContact Last i brugerens kontaktmappe. Klienten sender UniqueID for kontakten at opdatere. Når en kontakt er opdateret, sender klienten alle værdierne for kontakten til BEMS, uanset om værdierne blev ændret eller ej. Hvis klienten angiver et ParentFolderID, opdaterer BEMS kontakten i den angivne mappe.
I dette example, kontakten er opdateret med deres arbejdsoplysninger. De nye og eksisterende oplysninger sendes til BEMS til opdatering.

• Jobtitel
• Afdeling
• Mellemnavn
• Mobiltelefon
• Hjemmetelefon
• Arbejdstelefon
• E-mailadresse
• Firmanavn

Hvis anmodningen lykkes, returnerer BEMS en 200 HTTP-svarkode, som kontaktpersonen er opdateret.

Appendiks: Konfigurer UserShape-egenskaberne

FORSIGTIGHED: Rediger ikke UserShape-egenskaberne, medmindre ændringerne er nødvendige. Ændrede indstillinger bevares ikke, når du opgraderer BEMS-softwaren.
Følgende værdier kan angives for UserShape-egenskaberne. Andre værdier ignoreres.

1. Åbn en browser og gå til Apache Karaf Web Konsolkonfiguration webwebsted placeret på https:// :8443/system/console/configMgr og log på som administrator med de relevante Microsoft Active Directory-legitimationsoplysninger.
2. Klik på OSGi > Konfiguration i menuen.
3. Søg efter and click Directory Lookup Common Configuration.
4. I feltet basicPropertyNames er de grundlæggende egenskabsværdier angivet.
   Klik på knappen + og ejendommens navn for at tilføje en fælles ejendom til listen, eller klik på knappen – for at fjerne en fælles ejendom fra listen.
5. I feltet detailedPropertyNames er de detaljerede egenskabsværdinavne for almindelige ejendomsnavne angivet.
   Klik på knappen + og ejendommen for at tilføje en fælles ejendom til listen, eller klik på knappen – for at fjerne en fælles ejendom fra listen.
6. Klik på Gem.

Juridisk meddelelse
©2023 BlackBerry Limited. Varemærker, herunder men ikke begrænset til BLACKBERRY, BBM, BES, EMBLEM Design, ATHOC, CYLANCE og SECUSMART er varemærker eller registrerede varemærker tilhørende BlackBerry Limited, dets datterselskaber og/eller tilknyttede selskaber, brugt under licens, og de eksklusive rettigheder til sådanne varemærker er udtrykkeligt forbeholdt. Alle andre varemærker tilhører deres respektive ejere.
Patenter, hvor det er relevant, identificeret på: www.blackberry.com/patents.
Denne dokumentation, herunder al dokumentation, der er inkorporeret ved reference heri, såsom dokumentation leveret eller gjort tilgængelig på BlackBerry webwebsted leveret eller gjort tilgængeligt "SOM DEN ER" og "SOM TILGÆNGELIG" og uden betingelser, påtegning, garanti, repræsentation eller garanti af nogen art af BlackBerry Limited og dets tilknyttede virksomheder ("BlackBerry"), og BlackBerry påtager sig intet ansvar for eventuelle typografiske, tekniske eller andre unøjagtigheder, fejl eller udeladelser i denne dokumentation. For at beskytte BlackBerrys proprietære og fortrolige oplysninger og/eller forretningshemmeligheder kan denne dokumentation beskrive nogle aspekter af BlackBerry-teknologi i generelle vendinger. BlackBerry forbeholder sig retten til med jævne mellemrum at ændre oplysninger, der er indeholdt i denne dokumentation; BlackBerry forpligter sig dog ikke til at levere sådanne ændringer, opdateringer, forbedringer eller andre tilføjelser til denne dokumentation til dig rettidigt eller overhovedet. Denne dokumentation kan indeholde referencer til tredjepartskilder til information, hardware eller software, produkter eller tjenester, herunder komponenter og indhold, såsom indhold beskyttet af ophavsret og/eller tredjepart webwebsteder (samlet "tredjepartsprodukter og -tjenester"). BlackBerry kontrollerer ikke og er ikke ansvarlig for nogen tredjepartsprodukter og -tjenester, herunder uden begrænsning indhold, nøjagtighed, overholdelse af copyright, kompatibilitet, ydeevne, troværdighed, lovlighed, anstændighed, links eller ethvert andet aspekt af tredjepartsprodukter og Tjenester. Inkluderingen af ​​en henvisning til tredjepartsprodukter og -tjenester i denne dokumentation indebærer ikke BlackBerrys godkendelse af tredjepartsprodukterne og -tjenesterne eller tredjeparten på nogen måde.
UNDTAGET I DET OMFANG DET SPECIFIKKELT FORBUDT I HENHOLD TIL GÆLDENDE LOV I DIN JURISDIKTION, INDEHOLDER ALLE BETINGELSER, GODKENDELSER, GARANTIER, REPRÆSENTATIONER ELLER GARANTIER AF ENHVER ART, UDTRYKKELIGE ELLER UNDERFORSTÅEDE, HERUNDER EN BETINGELSER ANBEFALINGER, GARANTIER, REPRÆSENTATIONER ELLER GARANTIER OM HOLDBARHED, EGNETHED TIL ET BESTEMT FORMÅL ELLER BRUG, SALGBARHED, SALGBAR KVALITET, IKKE-KRÆNKELSE, TILFREDSSTILLENDE KVALITET, ELLER KVALITET, ELLER KVALITET. HANDLINGSFORLØB ELLER BRUG AF HANDEL, ELLER I RELATERET TIL DOKUMENTATIONEN ELLER DENS BRUG, ELLER YDELSE ELLER MANGLENDE YDELSE AF NOGEN SOFTWARE, HARDWARE, SERVICE ELLER TREDJEPARTSPRODUKTER OG TJENESTER, DER OMREJSER HER HER. DU HAR MÅSKE OGSÅ ANDRE RETTIGHEDER, DER VARIERER EFTER STAT ELLER PROVINS. NOGLE JURISDIKTIONER TILLADER MULIGVIS IKKE UDELUKKELSE ELLER BEGRÆNSNING AF UNDERFORSTÅEDE GARANTIER OG BETINGELSER. I DET OMFANG LOVEN TILLADER, ER ENHVER UNDERFORSTÅET GARANTI ELLER BETINGELSER VEDRØRENDE DOKUMENTATIONEN I DET OMFANG DE IKKE KAN UDDELES SOM ANGIVET OVENFOR, MEN KAN BEGRÆNSES, BEGRÆNSES HERMED TIL 90 FRA DEN SIDSTE (XNUMX) ACCUATION DAGE ELLER DEN GENSTAND, DER ER GENSTAND FOR KRAVET.
I DET MAKSIMALE OMFANG DET ER TILLADET AF GÆLDENDE LOV I DIN JURISDIKTION, KAN BLACKBERRY UNDER INGEN OMSTÆNDIGHEDER VÆRE ANSVARLIG FOR NOGEN TYPE SKADER I FORBINDELSE MED DENNE DOKUMENTATION ELLER DENS BRUG, ELLER YDELSE ELLER MANGLENDE YDELSE, ELLER UDVIKLING AF EN SERVICE. FEST PRODUKTER OG TJENESTER, DER HENVISES HERI, HERUNDER UDEN BEGRÆNSNING NOGEN AF FØLGENDE SKADER: DIREKTE, FØLGESKADER, EKSEMPEL, TILFÆLDE, INDIREKTE, SÆRLIGE, STRAFFENDE ELLER FORVERREDE SKADER, SKADER, SKADER, SKADER FOR SKADER, SKADER. PECTED BESPARELSER, FORRETNINGSAFBRYDELSE, TAB AF VIRKSOMHEDSINFORMATION, TAB AF FORRETNINGSMULIGHEDER ELLER KORRUPTION ELLER TAB AF DATA, UNDERLAG I AT OVERFØRE ELLER MODTAGE NOGEN DATA, PROBLEMER SOM ER TILKNYTNING TIL ENHVER APPLIKATION, SOM BRUGERS I SAMMENSÆTNING MED PRODUKTET BLACKBERRY, USLO, BLACKBERRY, USLO AF BLACKBERRY-PRODUKTER ELLER TJENESTER ELLER ENHVER DEL HERAF ELLER ENHVER LUFTTIDSTJENESTER, UDGIFTER TIL ERSTATNINGSVARER, OMKOSTNINGER TIL DÆKNING, FACILITETER ELLER TJENESTER, KAPITALOMKOSTNINGER ELLER ANDRE LIGNENDE PUNKTISKE TAB, HVAD DER IKKE ER ELLER DÆKNING BLACKBERRY HAR VÆRET RÅDET OM MULIGHEDEN FOR
SÅDANE SKADER.
I DET MAKSIMALTE OMFANG, DET ER TILLADET AF GÆLDENDE LOV I DIN JURISDIKTION, HAR BLACKBERRY INGEN ANDEN FORPLIGTELSE, PLIGT ELLER ANSVAR I HENHOLD TIL KONTRAKT, TORT ELLER PÅ ANDEN MÅDE TIL DIG, INKLUSIVE EVENTUELLE ANSVARLIG ANSVAR FOR ANSVAR.
BEGRÆNSNINGERNE, EXKLUSIONERNE OG FRASKRIVELSESFRASKRIVELSERNE HERI SKAL GÆLDE: (A) UANSETT ARTEN AF ÅRSAGEN TIL HANDLING, KRAV ELLER HANDLING FRA DIG, INKLUSIVE MEN IKKE BEGRÆNSET TIL KONTRAKTBRUD, ANDRE Uagtsomhed, Uagtsomhed, Uagtsomhed, Uagtsomhed TEORI OG SKAL OVERLEVE ET GRUNDLÆGGENDE BRUD ELLER BRUD ELLER DEN VÆSENTLIGE FORMÅL MED DENNE AFTALE ELLER ENHVER RETSMIDDEL INDEHOLDT HERI; OG (B) TIL BLACKBERRY OG DETS TILKNYTTEDE VIRKSOMHEDER, DERES EFTERFØLGERE, OVERDRAGENDE, AGENTER, LEVERANDØRER (INKLUSIVE AIRTIME SERVICE LEVERANDØRER), AUTORISEREDE BLACKBERRY DISTRIBUTØRER (OGså AIRTIME SERVICE LEVERANDØRER) MEDARBEJDERE OG UAFHÆNGIGE ENTREPRENØRER.
UDOVER DE OVENSTÅENDE BEGRÆNSNINGER OG UDELUKKELSER, SKAL NOGEN DIREKTØR, MEDARBEJDER, AGENT, DISTRIBUTØR, LEVERANDØR, UAFHÆNGIG KONTRAKTØR AF BLACKBERRY ELLER NOGEN TILKNYTTEDE SELSKABER I BLACKBERRY CUROMITY ELLER TILKNYTTEDE BLACKBERRY-LIFESKABER HAVE NOGEN TILHØR. Før du abonnerer på, installerer eller bruger tredjepartsprodukter og -tjenester, er det dit ansvar at sikre, at din udbyder af taletidstjenester har accepteret at understøtte alle deres funktioner. Nogle sendetidsudbydere tilbyder muligvis ikke internetbrowsing-funktionalitet med et abonnement på BlackBerry Internet Service.
Spørg din tjenesteudbyder for tilgængelighed, roaming-arrangementer, serviceplaner og funktioner. Installation eller brug af tredjepartsprodukter og -tjenester med BlackBerrys produkter og tjenester kan kræve et eller flere patenter, varemærker, copyright eller andre licenser for at undgå krænkelse eller krænkelse af tredjeparts rettigheder. Du er eneansvarlig for at afgøre, om du vil bruge tredjepartsprodukter og -tjenester, og om der kræves tredjepartslicenser for at gøre det. Om nødvendigt er du ansvarlig for at anskaffe dem. Du bør ikke installere eller bruge tredjepartsprodukter og -tjenester, før alle nødvendige licenser er erhvervet. Alle tredjepartsprodukter og -tjenester, der leveres med BlackBerrys produkter og tjenester, leveres som en bekvemmelighed for dig og leveres "SOM DE ER" uden udtrykkelige eller underforståede betingelser, påtegninger, garantier, repræsentationer eller garantier af nogen art af BlackBerry og BlackBerry påtager sig intet ansvar i relation hertil. Din brug af tredjepartsprodukter og -tjenester er styret af og betinget af, at du accepterer vilkårene i separate licenser og andre aftaler, der gælder herfor med tredjeparter, undtagen i det omfang, der udtrykkeligt er dækket af en licens eller anden aftale med BlackBerry.
Vilkårene for brug af ethvert BlackBerry-produkt eller en hvilken som helst service er angivet i en separat licens eller anden aftale med BlackBerry, der gælder herfor. INTET I DENNE DOKUMENTATION ER TILSIGTET AT ERFARE NOGEN UDTRYKKELIG SKRIFTLIGE AFTALER ELLER GARANTIER LEVERET AF BLACKBERRY FOR DELE AF NOGEN BLACKBERRY PRODUKT ELLER TJENESTE ANDRE END DENNE DOKUMENTATION.
BlackBerry Enterprise Software inkorporerer visse tredjepartssoftware. Licens- og copyrightoplysningerne forbundet med denne software er tilgængelige på http://worldwide.blackberry.com/legal/thirdpartysoftware.jsp.

BlackBerry Limited
2200 University Avenue East
Waterloo, Ontario
Canada N2K 0A7
BlackBerry UK Limited
Stueetagen, Pearce-bygningen, West Street,
Maidenhead, Berkshire SL6 1RL
Storbritannien
Udgivet i Canada