POST api/applicant/RegisterInVirtual

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ContactId	string	None.
CampaignId	string	None.
OriginRegistration	integer	None.
journeyId	string	None.
channelId	string	None.
mobileNumber	string	None.
email	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ContactId": "sample string 1",
  "CampaignId": "sample string 2",
  "OriginRegistration": 3,
  "journeyId": "sample string 4",
  "channelId": "sample string 5",
  "mobileNumber": "sample string 6",
  "email": "sample string 7"
}

application/xml, text/xml

Sample:

<VirtualRegistrationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Models">
  <CampaignId>sample string 2</CampaignId>
  <ContactId>sample string 1</ContactId>
  <OriginRegistration>3</OriginRegistration>
  <channelId>sample string 5</channelId>
  <email>sample string 7</email>
  <journeyId>sample string 4</journeyId>
  <mobileNumber>sample string 6</mobileNumber>
</VirtualRegistrationViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseMessage

Name	Type	Additional information
Code	string	None.
MessageAR	string	None.
MessageEN	string	None.
ExceptionDetails	string	None.
RefNumber	string	None.
applicationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": "sample string 1",
  "MessageAR": "sample string 2",
  "MessageEN": "sample string 3",
  "ExceptionDetails": "sample string 4",
  "RefNumber": "sample string 5",
  "applicationId": "sample string 6"
}

application/xml, text/xml

Sample:

<ResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Helpers">
  <Code>sample string 1</Code>
  <ExceptionDetails>sample string 4</ExceptionDetails>
  <MessageAR>sample string 2</MessageAR>
  <MessageEN>sample string 3</MessageEN>
  <RefNumber>sample string 5</RefNumber>
  <applicationId>sample string 6</applicationId>
</ResponseMessage>