POST api/Authentication/SignIn

An authentication token will be issued on success that must be placed in the header of all subsequent actions.

Request Information

URI Parameters

None.

Body Parameters

User credentials

UserCredentials

Name	Description	Type	Additional information
AccountCode	Account to sign into.	string	Required String length: inclusive between 3 and 50
EmailAddress	User's email address	string	Required Matching regular expression pattern: ^([\w\.\-]+)@([\w\-]+)((\.(\w){2,3})+)$
EncryptedPassword		string	None.

Name

Description

Type

Additional information

AccountCode

Account to sign into.

string

Required

String length: inclusive between 3 and 50

EmailAddress

User's email address

string

Required

Matching regular expression pattern: ^([\w\.\-]+)@([\w\-]+)((\.(\w){2,3})+)$

EncryptedPassword

string

None.

Request Formats

application/json, text/json

Sample:

{
  "AccountCode": "sample string 1",
  "EmailAddress": "sample string 2",
  "EncryptedPassword": "sample string 3"
}

application/xml, text/xml

Sample:

<UserCredentials xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MYTYM.WebService.Models">
  <AccountCode>sample string 1</AccountCode>
  <EmailAddress>sample string 2</EmailAddress>
  <EncryptedPassword>sample string 3</EncryptedPassword>
</UserCredentials>

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

Response Information

Resource Description

Returns OK if successful, BadRequest if input is invalid, or Unauthorized if password is incorrect or email not valid for account. If OK, a System.Net.Http.Headers.AuthenticationHeaderValue object is returned in the response body with the authentication token.

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.