POST api/authenticate

Medprax User Session

Request Information

URI Parameters

None.

Body Parameters

Credentials with username and password

CredentialModel
NameDescriptionTypeAdditional information
UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:
<CredentialModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AqueDAC.Core.WebAPI.Models">
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</CredentialModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CredentialModel'.

Response Information

Resource Description

UserSessionModel
NameDescriptionTypeAdditional information
SessionToken

string

None.

SystemUserId

integer

None.

CreatedTimestamp

date

None.

ExpiryTimestamp

date

None.

UserDate

string

None.

UserTime

string

None.

Roles

Collection of string

None.

Functions

Collection of string

None.

TimeZoneID

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SessionToken": "sample string 1",
  "SystemUserId": 2,
  "CreatedTimestamp": "2025-12-11T17:24:56.0912735+02:00",
  "ExpiryTimestamp": "2025-12-11T17:24:56.0912735+02:00",
  "UserDate": "sample string 5",
  "UserTime": "sample string 6",
  "Roles": [
    "sample string 1",
    "sample string 2"
  ],
  "Functions": [
    "sample string 1",
    "sample string 2"
  ],
  "TimeZoneID": "sample string 7"
}

application/xml, text/xml

Sample:
<UserSessionModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AqueDAC.Core.WebAPI.Models">
  <CreatedTimestamp>2025-12-11T17:24:56.0912735+02:00</CreatedTimestamp>
  <ExpiryTimestamp>2025-12-11T17:24:56.0912735+02:00</ExpiryTimestamp>
  <Functions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Functions>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Roles>
  <SessionToken>sample string 1</SessionToken>
  <SystemUserId>2</SystemUserId>
  <TimeZoneID>sample string 7</TimeZoneID>
  <UserDate>sample string 5</UserDate>
  <UserTime>sample string 6</UserTime>
</UserSessionModel>