POST vouchers/lookup-recipient

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CellNumber		string	Required

Request Formats

application/json, text/json

Sample:

{
  "CellNumber": "sample string 1"
}

application/xml, text/xml

Sample:

<RecipientLookupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <CellNumber>sample string 1</CellNumber>
</RecipientLookupRequest>

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

Response Information

Resource Description

RecipientLookupResponse

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
UserExists	boolean	None.
UserId	string	None.
Name	string	None.
CellNumber	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "UserExists": true,
  "UserId": "sample string 4",
  "Name": "sample string 5",
  "CellNumber": "sample string 6"
}

application/xml, text/xml

Sample:

<RecipientLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <CellNumber>sample string 6</CellNumber>
  <Message>sample string 2</Message>
  <Name>sample string 5</Name>
  <Success>true</Success>
  <UserExists>true</UserExists>
  <UserId>sample string 4</UserId>
</RecipientLookupResponse>