POST api/retscredential/testlogin

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
MLSID	string	Required
LoginUrl	string	Required
Username	string	Required
Password	string	Required
UserAgent	string	None.
UserAgentPassword	string	None.
RETSVersion	string	Required
SuccessfulLogin	boolean	None.
LastLoginMessage	string	None.
IsDefault	boolean	None.
UTCOffset	integer	Range: inclusive between -2147483648 and 2147483647
ParticipateDaylightSavings	boolean	None.
HasForeignKeys	boolean	None.
MetaDataVersion	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "MLSID": "sample string 2",
  "LoginUrl": "sample string 3",
  "Username": "sample string 4",
  "Password": "sample string 5",
  "UserAgent": "sample string 6",
  "UserAgentPassword": "sample string 7",
  "RETSVersion": "sample string 8",
  "SuccessfulLogin": true,
  "LastLoginMessage": "sample string 10",
  "IsDefault": true,
  "UTCOffset": 1,
  "ParticipateDaylightSavings": 1,
  "HasForeignKeys": true,
  "MetaDataVersion": "sample string 13"
}

text/html

Sample:

{"ID":1,"MLSID":"sample string 2","LoginUrl":"sample string 3","Username":"sample string 4","Password":"sample string 5","UserAgent":"sample string 6","UserAgentPassword":"sample string 7","RETSVersion":"sample string 8","SuccessfulLogin":true,"LastLoginMessage":"sample string 10","IsDefault":true,"UTCOffset":1,"ParticipateDaylightSavings":1,"HasForeignKeys":true,"MetaDataVersion":"sample string 13"}

application/xml, text/xml

Sample:

<RETSCredentialModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Services">
  <HasForeignKeys>true</HasForeignKeys>
  <ID>1</ID>
  <IsDefault>true</IsDefault>
  <LastLoginMessage>sample string 10</LastLoginMessage>
  <LoginUrl>sample string 3</LoginUrl>
  <MLSID>sample string 2</MLSID>
  <MetaDataVersion>sample string 13</MetaDataVersion>
  <ParticipateDaylightSavings>true</ParticipateDaylightSavings>
  <Password>sample string 5</Password>
  <RETSVersion>sample string 8</RETSVersion>
  <SuccessfulLogin>true</SuccessfulLogin>
  <UTCOffset>1</UTCOffset>
  <UserAgent>sample string 6</UserAgent>
  <UserAgentPassword>sample string 7</UserAgentPassword>
  <Username>sample string 4</Username>
</RETSCredentialModel>

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 'RETSCredentialModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.