Skip to main content

Get all natural Persons with pagination, filters, and sorting

GET 
/sint/naturalPerson/

Get all natural Persons with pagination, filters, and sorting

Request​

Query Parameters

    pagination string

    The pagination you want to get, default 1,10 (page = 1; nb_elements = 10)

    Example: 1,10
    filter string

    The filter you want to get, {champ}:{op}:{valeur},{champ_2}:{op_2}:{valeur_2}
    The field names are specified in the web service documentation.
    where {op} to be :

    • eq : ├®galit├®
    • ne : diff├®rent (!=)
    • lk : like. Pour les chaine de caract├¿res, correspond au sql %valeur%
    • lt : plus petit que (<)
    • le : plus petit ou ├®gal (<=)
    • gt : plus grand que (>)
    • ge : plus grand ou ├®gal (>=)

    Example: id:eq:7353
    orderby string

    The orderby you want to get, {champ},{-champ_2}
    The field names are specified in the web service documentation.
    Sorting is ascending by default, for sorting descending the field must be preceded by the ÔÇ£-ÔÇØ sign.
    Several filters can be combined by separating them with commas

    Example: -id

Responses​

List every Natural Person, if it empty, there is no Natural Person in the database

Schema
  • Array [
    • Gender stringnullable

    The person gender

    LastName stringrequired

    Last name

    FirstName stringrequired

    First name

    OtherFirstNames stringnullable

    Other first name

    MaidenName stringnullable

    Maiden name

    DateOfBirth date-timerequired
    CountryOfCitizenship stringnullable

    Country of citizenship

    CountryOfCitizenship2 stringnullable

    Second country of citizenship

    Birthplace stringnullable

    Birthplace

    StateOfBirth stringnullable

    State of birth

    NIF stringnullable
    Comments stringnullable
    CodeLangue stringnullable
    ActivityCode integernullable

    Activity Code

    CSPCode integernullable

    CSP Code

    SourceIncomeCode integernullable

    Source Income Code

    codeShop stringnullable

    Code Shop

    idBB stringnullable

    Id BB

    ibanOlkyPay stringnullable

    IBAN Oky Pay

    countryOfBirth stringnullable

    Country of birth

    identityUuid stringnullable
    algoregId stringnullable

    Id Algoreg

    idLausanne stringnullable

    Id Lausane

    pep booleannullable

    true if person is politically exposed

    minimumMonthlyIncome integernullable

    low range of the person's income, in cents

    maximumMonthlyIncome integernullable

    Max range of the person's income, in cents

    minimumWealthValue integernullable

    low range of the person's wealth value, in cents

    maximumWealthValue integernullable

    Max range of the person's wealth value, in cents

    own_external_sepa_account booleannullable

    Has european account

    nif_country stringnullable

    Nif country

  • ]
Loading...