POST api/Authenticate

Request Information

URI Parameters

None.

Body Parameters

AuthenticationRequest
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:
<AuthenticationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Von_Forms_Web.Models.Authentication.Request">
  <password>sample string 2</password>
  <username>sample string 1</username>
</AuthenticationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticationResponse
NameDescriptionTypeAdditional information
success

boolean

None.

token

string

None.

Errors

Collection of string

None.

Depots

DepotCatalog

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "token": "sample string 2",
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Depots": {
    "version": "sample string 1",
    "Catalogs": {
      "sample string 1": {
        "depots": [
          {
            "description": "sample string 1",
            "GUID": "sample string 2"
          },
          {
            "description": "sample string 1",
            "GUID": "sample string 2"
          }
        ]
      },
      "sample string 2": {
        "depots": [
          {
            "description": "sample string 1",
            "GUID": "sample string 2"
          },
          {
            "description": "sample string 1",
            "GUID": "sample string 2"
          }
        ]
      }
    }
  }
}

application/xml, text/xml

Sample:
<AuthenticationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Von_Forms_Web.Models.Authentication.Response">
  <Depots xmlns:d2p1="http://schemas.datacontract.org/2004/07/Von_Forms_Web.Models">
    <d2p1:Catalogs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringDepotModelT36MeJRG>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <d2p1:depots>
            <d2p1:Depot>
              <d2p1:GUID>sample string 2</d2p1:GUID>
              <d2p1:description>sample string 1</d2p1:description>
            </d2p1:Depot>
            <d2p1:Depot>
              <d2p1:GUID>sample string 2</d2p1:GUID>
              <d2p1:description>sample string 1</d2p1:description>
            </d2p1:Depot>
          </d2p1:depots>
        </d3p1:Value>
      </d3p1:KeyValueOfstringDepotModelT36MeJRG>
      <d3p1:KeyValueOfstringDepotModelT36MeJRG>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <d2p1:depots>
            <d2p1:Depot>
              <d2p1:GUID>sample string 2</d2p1:GUID>
              <d2p1:description>sample string 1</d2p1:description>
            </d2p1:Depot>
            <d2p1:Depot>
              <d2p1:GUID>sample string 2</d2p1:GUID>
              <d2p1:description>sample string 1</d2p1:description>
            </d2p1:Depot>
          </d2p1:depots>
        </d3p1:Value>
      </d3p1:KeyValueOfstringDepotModelT36MeJRG>
    </d2p1:Catalogs>
    <d2p1:version>sample string 1</d2p1:version>
  </Depots>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <success>true</success>
  <token>sample string 2</token>
</AuthenticationResponse>