POST api/applicant/HomePageRegisterWebsite

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
NationalId	string	None.
email	string	None.
programCode	string	None.
mobile	string	None.
BirthDate	date	None.
FullnameEn	string	None.
FullnameAr	string	None.
FirstName	string	None.
LastName	string	None.
Nationality	globally unique identifier	None.
Gender	integer	None.
Resident	globally unique identifier	None.
EducationLevel	integer	None.
MaritalStatus	integer	None.
RegistrationOrigin	integer	None.
ChannelId	string	None.
Origin	integer	None.
Emirate	globally unique identifier	None.
Region	globally unique identifier	None.
IsOnBehalf	boolean	None.
seniorData	SeniorData	None.
marriageStatus	string	None.
marriageClassification	string	None.

Request Formats

application/json, text/json

Sample:

{
  "NationalId": "sample string 1",
  "email": "sample string 2",
  "programCode": "sample string 3",
  "mobile": "sample string 4",
  "BirthDate": "2024-11-05T15:00:09.2377238+04:00",
  "FullnameEn": "sample string 6",
  "FullnameAr": "sample string 7",
  "FirstName": "sample string 8",
  "LastName": "sample string 9",
  "Nationality": "ba0fe99c-1cb5-40a4-aaab-ae3d4574eb32",
  "Gender": 11,
  "Resident": "c237858d-3542-4038-9129-ad6fca412f10",
  "EducationLevel": 13,
  "MaritalStatus": 14,
  "RegistrationOrigin": 15,
  "ChannelId": "sample string 16",
  "Origin": 17,
  "Emirate": "4aaaa307-2f13-4289-8e46-45527edd176f",
  "Region": "be90dd8d-0c39-4e09-9526-392b4ad9b51c",
  "IsOnBehalf": true,
  "seniorData": {
    "NationalId": "sample string 1",
    "FullNameAr": "sample string 2",
    "FullNameEn": "sample string 3",
    "Gender": 4,
    "BirthDate": "2024-11-05T15:00:09.2377238+04:00",
    "Mobile": "sample string 6"
  },
  "marriageStatus": "sample string 19",
  "marriageClassification": "sample string 20"
}

application/xml, text/xml

Sample:

<ProgramRegistrationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Models">
  <BirthDate>2024-11-05T15:00:09.2377238+04:00</BirthDate>
  <ChannelId>sample string 16</ChannelId>
  <EducationLevel>13</EducationLevel>
  <Emirate>4aaaa307-2f13-4289-8e46-45527edd176f</Emirate>
  <FirstName>sample string 8</FirstName>
  <FullnameAr>sample string 7</FullnameAr>
  <FullnameEn>sample string 6</FullnameEn>
  <Gender>11</Gender>
  <IsOnBehalf>true</IsOnBehalf>
  <LastName>sample string 9</LastName>
  <MaritalStatus>14</MaritalStatus>
  <NationalId>sample string 1</NationalId>
  <Nationality>ba0fe99c-1cb5-40a4-aaab-ae3d4574eb32</Nationality>
  <Origin>17</Origin>
  <Region>be90dd8d-0c39-4e09-9526-392b4ad9b51c</Region>
  <RegistrationOrigin>15</RegistrationOrigin>
  <Resident>c237858d-3542-4038-9129-ad6fca412f10</Resident>
  <email>sample string 2</email>
  <marriageClassification>sample string 20</marriageClassification>
  <marriageStatus>sample string 19</marriageStatus>
  <mobile>sample string 4</mobile>
  <programCode>sample string 3</programCode>
  <seniorData>
    <BirthDate>2024-11-05T15:00:09.2377238+04:00</BirthDate>
    <FullNameAr>sample string 2</FullNameAr>
    <FullNameEn>sample string 3</FullNameEn>
    <Gender>4</Gender>
    <Mobile>sample string 6</Mobile>
    <NationalId>sample string 1</NationalId>
  </seniorData>
</ProgramRegistrationViewModel>

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>