You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 115 Next »

API endpoints

US01 | Login user

GET

/user/login

Basic Authentification required

User Result object
{
    "results": {
        "person": [
            {
                "id": "fb37beba5bfba23405b42dcf6a0db219",
                "nickname": "ddbCronjobAdmin",
                "status": "CONFIRMED",
                "salutation": "Herr",
                "foreName": "ddbCronjob",
                "surName": "Admin",
                "email": "ddbcronjobadmin@fiz-karlsruhe.de",
                "telephoneNumber": "123456",
                "created": "2021-11-12T03:11:10",
                "creatorId": "anonymous",
                "modified": "2021-11-12T08:17:06",
                "modifierId": "admin"
            },
            {
                "id": "5f1571def309f4e30f16f8b85cd64534",
                "nickname": "m.buechner@dnb.de",
                "status": "CONFIRMED",
                "salutation": "Herr",
                "foreName": "Michael",
                "surName": "Büchner",
                "email": "m.buechner@dnb.de",
                "telephoneNumber": "+49 69 1525-1774",
                "created": "2020-12-17T17:37:24",
                "creatorId": "anonymous",
                "modified": "2020-12-17T17:38:58",
                "modifierId": "e08d8db1bb28b584753129a055a9b548",
            }
        ]
    },
    "start": 1,
    "count": 2,
    "totalHits": 39
}

Status codes

  • 200 = Successful
  • 400 = Bad Request
  • 401 = User not authorized to login
  • 403 = Authentication temporarily blocked
  • 404 = User not found
  • 423 = User is blacklisted
  • 428 = User has "unconfirmed" status
  • 500 = Internal server error

Example call(s)

  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/user/search?status=CONFIRMED&salutation=Herr&sort=surName/sort.ascending&start=1&count=2
  • No labels