PUT api/Session

Login a user to establish a session

Request Information

URI Parameters

None.

Body Parameters

The login data used to create the session

SessionLoginData
NameDescriptionTypeAdditional information
UserName

The user name / login email of the donor account

string

None.

Password

The password of the donor accouhnt

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<SessionLoginData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Caf.DonorSystem.Mobile.WebApi.Models">
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</SessionLoginData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResultOfSession
NameDescriptionTypeAdditional information
Entity

Session

None.

HasErrors

True if there are any errors present

boolean

None.

Errors

The list of errors

Collection of ApiResultError

None.

Response Formats

application/json, text/json

Sample:
{
  "Entity": null,
  "HasErrors": true,
  "Errors": [
    {
      "Code": 0,
      "ErrorType": "sample string 1",
      "Message": "sample string 2"
    },
    {
      "Code": 0,
      "ErrorType": "sample string 1",
      "Message": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiResultOfSessiont13cTSzo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Caf.DonorSystem.Mobile.WebApi.Models">
  <Errors>
    <ApiResultError>
      <Code>InvalidParameterAddressMissing</Code>
      <ErrorType>sample string 1</ErrorType>
      <Message>sample string 2</Message>
    </ApiResultError>
    <ApiResultError>
      <Code>InvalidParameterAddressMissing</Code>
      <ErrorType>sample string 1</ErrorType>
      <Message>sample string 2</Message>
    </ApiResultError>
  </Errors>
  <Entity i:nil="true" />
</ApiResultOfSessiont13cTSzo>