GET api/Passphrase?EmailAddress={EmailAddress}&APIKey={APIKey}&WordCount={WordCount}&MinWordLength={MinWordLength}

This API will generate a random passphrase with WordCount number of English dictionary words of at least MinWordLength.

Request Information

URI Parameters

Name	Description	Type	Additional information
EmailAddress	Client's email address given when they requested an API Key.	string	Required
APIKey	Client's API Key check your email for this after your request of an API Key.	string	Required
WordCount	Range 3 to 10, number of words in the passphrase.	integer	Default value is 3
MinWordLength	Range 3 to 10, minimum length of each word in the passphrase.	integer	Default value is 3

Body Parameters

None.

Response Information

Resource Description

This API returns apiResponsePassphrase which includes state information about the call and if successful a passphrase string. See the apiResponsePassphrase definition below.

apiResponsePassphrase

Name	Description	Type	Additional information
responseStatus	The status of PassphraseGeneratorAPI GET api/Passphrase call.	PassphraseResponseEnum	None.
passphraseValue	String containing the passphrase generated if status == Success.	string	None.
allTimeNumberOfCallsToThisAPI	The all time number of calls made by this client to the PassphraseGeneratorAPI. (Will always return 1 for failed calls to the API.)	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "responseStatus": 0,
  "passphraseValue": "sample string 1",
  "allTimeNumberOfCallsToThisAPI": 2
}

application/xml, text/xml

Sample:

<apiResponsePassphrase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PasswordGeneratorAPI.Controllers">
  <allTimeNumberOfCallsToThisAPI>2</allTimeNumberOfCallsToThisAPI>
  <passphraseValue>sample string 1</passphraseValue>
  <responseStatus>Success</responseStatus>
</apiResponsePassphrase>