GET api/v1/Invitation/{EmailAddress}/Validate/{InvitationCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
EmailAddress

string

Required
InvitationCode

string

Required

Body Parameters

None.

Response Information

Resource Description

ValidateInvitationCodeDTO
NameDescriptionTypeAdditional information
Valid

boolean

None.
Message

string

None.
IncorrectLoginAttemptCount

integer

None.
IncorrectLoginAttemptCountMessage

string

None.
RemainingLoginAttempts

integer

None.
InvitationToken

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Valid": true,
  "Message": "sample string 2",
  "IncorrectLoginAttemptCount": 3,
  "IncorrectLoginAttemptCountMessage": "sample string 4",
  "RemainingLoginAttempts": 5,
  "InvitationToken": "sample string 6"
}

application/xml, text/xml

Sample: 
<ValidateInvitationCodeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RAIS.API.Models.MobileApp">
  <IncorrectLoginAttemptCount>3</IncorrectLoginAttemptCount>
  <IncorrectLoginAttemptCountMessage>sample string 4</IncorrectLoginAttemptCountMessage>
  <InvitationToken>sample string 6</InvitationToken>
  <Message>sample string 2</Message>
  <RemainingLoginAttempts>5</RemainingLoginAttempts>
  <Valid>true</Valid>
</ValidateInvitationCodeDTO>