POST api/applicant/PODApplicantRegister

Request Information

URI Parameters

None.

Body Parameters

RegisterApplicant
NameDescriptionTypeAdditional information
EventId

string

None.

applicationNumber

string

None.

CourseId

Collection of string

None.

Husband

NewApplicant

None.

Wife

NewApplicant

None.

Request Formats

application/json, text/json

Sample:
{
  "EventId": "sample string 1",
  "applicationNumber": "sample string 2",
  "CourseId": [
    "sample string 1",
    "sample string 2"
  ],
  "Husband": {
    "EmiratesId": "sample string 1",
    "NameAr": "sample string 2",
    "NameEn": "sample string 3",
    "FatherEid": "sample string 4",
    "DOB": "sample string 5",
    "DisabilityType": {
      "DescriptionArabic": "sample string 1",
      "DescriptionEnglish": "sample string 2",
      "Code": "sample string 3"
    },
    "Mobile": "sample string 6",
    "SecondaryMobile": "sample string 7",
    "Email": "sample string 8",
    "EducationLevel": "sample string 9",
    "Emirates": 10,
    "City": 11,
    "Gender": 12,
    "Area": 13
  },
  "Wife": {
    "EmiratesId": "sample string 1",
    "NameAr": "sample string 2",
    "NameEn": "sample string 3",
    "FatherEid": "sample string 4",
    "DOB": "sample string 5",
    "DisabilityType": {
      "DescriptionArabic": "sample string 1",
      "DescriptionEnglish": "sample string 2",
      "Code": "sample string 3"
    },
    "Mobile": "sample string 6",
    "SecondaryMobile": "sample string 7",
    "Email": "sample string 8",
    "EducationLevel": "sample string 9",
    "Emirates": 10,
    "City": 11,
    "Gender": 12,
    "Area": 13
  }
}

application/xml, text/xml

Sample:
<PODApplicant.RegisterApplicant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Models">
  <CourseId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CourseId>
  <EventId>sample string 1</EventId>
  <Husband>
    <Area>13</Area>
    <City>11</City>
    <DOB>sample string 5</DOB>
    <DisabilityType>
      <Code>sample string 3</Code>
      <DescriptionArabic>sample string 1</DescriptionArabic>
      <DescriptionEnglish>sample string 2</DescriptionEnglish>
    </DisabilityType>
    <EducationLevel>sample string 9</EducationLevel>
    <Email>sample string 8</Email>
    <Emirates>10</Emirates>
    <EmiratesId>sample string 1</EmiratesId>
    <FatherEid>sample string 4</FatherEid>
    <Gender>12</Gender>
    <Mobile>sample string 6</Mobile>
    <NameAr>sample string 2</NameAr>
    <NameEn>sample string 3</NameEn>
    <SecondaryMobile>sample string 7</SecondaryMobile>
  </Husband>
  <Wife>
    <Area>13</Area>
    <City>11</City>
    <DOB>sample string 5</DOB>
    <DisabilityType>
      <Code>sample string 3</Code>
      <DescriptionArabic>sample string 1</DescriptionArabic>
      <DescriptionEnglish>sample string 2</DescriptionEnglish>
    </DisabilityType>
    <EducationLevel>sample string 9</EducationLevel>
    <Email>sample string 8</Email>
    <Emirates>10</Emirates>
    <EmiratesId>sample string 1</EmiratesId>
    <FatherEid>sample string 4</FatherEid>
    <Gender>12</Gender>
    <Mobile>sample string 6</Mobile>
    <NameAr>sample string 2</NameAr>
    <NameEn>sample string 3</NameEn>
    <SecondaryMobile>sample string 7</SecondaryMobile>
  </Wife>
  <applicationNumber>sample string 2</applicationNumber>
</PODApplicant.RegisterApplicant>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseData
NameDescriptionTypeAdditional information
Content

Collection of string

None.

StatusDescriptionEnglish

string

None.

StatusCode

integer

None.

StatusDescriptionArabic

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Content": [
    "sample string 1",
    "sample string 2"
  ],
  "StatusDescriptionEnglish": "sample string 1",
  "StatusCode": 2,
  "StatusDescriptionArabic": "sample string 3"
}

application/xml, text/xml

Sample:
<PODApplicant.ResponseData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Models">
  <Content xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Content>
  <StatusCode>2</StatusCode>
  <StatusDescriptionArabic>sample string 3</StatusDescriptionArabic>
  <StatusDescriptionEnglish>sample string 1</StatusDescriptionEnglish>
</PODApplicant.ResponseData>