POST api/applicant/CreateSocialServiceRequest?lang={lang}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
lang

string

Required

Body Parameters

SocialServiceDetailsViewModel
NameDescriptionTypeAdditional information
Id

string

None.

userId

string

None.

Contact

FullContactRegistrationModel

None.

MainEntityCode

string

None.

MainEntityName

string

None.

MainEntityDescription

string

None.

SubCategoryCode

string

None.

SubCategoryName

string

None.

emiratesId

string

None.

SubCategoryDescription

string

None.

Title

string

None.

appointmentType

string

None.

appointment

string

None.

serviceNo

string

None.

serviceType

string

None.

sourceType

string

None.

CreatedOn

string

None.

Code

string

None.

Name

string

None.

RegionId

string

None.

RegionName

string

None.

CenterId

string

None.

CenterName

string

None.

Location

string

None.

Description

string

None.

ExpectedResponse

string

None.

ProposedStartDate

string

None.

ProposedEndtDate

string

None.

ActualStartDate

string

None.

ActualEndtDate

string

None.

statusCode

string

None.

statusNameAr

string

None.

statusNameEn

string

None.

ModifiedOn

string

None.

TimeSlotId

string

None.

isOnBehalf

boolean

None.

seniorData

SeniorData

None.

FullNameAr

string

None.

FullNameEn

string

None.

Gender

integer

None.

BirthDate

date

None.

Mobile

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "userId": "sample string 2",
  "Contact": {
    "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",
    "channelId": "sample string 20",
    "journeyId": "sample string 21",
    "userName": "sample string 22",
    "password": "sample string 23",
    "city": "sample string 24",
    "area": "sample string 25",
    "howHereAboutUs": 26,
    "workShopId": "sample string 27",
    "marriageStatus": "sample string 28",
    "marriageClassification": "sample string 29",
    "yearofmarriage": "sample string 30"
  },
  "MainEntityCode": "sample string 3",
  "MainEntityName": "sample string 4",
  "MainEntityDescription": "sample string 5",
  "SubCategoryCode": "sample string 6",
  "SubCategoryName": "sample string 7",
  "emiratesId": "sample string 8",
  "SubCategoryDescription": "sample string 9",
  "Title": "sample string 10",
  "appointmentType": "sample string 11",
  "appointment": "sample string 12",
  "serviceNo": "sample string 13",
  "serviceType": "sample string 14",
  "sourceType": "sample string 15",
  "CreatedOn": "sample string 16",
  "Code": "sample string 17",
  "Name": "sample string 18",
  "RegionId": "sample string 19",
  "RegionName": "sample string 20",
  "CenterId": "sample string 21",
  "CenterName": "sample string 22",
  "Location": "sample string 23",
  "Description": "sample string 24",
  "ExpectedResponse": "sample string 25",
  "ProposedStartDate": "sample string 26",
  "ProposedEndtDate": "sample string 27",
  "ActualStartDate": "sample string 28",
  "ActualEndtDate": "sample string 29",
  "statusCode": "sample string 30",
  "statusNameAr": "sample string 31",
  "statusNameEn": "sample string 32",
  "ModifiedOn": "sample string 33",
  "TimeSlotId": "sample string 34",
  "isOnBehalf": true,
  "seniorData": {
    "NationalId": "sample string 1",
    "FullNameAr": "sample string 2",
    "FullNameEn": "sample string 3",
    "Gender": 4,
    "BirthDate": "2024-11-05T14:52:28.5487515+04:00",
    "Mobile": "sample string 6"
  },
  "FullNameAr": "sample string 36",
  "FullNameEn": "sample string 37",
  "Gender": 38,
  "BirthDate": "2024-11-05T14:52:28.5487515+04:00",
  "Mobile": "sample string 40"
}

application/xml, text/xml

Sample:
<SocialServiceDetailsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDF.APIs.Models">
  <ActualEndtDate>sample string 29</ActualEndtDate>
  <ActualStartDate>sample string 28</ActualStartDate>
  <BirthDate>2024-11-05T14:52:28.5487515+04:00</BirthDate>
  <CenterId>sample string 21</CenterId>
  <CenterName>sample string 22</CenterName>
  <Code>sample string 17</Code>
  <Contact>
    <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>
    <area>sample string 25</area>
    <channelId>sample string 20</channelId>
    <city>sample string 24</city>
    <howHereAboutUs>26</howHereAboutUs>
    <journeyId>sample string 21</journeyId>
    <marriageClassification>sample string 29</marriageClassification>
    <marriageStatus>sample string 28</marriageStatus>
    <password>sample string 23</password>
    <userName>sample string 22</userName>
    <workShopId>sample string 27</workShopId>
    <yearofmarriage>sample string 30</yearofmarriage>
  </Contact>
  <CreatedOn>sample string 16</CreatedOn>
  <Description>sample string 24</Description>
  <ExpectedResponse>sample string 25</ExpectedResponse>
  <FullNameAr>sample string 36</FullNameAr>
  <FullNameEn>sample string 37</FullNameEn>
  <Gender>38</Gender>
  <Id>sample string 1</Id>
  <Location>sample string 23</Location>
  <MainEntityCode>sample string 3</MainEntityCode>
  <MainEntityDescription>sample string 5</MainEntityDescription>
  <MainEntityName>sample string 4</MainEntityName>
  <Mobile>sample string 40</Mobile>
  <ModifiedOn>sample string 33</ModifiedOn>
  <Name>sample string 18</Name>
  <ProposedEndtDate>sample string 27</ProposedEndtDate>
  <ProposedStartDate>sample string 26</ProposedStartDate>
  <RegionId>sample string 19</RegionId>
  <RegionName>sample string 20</RegionName>
  <SubCategoryCode>sample string 6</SubCategoryCode>
  <SubCategoryDescription>sample string 9</SubCategoryDescription>
  <SubCategoryName>sample string 7</SubCategoryName>
  <TimeSlotId>sample string 34</TimeSlotId>
  <Title>sample string 10</Title>
  <appointment>sample string 12</appointment>
  <appointmentType>sample string 11</appointmentType>
  <emiratesId>sample string 8</emiratesId>
  <isOnBehalf>true</isOnBehalf>
  <seniorData>
    <BirthDate>2024-11-05T14:52:28.5487515+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>
  <serviceNo>sample string 13</serviceNo>
  <serviceType>sample string 14</serviceType>
  <sourceType>sample string 15</sourceType>
  <statusCode>sample string 30</statusCode>
  <statusNameAr>sample string 31</statusNameAr>
  <statusNameEn>sample string 32</statusNameEn>
  <userId>sample string 2</userId>
</SocialServiceDetailsViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseMessage
NameDescriptionTypeAdditional 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>