This repository has been archived by the owner on Jul 5, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
pdl.graphql
927 lines (811 loc) · 22 KB
/
pdl.graphql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
# This file was generated based on ".graphqlconfig". Do not edit manually.
schema {
query: Query
}
type AdresseCompletionResult {
addressFound: CompletionAdresse
suggestions: [ String! ]!
}
type AdresseSearchHit {
matrikkeladresse: MatrikkeladresseResult
score: Float
vegadresse: VegadresseResult
}
type AdresseSearchResult {
hits: [ AdresseSearchHit! ]!
pageNumber: Int
totalHits: Int
totalPages: Int
}
type Adressebeskyttelse {
folkeregistermetadata: Folkeregistermetadata
gradering: AdressebeskyttelseGradering!
metadata: Metadata!
}
type Bostedsadresse {
angittFlyttedato: Date
coAdressenavn: String
folkeregistermetadata: Folkeregistermetadata
gyldigFraOgMed: DateTime
gyldigTilOgMed: DateTime
matrikkeladresse: Matrikkeladresse
metadata: Metadata!
ukjentBosted: UkjentBosted
utenlandskAdresse: UtenlandskAdresse
vegadresse: Vegadresse
}
type CompletionAdresse {
matrikkeladresse: MatrikkeladresseResult
vegadresse: VegadresseResult
}
type DeltBosted {
coAdressenavn: String
folkeregistermetadata: Folkeregistermetadata!
matrikkeladresse: Matrikkeladresse
metadata: Metadata!
sluttdatoForKontrakt: Date
startdatoForKontrakt: Date!
ukjentBosted: UkjentBosted
utenlandskAdresse: UtenlandskAdresse
vegadresse: Vegadresse
}
type DoedfoedtBarn {
dato: Date
folkeregistermetadata: Folkeregistermetadata!
metadata: Metadata!
}
type Doedsfall {
doedsdato: Date
folkeregistermetadata: Folkeregistermetadata
metadata: Metadata!
}
" Endring som har blitt utført på opplysningen. F.eks: Opprett -> Korriger -> Korriger"
type Endring {
"""
Opphavet til informasjonen. I NAV blir dette satt i forbindelse med registrering (f.eks: Sykehuskassan).
Fra Folkeregisteret får vi opphaven til dems opplysning, altså NAV, UDI, Politiet, Skatteetaten o.l.. Fra Folkeregisteret kan det også være tekniske navn som: DSF_MIGRERING, m.m..
"""
kilde: String!
" Tidspunktet for registrering."
registrert: DateTime!
" Hvem endringen har blitt utført av, ofte saksbehandler (f.eks Z990200), men kan også være system (f.eks srvXXXX). Denne blir satt til \"Folkeregisteret\" for det vi får fra dem."
registrertAv: String!
" Hvilke system endringen har kommet fra (f.eks srvXXX). Denne blir satt til \"FREG\" for det vi får fra Folkeregisteret."
systemkilde: String!
" Hvilke type endring som har blitt utført."
type: Endringstype!
}
type FalskIdentitet {
erFalsk: Boolean!
folkeregistermetadata: Folkeregistermetadata
metadata: Metadata!
rettIdentitetErUkjent: Boolean
rettIdentitetVedIdentifikasjonsnummer: String
rettIdentitetVedOpplysninger: FalskIdentitetIdentifiserendeInformasjon
}
type FalskIdentitetIdentifiserendeInformasjon {
foedselsdato: Date
kjoenn: KjoennType
personnavn: Personnavn!
statsborgerskap: [ String! ]!
}
type Foedsel {
foedekommune: String
foedeland: String
foedested: String
foedselsaar: Int
foedselsdato: Date
folkeregistermetadata: Folkeregistermetadata
metadata: Metadata!
}
type Folkeregisteridentifikator {
folkeregistermetadata: Folkeregistermetadata!
identifikasjonsnummer: String!
metadata: Metadata!
status: String!
type: String!
}
type Folkeregistermetadata {
aarsak: String
ajourholdstidspunkt: DateTime
gyldighetstidspunkt: DateTime
kilde: String
opphoerstidspunkt: DateTime
sekvens: Int
}
type Folkeregisterpersonstatus {
folkeregistermetadata: Folkeregistermetadata!
forenkletStatus: String!
metadata: Metadata!
status: String!
}
type ForelderBarnRelasjon {
folkeregistermetadata: Folkeregistermetadata
metadata: Metadata!
minRolleForPerson: ForelderBarnRelasjonRolle
relatertPersonUtenFolkeregisteridentifikator: RelatertBiPerson
relatertPersonsIdent: String
relatertPersonsRolle: ForelderBarnRelasjonRolle!
}
type Foreldreansvar {
ansvar: String
ansvarlig: String
ansvarligUtenIdentifikator: RelatertBiPerson
ansvarssubjekt: String
folkeregistermetadata: Folkeregistermetadata
metadata: Metadata!
}
type Fullmakt {
gyldigFraOgMed: Date!
gyldigTilOgMed: Date!
metadata: Metadata!
motpartsPersonident: String!
motpartsRolle: FullmaktsRolle!
omraader: [ String! ]!
}
type GeografiskTilknytning {
gtBydel: String
gtKommune: String
gtLand: String
gtType: GtType!
regel: String!
}
type HentIdenterBolkResult {
code: String!
ident: String!
identer: [ IdentInformasjon! ]
}
type HentPersonBolkResult {
code: String!
ident: String!
person: Person
}
type IdentInformasjon {
gruppe: IdentGruppe!
historisk: Boolean!
ident: String!
}
type Identitetsgrunnlag {
folkeregistermetadata: Folkeregistermetadata!
metadata: Metadata!
status: Identitetsgrunnlagsstatus!
}
type Identliste {
identer: [ IdentInformasjon! ]!
}
type InnflyttingTilNorge {
folkeregistermetadata: Folkeregistermetadata
fraflyttingsland: String
fraflyttingsstedIUtlandet: String
metadata: Metadata!
}
type KartverketAdresse {
id: Long!
matrikkeladresse: KartverketMatrikkeladresse
vegadresse: KartverketVegadresse
}
type KartverketBydel {
bydelsnavn: String
bydelsnummer: String
}
type KartverketFylke {
navn: String
nummer: String
}
type KartverketGrunnkrets {
grunnkretsnavn: String
grunnkretsnummer: String
}
type KartverketKommune {
fylke: KartverketFylke
navn: String
nummer: String
}
type KartverketMatrikkeladresse {
adressetilleggsnavn: String
bydel: KartverketBydel
grunnkrets: KartverketGrunnkrets
kortnavn: String
matrikkelnummer: KartverketMatrikkelnummer
postnummeromraade: KartverketPostnummeromraade
representasjonspunkt: KartverketRepresentasjonspunkt
undernummer: Int
}
type KartverketMatrikkelnummer {
bruksnummer: Int
festenummer: Int
gaardsnummer: Int
kommunenummer: String
seksjonsnummer: Int
}
type KartverketPostnummeromraade {
postnummer: String
poststed: String
}
type KartverketRepresentasjonspunkt {
posisjonskvalitet: Int
x: Float
y: Float
z: Float
}
type KartverketVeg {
adressekode: Int
adressenavn: String
kommune: KartverketKommune
kortnavn: String
stedsnummer: String
}
type KartverketVegadresse {
adressetilleggsnavn: String
bokstav: String
bydel: KartverketBydel
grunnkrets: KartverketGrunnkrets
kortnavn: String
nummer: Int
postnummeromraade: KartverketPostnummeromraade
representasjonspunkt: KartverketRepresentasjonspunkt
veg: KartverketVeg
}
type Kjoenn {
folkeregistermetadata: Folkeregistermetadata
kjoenn: KjoennType
metadata: Metadata!
}
type Kontaktadresse {
coAdressenavn: String
folkeregistermetadata: Folkeregistermetadata
gyldigFraOgMed: DateTime
gyldigTilOgMed: DateTime
metadata: Metadata!
postadresseIFrittFormat: PostadresseIFrittFormat
postboksadresse: Postboksadresse
type: KontaktadresseType!
utenlandskAdresse: UtenlandskAdresse
utenlandskAdresseIFrittFormat: UtenlandskAdresseIFrittFormat
vegadresse: Vegadresse
}
type KontaktinformasjonForDoedsbo {
adresse: KontaktinformasjonForDoedsboAdresse!
advokatSomKontakt: KontaktinformasjonForDoedsboAdvokatSomKontakt
attestutstedelsesdato: Date!
folkeregistermetadata: Folkeregistermetadata!
metadata: Metadata!
organisasjonSomKontakt: KontaktinformasjonForDoedsboOrganisasjonSomKontakt
personSomKontakt: KontaktinformasjonForDoedsboPersonSomKontakt
skifteform: KontaktinformasjonForDoedsboSkifteform!
}
type KontaktinformasjonForDoedsboAdresse {
adresselinje1: String!
adresselinje2: String
landkode: String
postnummer: String!
poststedsnavn: String!
}
type KontaktinformasjonForDoedsboAdvokatSomKontakt {
organisasjonsnavn: String
organisasjonsnummer: String
personnavn: Personnavn!
}
type KontaktinformasjonForDoedsboOrganisasjonSomKontakt {
kontaktperson: Personnavn
organisasjonsnavn: String!
organisasjonsnummer: String
}
type KontaktinformasjonForDoedsboPersonSomKontakt {
foedselsdato: Date
identifikasjonsnummer: String
personnavn: Personnavn
}
type Koordinater {
kvalitet: Int
x: Float
y: Float
z: Float
}
type Matrikkeladresse {
bruksenhetsnummer: String
kommunenummer: String
koordinater: Koordinater
matrikkelId: Long
postnummer: String
tilleggsnavn: String
}
type MatrikkeladresseResult {
bruksnummer: String
gaardsnummer: String
kommunenummer: String
matrikkelId: String
postnummer: String
poststed: String
tilleggsnavn: String
}
type Metadata {
"""
En liste over alle endringer som har blitt utført over tid.
Vær obs på at denne kan endre seg og man burde takle at det finnes flere korrigeringer i listen, så dersom man ønsker å kun vise den siste, så må man selv filtrere ut dette.
Det kan også ved svært få tilfeller skje at opprett blir fjernet. F.eks ved splitt tilfeller av identer. Dette skal skje i svært få tilfeller. Dersom man ønsker å presentere opprettet tidspunktet, så blir det tidspunktet på den første endringen.
"""
endringer: [ Endring! ]!
"""
Feltet betegner hvorvidt dette er en funksjonelt historisk opplysning, for eksempel en tidligere fraflyttet adresse eller et foreldreansvar som er utløpt fordi barnet har fylt 18 år.
I de fleste tilfeller kan dette utledes ved å se på de andre feltene i opplysningen. Dette er imidlertid ikke alltid tilfellet, blant annet for foreldreansvar.
Feltet bør brukes av konsumenter som henter informasjon fra GraphQL med historikk, men som også trenger å utlede gjeldende informasjon.
"""
historisk: Boolean!
" Master refererer til hvem som eier opplysningen, f.eks så har PDL en kopi av Folkeregisteret, da vil master være FREG og eventuelle endringer på dette må gå via Folkeregisteret (API mot dem eller andre rutiner)."
master: String!
"""
I PDL så får alle forekomster av en opplysning en ID som representerer dens unike forekomst.
F.eks, så vil en Opprett ha ID X, korriger ID Y (der hvor den spesifiserer at den korrigerer X).
Dersom en opplysning ikke er lagret i PDL, så vil denne verdien ikke være utfylt.
"""
opplysningsId: String
}
type Navn {
etternavn: String!
folkeregistermetadata: Folkeregistermetadata
forkortetNavn: String
fornavn: String!
gyldigFraOgMed: Date
mellomnavn: String
metadata: Metadata!
originaltNavn: OriginaltNavn
}
type Opphold {
folkeregistermetadata: Folkeregistermetadata!
metadata: Metadata!
oppholdFra: Date
oppholdTil: Date
type: Oppholdstillatelse!
}
type Oppholdsadresse {
coAdressenavn: String
folkeregistermetadata: Folkeregistermetadata
gyldigFraOgMed: DateTime
gyldigTilOgMed: DateTime
matrikkeladresse: Matrikkeladresse
metadata: Metadata!
oppholdAnnetSted: String
utenlandskAdresse: UtenlandskAdresse
vegadresse: Vegadresse
}
type OriginaltNavn {
etternavn: String
fornavn: String
mellomnavn: String
}
type Person {
adressebeskyttelse(historikk:
Boolean = false): [ Adressebeskyttelse! ]!
bostedsadresse(historikk:
Boolean = false): [ Bostedsadresse! ]!
deltBosted(historikk:
Boolean = false): [ DeltBosted! ]!
doedfoedtBarn: [ DoedfoedtBarn! ]!
doedsfall: [ Doedsfall! ]!
falskIdentitet: FalskIdentitet
foedsel: [ Foedsel! ]!
folkeregisteridentifikator(historikk:
Boolean = false): [ Folkeregisteridentifikator! ]!
folkeregisterpersonstatus(historikk:
Boolean = false): [ Folkeregisterpersonstatus! ]!
forelderBarnRelasjon: [ ForelderBarnRelasjon! ]!
foreldreansvar(historikk:
Boolean = false): [ Foreldreansvar! ]!
fullmakt(historikk:
Boolean = false): [ Fullmakt! ]!
identitetsgrunnlag(historikk:
Boolean = false): [ Identitetsgrunnlag! ]!
innflyttingTilNorge: [ InnflyttingTilNorge! ]!
kjoenn(historikk:
Boolean = false): [ Kjoenn! ]!
kontaktadresse(historikk:
Boolean = false): [ Kontaktadresse! ]!
kontaktinformasjonForDoedsbo(historikk:
Boolean = false): [ KontaktinformasjonForDoedsbo! ]!
navn(historikk:
Boolean = false): [ Navn! ]!
opphold(historikk:
Boolean = false): [ Opphold! ]!
oppholdsadresse(historikk:
Boolean = false): [ Oppholdsadresse! ]!
sikkerhetstiltak: [ Sikkerhetstiltak! ]!
sivilstand(historikk:
Boolean = false): [ Sivilstand! ]!
statsborgerskap(historikk:
Boolean = false): [ Statsborgerskap! ]!
telefonnummer: [ Telefonnummer! ]!
tilrettelagtKommunikasjon: [ TilrettelagtKommunikasjon! ]!
utenlandskIdentifikasjonsnummer(historikk:
Boolean = false): [ UtenlandskIdentifikasjonsnummer! ]!
utflyttingFraNorge: [ UtflyttingFraNorge! ]!
vergemaalEllerFremtidsfullmakt(historikk:
Boolean = false): [ VergemaalEllerFremtidsfullmakt! ]!
}
type PersonSearchHighlight {
" Forteller hvorvidt opplysningen som ga treff er markert som historisk."
historisk: Boolean
"""
liste med feltene og verdiene som ga treff.
Merk at for fritekst søk så vil disse kunne referere til hjelpe felter som ikke er synelig i resultatene.
"""
matches: [ SearchMatch ]
"""
Navn/Sti til opplysningen som ga treff. Merk at dette ikke er feltet som ga treff men opplysningen.
F.eks. hvis du søker på person.navn.fornavn så vil opplysingen være person.navn.
"""
opplysning: String
"""
Gitt att opplysningen som ga treff har en opplysningsId så vil den returneres her.
alle søk under person skal ha opplysningsId, men søk i identer vil kunne returnere treff uten opplysningsId.
"""
opplysningsId: String
}
type PersonSearchHit {
" Infromasjon om hva som ga treff i søke resultatet."
highlights: [ PersonSearchHighlight ]
" forespurte data"
identer(historikk:
Boolean = false): [ IdentInformasjon! ]!
" forespurte data"
person: Person
" Poengsummen elasticsearch har gitt dette resultatet (brukt til feilsøking, og tuning av søk)"
score: Float
}
type PersonSearchResult {
" treff liste"
hits: [ PersonSearchHit! ]!
" Side nummer for siden som vises"
pageNumber: Int
" Totalt antall treff (øvre grense er satt til 10 000)"
totalHits: Int
" Totalt antall sider"
totalPages: Int
}
type Personnavn {
etternavn: String!
fornavn: String!
mellomnavn: String
}
type PostadresseIFrittFormat {
adresselinje1: String
adresselinje2: String
adresselinje3: String
postnummer: String
}
type Postboksadresse {
postboks: String!
postbokseier: String
postnummer: String
}
type Query {
forslagAdresse(parameters:
CompletionParameters): AdresseCompletionResult
hentAdresse(matrikkelId:
ID!): KartverketAdresse
hentGeografiskTilknytning(ident:
ID!): GeografiskTilknytning
hentGeografiskTilknytningBolk(identer: [ ID! ]!): [ hentGeografiskTilknytningBolkResult! ]!
hentIdenter(grupper: [ IdentGruppe! ], historikk:
Boolean = false, ident:
ID!): Identliste
hentIdenterBolk(grupper: [ IdentGruppe! ], historikk:
Boolean = false, identer: [ ID! ]!): [ HentIdenterBolkResult! ]!
hentPerson(ident:
ID!): Person
hentPersonBolk(identer: [ ID! ]!): [ HentPersonBolkResult! ]!
sokAdresse(criteria: [ Criterion ], paging:
Paging): AdresseSearchResult
sokPerson(criteria: [ Criterion ], paging:
Paging): PersonSearchResult
}
type RelatertBiPerson {
foedselsdato: Date
kjoenn: KjoennType
navn: Personnavn
statsborgerskap: String
}
type SearchMatch {
" feltnavn med sti til feltet so ga treff."
field: String!
" Verdien som ga treff"
fragments: [ String ]
type: String
}
type Sikkerhetstiltak {
beskrivelse: String!
gyldigFraOgMed: Date!
gyldigTilOgMed: Date!
kontaktperson: SikkerhetstiltakKontaktperson
metadata: Metadata!
tiltakstype: String!
}
type SikkerhetstiltakKontaktperson {
enhet: String!
personident: String!
}
type Sivilstand {
bekreftelsesdato: Date
folkeregistermetadata: Folkeregistermetadata
gyldigFraOgMed: Date
metadata: Metadata!
relatertVedSivilstand: String
type: Sivilstandstype!
}
type Statsborgerskap {
bekreftelsesdato: Date
folkeregistermetadata: Folkeregistermetadata
gyldigFraOgMed: Date
gyldigTilOgMed: Date
land: String!
metadata: Metadata!
}
type Telefonnummer {
landskode: String!
metadata: Metadata!
nummer: String!
prioritet: Int!
}
type TilrettelagtKommunikasjon {
metadata: Metadata!
talespraaktolk: Tolk
tegnspraaktolk: Tolk
}
type Tolk {
spraak: String
}
type UkjentBosted {
bostedskommune: String
}
type UtenlandskAdresse {
adressenavnNummer: String
bySted: String
bygningEtasjeLeilighet: String
landkode: String!
postboksNummerNavn: String
postkode: String
regionDistriktOmraade: String
}
type UtenlandskAdresseIFrittFormat {
adresselinje1: String
adresselinje2: String
adresselinje3: String
byEllerStedsnavn: String
landkode: String!
postkode: String
}
type UtenlandskIdentifikasjonsnummer {
folkeregistermetadata: Folkeregistermetadata
identifikasjonsnummer: String!
metadata: Metadata!
opphoert: Boolean!
utstederland: String!
}
type UtflyttingFraNorge {
folkeregistermetadata: Folkeregistermetadata
metadata: Metadata!
tilflyttingsland: String
tilflyttingsstedIUtlandet: String
utflyttingsdato: Date
}
type Vegadresse {
adressenavn: String
bruksenhetsnummer: String
bydelsnummer: String
husbokstav: String
husnummer: String
kommunenummer: String
koordinater: Koordinater
matrikkelId: Long
postnummer: String
tilleggsnavn: String
}
type VegadresseResult {
adressekode: String
adressenavn: String
bydelsnavn: String
bydelsnummer: String
fylkesnavn: String
fylkesnummer: String
husbokstav: String
husnummer: Int
kommunenavn: String
kommunenummer: String
matrikkelId: String
postnummer: String
poststed: String
tilleggsnavn: String
}
type VergeEllerFullmektig {
motpartsPersonident: String
navn: Personnavn
omfang: String
omfangetErInnenPersonligOmraade: Boolean!
}
type VergemaalEllerFremtidsfullmakt {
embete: String
folkeregistermetadata: Folkeregistermetadata
metadata: Metadata!
type: String
vergeEllerFullmektig: VergeEllerFullmektig!
}
type hentGeografiskTilknytningBolkResult {
code: String!
geografiskTilknytning: GeografiskTilknytning
ident: String!
}
enum AdressebeskyttelseGradering {
FORTROLIG
STRENGT_FORTROLIG
STRENGT_FORTROLIG_UTLAND
UGRADERT
}
enum Direction {
ASC
DESC
}
enum Endringstype {
KORRIGER
OPPHOER
OPPRETT
}
enum Familierelasjonsrolle {
BARN
FAR
MEDMOR
MOR
}
enum ForelderBarnRelasjonRolle {
BARN
FAR
MEDMOR
MOR
}
enum FullmaktsRolle {
FULLMAKTSGIVER
FULLMEKTIG
}
enum GtType {
BYDEL
KOMMUNE
UDEFINERT
UTLAND
}
enum IdentGruppe {
AKTORID
FOLKEREGISTERIDENT
NPID
}
enum Identitetsgrunnlagsstatus {
IKKE_KONTROLLERT
INGEN_STATUS
KONTROLLERT
}
enum KjoennType {
KVINNE
MANN
UKJENT
}
enum KontaktadresseType {
Innland
Utland
}
enum KontaktinformasjonForDoedsboSkifteform {
ANNET
OFFENTLIG
}
enum Oppholdstillatelse {
MIDLERTIDIG
OPPLYSNING_MANGLER
PERMANENT
}
enum Sivilstandstype {
ENKE_ELLER_ENKEMANN
GIFT
GJENLEVENDE_PARTNER
REGISTRERT_PARTNER
SEPARERT
SEPARERT_PARTNER
SKILT
SKILT_PARTNER
UGIFT
UOPPGITT
}
"Format: YYYY-MM-DD (ISO-8601), example: 2017-11-24"
scalar Date
"Format:
YYYY-MM-DDTHH:mm:SS (ISO-8601), example: 2011-12-03T10:15:30"
scalar DateTime
"Long type"
scalar Long
input CompletionFieldValue {
fieldName: String!
fieldValue: String
}
input CompletionParameters {
completionField: String!
fieldValues: [ CompletionFieldValue ]!
maxSuggestions: Int
}
input Criterion {
" Feltnavn ikludert sti til ønsket felt (Eksempel: person.navn.fornavn)"
fieldName: String!
"""
Søk i historiske data
true = søker kun i historiske data.
false = søker kun i gjeldende data.
null = søke i både historiske og gjeldende data.
"""
searchHistorical: Boolean
searchRule: SearchRule!
}
input Paging {
" Hvilken side i resultatsettet man ønsker vist."
pageNumber: Int = 1
" antall treff per side (maks 100)"
resultsPerPage: Int = 10
"""
Liste over felter man ønsker resultatene sortert etter
Standard er "score". Score er poengsummen Elasticsearch tildeler hvert resultat.
"""
sortBy: [ SearchSorting ]
}
input SearchRule {
" Brukes til søke etter datoer som kommer etter opgitt dato."
after: String
" Brukes til søke etter datoer som kommer før opgitt dato."
before: String
" Boost brukes til å gi ett søkekriterie høyere eller lavere vektlegging en de andre søke kriteriene."
boost: Float
" [Flag] Kan brukes til å overstyre standard oppførsellen for søk i felter (standard er case insensitive)"
caseSensitive: Boolean
" Gir treff når opgitt felt inneholder en eller flere ord fra input verdien."
contains: String
" [Flag] Brukes til å deaktivere fonetisk søk feltene som har dette som standard (Navn)"
disablePhonetic: Boolean
" Begrenser treff til kun de hvor felt har input verdi"
equals: String
" Sjekker om feltet finnes / at det ikke har en null verdi."
exists: String
"""
Søk fra og med (se fromExcluding for bare fra men ikke med)
kan benyttes på tall og dato
"""
from: String
"""
Søk fra men ikke med oppgitt verdi
kan benyttes på tall og dato
"""
fromExcluding: String
" Søk som gir treff også for små variasjoner i skrivemåte"
fuzzy: String
" Brukes til å søke i tall og finner verdier som er størren en input verdi."
greaterThan: String
" Brukes til å søke i tall og finner verdier som er mindre en input verdi."
lessThan: String
" Filtrerer bort treff hvor felt inneholder input verdi"
notEquals: String
" Søk som gir tilfeldig poengsum til hvert treff (kun ment til generering av testdata)"
random: String
" Regex søk for spesielle situasjoner (Dette er en treg opprasjon og bør ikke brukes)"
regex: String
" Gir treff når opgitt feltstarter med opgitt verdi."
startsWith: String
"""
Søk til og med (se toExcluding for bare til men ikke med)
kan benyttes på tall og dato
"""
to: String
"""
Søk til men ikke med oppgitt verdi
kan benyttes på tall og dato
"""
toExcluding: String
" Bruk \"?\" som wildcard for enkelt tegn, og \"*\" som wildcard for 0 eller flere tegn."
wildcard: String
}
input SearchSorting {
direction: Direction!
" Feltnavn ikludert sti til ønsket felt (eksepmel: person.navn.fornavn)"
fieldName: String!
}