POST api/applicant/CampaignRegister

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
IdNumber	string	None.
FullNameAR	string	None.
FullNameEN	string	None.
FamilyID	string	None.
FirstName	string	None.
LastName	string	None.
DateOfBirth	string	None.
NationalityId	string	None.
CountryOfResidenceId	string	None.
EmirateId	string	None.
GenderCode	string	None.
Email	string	None.
MobileNumber	string	None.
LandLine	string	None.
PreferedCommunicationCode	string	None.
PreferedLanguageCode	string	None.
MaritalStateCode	string	None.
EducationCode	string	None.
JobTitleCode	string	None.
CampaignCode	string	None.
channelId	string	None.
journeyId	string	None.
RegistrationOrigin	integer	None.
City	string	None.
Area	string	None.
currentClassification	string	None.
marraigaClassifcation	string	None.

Request Formats

application/json, text/json

Sample:

{
  "IdNumber": "sample string 1",
  "FullNameAR": "sample string 2",
  "FullNameEN": "sample string 3",
  "FamilyID": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "DateOfBirth": "sample string 7",
  "NationalityId": "sample string 8",
  "CountryOfResidenceId": "sample string 9",
  "EmirateId": "sample string 10",
  "GenderCode": "sample string 11",
  "Email": "sample string 12",
  "MobileNumber": "sample string 13",
  "LandLine": "sample string 14",
  "PreferedCommunicationCode": "sample string 15",
  "PreferedLanguageCode": "sample string 16",
  "MaritalStateCode": "sample string 17",
  "EducationCode": "sample string 18",
  "JobTitleCode": "sample string 19",
  "CampaignCode": "sample string 20",
  "channelId": "sample string 21",
  "journeyId": "sample string 22",
  "RegistrationOrigin": 23,
  "City": "sample string 24",
  "Area": "sample string 25",
  "currentClassification": "sample string 26",
  "marraigaClassifcation": "sample string 27"
}

application/xml, text/xml

Sample:

<ContactRegistrationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Models">
  <Area>sample string 25</Area>
  <CampaignCode>sample string 20</CampaignCode>
  <City>sample string 24</City>
  <CountryOfResidenceId>sample string 9</CountryOfResidenceId>
  <DateOfBirth>sample string 7</DateOfBirth>
  <EducationCode>sample string 18</EducationCode>
  <Email>sample string 12</Email>
  <EmirateId>sample string 10</EmirateId>
  <FamilyID>sample string 4</FamilyID>
  <FirstName>sample string 5</FirstName>
  <FullNameAR>sample string 2</FullNameAR>
  <FullNameEN>sample string 3</FullNameEN>
  <GenderCode>sample string 11</GenderCode>
  <IdNumber>sample string 1</IdNumber>
  <JobTitleCode>sample string 19</JobTitleCode>
  <LandLine>sample string 14</LandLine>
  <LastName>sample string 6</LastName>
  <MaritalStateCode>sample string 17</MaritalStateCode>
  <MobileNumber>sample string 13</MobileNumber>
  <NationalityId>sample string 8</NationalityId>
  <PreferedCommunicationCode>sample string 15</PreferedCommunicationCode>
  <PreferedLanguageCode>sample string 16</PreferedLanguageCode>
  <RegistrationOrigin>23</RegistrationOrigin>
  <channelId>sample string 21</channelId>
  <currentClassification>sample string 26</currentClassification>
  <journeyId>sample string 22</journeyId>
  <marraigaClassifcation>sample string 27</marraigaClassifcation>
</ContactRegistrationModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RegistrationResponseMessage

Name	Type	Additional information
Code	string	None.
MessageAr	string	None.
MessageEn	string	None.
RegistrationId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Code": "sample string 1",
  "MessageAr": "sample string 2",
  "MessageEn": "sample string 3",
  "RegistrationId": "sample string 4"
}

application/xml, text/xml

Sample:

<RegistrationResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Models">
  <Code>sample string 1</Code>
  <MessageAr>sample string 2</MessageAr>
  <MessageEn>sample string 3</MessageEn>
  <RegistrationId>sample string 4</RegistrationId>
</RegistrationResponseMessage>