Help

Kontaktirajapinta

Kontakti-rajapinnan resurssit

Kontakti-rajapinnan kautta voidaan lukea kaikki tai yksittäinen kontakti sekä lisätä uusia kontakteja ja päivittää olemassa olevien kontaktien tietoja.

Kontakti-rajapinnan resurssien osoitteet 

Osoite on muotoa:

https://psa.valueframe.com/rest/v2/{REST_resurssi}/

 REST-resurssien osoitteet ovat seuraavat:

REST-resurssi GET PUT POST DELETE KUVAUS
contact x    x   GET: palauttaa kaikki kontaktit


POST: lisää uuden kontaktin
contact/ID x  x     GET: palauttaa kontaktin id=ID


PUT: kontaktin id=ID tietojen päivitys

KONTAKTI-RAJAPINNAN RESURSSIT KUVAUKSINEEN

contact-resurssi

Kontakteihin liittyvät tiedot

Kentän nimi Tyyppi Kuvaus
id INTEGER Kontaktin uniikki id
firstName STRING Kontaktin etunimi
surName STRING Kontaktin sukunimi
title STRING Kontaktin titteli
emailAddress1 STRING Kontaktin 1 sähköpostiosoite
emailAddress2 STRING Kontaktin 2 sähköpostiosoite
streetAddress STRING Kontaktin osoite, katu
streetPostalCode STRING Kontaktin osoite, postinumero
streetCity STRING Kontaktin osoite, kaupunki
streetCountry STRING Kontaktin osoite, maa
phoneCountryCode STRING Kontakin lankanumero, maakoodi
phoneAreaCode STRING Kontakin lankanumero, suuntanumero
phoneNumber STRING Kontaktin lankanumero, numero
mobilePhoneCountryCode STRING Kontaktin kännykkänumero, maakoodi
mobilePhoneAreaCode STRING Kontaktin kännykkänumero, suuntanumero
mobilePhoneNumber STRING Kontaktin kännykkänumero, numero
faxCountryCode STRING Kontaktin faksinumero, maakoodi
faxAreaCode STRING Kontaktin faksinumero, suuntanumero
faxNumber STRING Kontaktin faksinumero, numero
isMarketingBlocked STRING Markkinointi kielletty
isEmailMarketingBlocked STRING Sähköpostimarkkinointi kielletty
addedDateTime STRING (ISO8601) Päivämäärä kun kontakti on lisätty järjestelmään
addedById INTEGER Kontaktin järjestelmään lisänneen henkilön ID
modifiedDateTime STRING (ISO8601) Päivämäärä kun kontaktin tietoja on viimeksi muokattu
modifiedById INTEGER

Kontaktia tietoja päivittäneen henkilön ID

isPassive BOOLEAN Kontakti on passiivinen
comments STRING Kommentti
integrationText1 STRING Integraatioita varten vapaatekstikenttä.
integrationInt1 INTEGER Integraatioita varten kokonaislukukenttä.
integrationDate1 STRING (ISO8601) Integraatioita varten päivämääräkenttä.
accounts OBJECT Kontaktin asiakasliitokset, kts. contact/accounts -resurssi.

 

contact/accounts -resurssi

Kentän nimi Tyyppi Kuvaus
id INTEGER Asiakkaan ID
name STRING Asiakkaan nimi
primaryAccount STRING

1 = Kontaktin oletusliitos

0 = Muu asiakasliitos

roleId INTEGER

Kontakti rooli asiakkuuteen:

0 = oletus (työsuhde)

roleName STRING Roolin nimi