PV API Service

<back to all web services

AuthenticationTokenRequest

POST - Authenticates a PV token

The following routes are available for this service:
POST, OPTIONS/AuthenticationAPI/AuthenticateToken

To override the Content-type in your clients HTTP Accept Header, append ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/AuthenticationTokenRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: application/xml
Content-Length: length

<AuthenticationTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.Authentication">
  <Token>String</Token>
</AuthenticationTokenRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AuthenticationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.Authentication">
  <AuthenticationErrorMessage>String</AuthenticationErrorMessage>
  <Email>String</Email>
  <IpAddress>String</IpAddress>
  <IsAuthorized>false</IsAuthorized>
  <Token>String</Token>
  <UserName>String</UserName>
  <UserPermissions>
    <AddAllowed>false</AddAllowed>
    <DeleteAllowed>false</DeleteAllowed>
    <InquireAllowed>false</InquireAllowed>
    <Name>String</Name>
    <Parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:char>0</d3p1:char>
    </Parameters>
    <Practice>String</Practice>
    <UpdateAllowed>false</UpdateAllowed>
  </UserPermissions>
  <UserProfilePk>00000000-0000-0000-0000-000000000000</UserProfilePk>
</AuthenticationResponse>