API: addUserToOrg

API: addUserToOrg

Genom funktionen addUserToOrg är det möjligt att lägga till nya
individer i adressboken och i eventuellt medlemsregister.

Försök görs att identifiera bfintliga individer via kombinationen förnamn, efternamn och e-postadress.
Alternativt via endast personnummer eller medlemsnummer.

Identifiering kan även ske genom endast ID-kortnummer (kortnummer) inom organisationen.
Kortnummer kan med fördel läsas
via exempelvis en streckkodsläsare. Som kortnummer kan även personnumret anges eftersom streckkoden på
exempelvis vanliga körkort innehåller personnumret.

Tänk på att variablernas värden alltid måste URL-kodas om de skall
skickas i URL:en. Det spelar däremot ingen roll om ni i variabelnamnen
eller variabelvärdena använder små eller stora
bokstäver. Eventuella mellanslag i varibelnamnen kommer också att ignoreras.
Exempelvis tolkas Last+Name=Von+Anka identiskt med lastname=von+anka.

Exempel på anrop:
https://minaaktiviteter.se/xml/?type=addUserToOrg&org=ma&pw=&ifOldDataExists=skipNewData&firstName=Kalle&lastName=Testperson&email=kalle.anka%40cogwork.se&cardNumber=testnummer

Variabelnamn Innehåll/värden

Obligatoriska fält

type Alltid addUserToOrg
org Organisationens id eller kod
pw Organisationens lösenord (se organisationsinställningarna)

Hantering av befintliga personuppgifter

ifOldDataExists skipNewData (standardvärde), prioritizeOld, prioritizeNew
Vad som skall ske om individen finns sparas sedan tidigare

Identifiering och födelsedata

localUserRef Eget numeriskt referensnummer. Endast ett unikt nummer inom
organisationen per
individ.
Anges med fördel för enklare identifiering vid upprepad import
mshipNumber Eget numeriskt eller alfanumeriskt medlemsnummer. Om medlemsnumrets ändrats
så kan äldre nummer sparas tillsammans med medlemskapen för ett
specifika medlemsår
cardNumber Alpfanumeriskt fält. Flera värden kan sparas flera på samma
individ. Kan med fördel användas för att referera till
information från ett externt register/databas om risken finns
att det externa registret innehåller duplikat.
pid Personnummer. Alla vanliga format accepteras
gender Kön. Överflödigt om personnr anges
dateOfBirth Födelsedatum. Flertalet datumformat accepteras, t.ex. ÅÅÅÅ-MM-DD
Även 0000-MM-DD mm kan användas om viss information saknas.
Överflödigt om personnr anges

Namnfält

firstName Individens förnamn. Bör anges
lastName Individens efternamn. Bör anges
nickname Alldagligt namn/smeknamn, t ex Kalle istället för Carl
fullName Fullständigt namn inklusive mellannamn mm
birthname Dopnamn, dvs namn innan eventuellt namnbyte

Användarkonto

sendEmail I vilken omfattning individen önskar e-post från den egna organisationen. Möjliga värden är minimal, restrictively och yes.

E-postadresser och telefon

email E-postadress. Bör anges
email2 Alternativ e-post
email3 Alternativ e-post
telephonehome Flertalet vanliga format accepteras, t ex 0123-456 78
telephonework  
telephonemobile  

Bostadadress

careof Eventuell c/o-adress (inneboende). Skrivs utan inledande c/o
streetaddr Gatuadress
zipcode Postnummer,  tex 123 45 eller SE12345
cityName Postort, t ex Stockholm
country Land. Om inget anges antas Sverige.
Flertalet format accepteras, t ex svenskt namn, engelst namn,
inhemskt namn samt två och treställig ISO-kod.

Registrering av medlemskap

mshipPeriod Nödvändigt och tillräckligt fält för att registrera ett
medlemskap på individen. Värdet kan vara ”auto”, ”current” eller
medlemsperiodens namn, exempelvis ”2013”, ”Våren 2013” eller
”13/14”. Olika periodnamn och datumgränser definieras i
organisationsinställningarna.
mshipType Frivilligt. Kan vara exmepelvis ”N”, ”FP”, ”F”, ”U”, ”B”,
”S”, ”P” vilka står för normalt medlemskap (fullbetalande), familjemedlem
primär (betalt familjemedlemskap), familjemedlem medföljande (ej
betalat), ungdomsmedlem, barnmedlem,
studerandemedlemskap samt pensionärsmedlemskap.
mshipPaidDate Frivilligt. Vilket datum medlemskapet betalades
mshipStatus Frivilligt. Kan vara ”pending”, ”passive” eller ”active”
mshipNote Frivilligt. En notering som sparas tillsammans med
medlemskapet

Alternativa inmatningsformat. Undvik om möjligt

name För och efternamn i samma fält
address Hela adressen i ett fält

Ytterligare åtgärder

sendLoginKey E-postar en inloggningsnyckel till användaren. Ange värdet ”1” om detta skall göras.
Skickas med fördel tillsammans med endast förnamn, efternamn och
e-post för att låta nya användare registrera konton.
returnUrl Skickar tillbaka användaren till angiven url efter att
inloggningsnyckeln använts för att registrera en ny användare.
Variablerna userId=&email=firstName=&lastName= adderas
automatiskt till url:en. Ni kan själva med fördel addera en
engångsnyckel som låter användaren bli direktinloggad då den
kommer tillbaka till er webbplats, typ ErEgenWebbplats/?returnKey=qwerty.