Hämta individer

Använd users för att hämta informatiom om en eller flera individer.

Identifierning kan även ske genom endast 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.

Exempel på begäran av XML-fil

https://minaaktiviteter.se/xml/?type=users&pw=&name=Kalle+Testperson&email=kalle.anka@cogwork.se

Parametrar vid begäran av individer (users) via API

Parameter	Kommentar
type*	Alltid users
org*	Organisationens id eller kod
pw*	Organisationens lösenord (se organisationsinställningarna)

*) Obligatoriska parametrar

Valbara datafält som vanligtvis kan inkluderas i svaret eller exportfilen

Fältnamn	Standard	Fältkod	Kommentar
Grundläggande personuppgifter	?	Basic person data
Separera för- och efternamn	?	separatedNames	Visar för- och efternamn i separata kolumner
Kön	Ja	gender
Ålder	Ja	age
Född	Nej	dateOfBirth
Sista4	Nej	last4	Sista fyra siffrorna i det svenska personnumret
Personnr	Nej	pid	Personnummer
Adress- och kontaktuppgifter	?	Address and contact data
Gatuadress	Nej	streetaddr
Postnummer	Nej	zipcode
Ort	Ja	cityName
Land	Nej	country
E-post	Nej	email
E-post (separerade)	Nej	emailSeparated
E-poststatus	Nej	emailStatus	E-poststatus för den primära e-postadressen
Telefon, alla	Ja	telephoneAll	Telefonnummer: b=bostad, m=mobil, a=arbete
Mobiltelefon	Nej	telephonemobile
Hemtelefon	Nej	telephonehome	Telefonnummer till privatbostad
Arbetstelefon	Nej	telephonework	Telefonnummer till arbete
Sociala medier	Ja	socialMediaAccounts	Visa länkar till användarens publika Facebook- och Googleplus-sidor
Bankkonto	Nej	payToBankAccount	Till vilket bankkonto som individen vill få eventuella utbetalningar
Användarkonto och behörigheter	?	User account info
Användarnamn	Nej	username	Användarnamn för inloggning
Behörighet	Nej	userPriv	Grundläggande behörighet inom organisationen
Grupptillhörighet	Nej	userGroupMships
Bevakningar	Nej	subscriptions	Individens bevakningar av nytillkomna ärenden respektive alla ärenden
Systembehörighet	Nej	privGlobal	Global behörighet inom systemet som är oberoende av enskilda föreningskopplingar
Kopplingar	Ja	connections	Kopplingar och behörigheter inom olika organisationer
Föreslå org	Nej	derivedDefaultOrgId	Föreslår ny förvald organisation
Förvald organisation	Nej	defaultOrg
Medlemskap	?	Membership data
Presentationer och noteringar	?	Presentation and comments
Intern notering	Nej	connComment	Notering endast synlig för behöriga inom den egna organisationen
Delad notering	Nej	admincomment	Notering som delas mellan individen själv och alla organisationer individen har koppling till
Presentation	Nej	personComment	En kort presentation av individen. Ofta inlagd av individen själv
Databasreferenser och synkronisering	?	Database references and data exchange
U-nummer	Nej	personId	Globalt referensnummer inom systemet
U-nr som streckkod (3of9)	Nej	userBarCodeString	Med omslutande *-tecken
U-nr som streckkod (bild)	Nej	userBarCodeImage	Deltagarens unika referensnummer (U-nummer) i form av en streckkod-bild
Idrotts-ID	Nej	idrottsId	IdrottsId (IID) från Riksidrottsförbundet (RF) i Idrott Online (IOL)
IOL-synkning	Nej	iolSync	Status för automatisk export till IOL
Överflödig	?	isObsolete
Raderaknapp	Nej	deleteButton	Gör det möjligt att radera individer från översikten
Registrant	?	creatorId	Vilken användare som först registrerade informationen
Summeringar	Nej	aggregations
Rad	Nej	rowNumber	Radnummer i denna lista
Dölj tomma kolumner	Ja	hideEmptyColumns
DB-id	?	databaseId	Objektets numeriska ID i databasen

För att exempelvis inkludera fält 1 och exkludera fält 2 skickar ni i anropet med show[Fältkod 1]=1;show[Fältkod 2]=0

Sökkriterier. Flera kan användas samtidigt

Parameter	Värden	Kommentar
name		Individens namn eller delar av namn
email		Individens e-post. Behöver inte vara den primära
group	Gruppens e-postadress	Endast medlemmar i gruppen med angiven e-postadress
cardNumber		Kortnummer utställt på individen
keyCardRef	Textsträng	Endast individer som tilldelats angivet nyckelkortsnummer
minMshipDate	YYYY-MM-DD	Endast individer som varit registrerade som medlem någon gång efter detta datum
maxMshipDate	YYYY-MM-DD	Endast individer som varit registrerade som medlem någon gång innan detta datum