POST API/Onboard/GetOnboardEsiData
Request Information
URI Parameters
None.
Body Parameters
ESI_Info| Name | Description | Type | Additional information |
|---|---|---|---|
| ESI_State | string |
None. |
|
| ESI_Dispensary | string |
None. |
|
| ESI_Telephone | string |
None. |
|
| EmployeeFrameId | integer |
None. |
|
| Username | string |
None. |
|
| ESIIsFresher | boolean |
None. |
|
| ESINumber | string |
None. |
|
| ESIDependancyDetails | Collection of ESIDependancyDetails |
None. |
|
| returnErrorMessage | string |
None. |
|
| returnStatus | boolean |
None. |
|
| ClientId | string |
None. |
|
| clientName | string |
None. |
|
| Connectionstring | string |
None. |
|
| DocumentURL | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedDate | date |
None. |
|
| ModifiedBy | string |
None. |
|
| ModifiedDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"ESI_State": "sample string 1",
"ESI_Dispensary": "sample string 2",
"ESI_Telephone": "sample string 3",
"EmployeeFrameId": 4,
"Username": "sample string 5",
"ESIIsFresher": true,
"ESINumber": "sample string 7",
"ESIDependancyDetails": [
{
"ESIDependancyID": 1,
"EmployeeFrameId": 2,
"RelationShip": "sample string 3",
"RelationName": "sample string 4",
"DOB": "2026-01-10T14:15:09.6673771+05:30",
"AadharCardNo": "sample string 6",
"AadharCardPhoto": "sample string 7",
"AadharCardPhotoURL": "sample string 8",
"RelationPhoto": "sample string 9",
"RelationPhotoURL": "sample string 10",
"returnErrorMessage": "sample string 11",
"returnStatus": true,
"ClientId": "sample string 13",
"clientName": "sample string 14",
"Connectionstring": "sample string 15",
"DocumentURL": "sample string 16",
"CreatedBy": "sample string 17",
"CreatedDate": "2026-01-10T14:15:09.6673771+05:30",
"ModifiedBy": "sample string 19",
"ModifiedDate": "2026-01-10T14:15:09.6673771+05:30"
},
{
"ESIDependancyID": 1,
"EmployeeFrameId": 2,
"RelationShip": "sample string 3",
"RelationName": "sample string 4",
"DOB": "2026-01-10T14:15:09.6673771+05:30",
"AadharCardNo": "sample string 6",
"AadharCardPhoto": "sample string 7",
"AadharCardPhotoURL": "sample string 8",
"RelationPhoto": "sample string 9",
"RelationPhotoURL": "sample string 10",
"returnErrorMessage": "sample string 11",
"returnStatus": true,
"ClientId": "sample string 13",
"clientName": "sample string 14",
"Connectionstring": "sample string 15",
"DocumentURL": "sample string 16",
"CreatedBy": "sample string 17",
"CreatedDate": "2026-01-10T14:15:09.6673771+05:30",
"ModifiedBy": "sample string 19",
"ModifiedDate": "2026-01-10T14:15:09.6673771+05:30"
}
],
"returnErrorMessage": "sample string 8",
"returnStatus": true,
"ClientId": "sample string 10",
"clientName": "sample string 11",
"Connectionstring": "sample string 12",
"DocumentURL": "sample string 13",
"CreatedBy": "sample string 14",
"CreatedDate": "2026-01-10T14:15:09.6673771+05:30",
"ModifiedBy": "sample string 16",
"ModifiedDate": "2026-01-10T14:15:09.6673771+05:30"
}
application/xml, text/xml
Sample:
<ESI_Info xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommonWebAPI.Entity">
<ClientId>sample string 10</ClientId>
<Connectionstring>sample string 12</Connectionstring>
<CreatedBy>sample string 14</CreatedBy>
<CreatedDate>2026-01-10T14:15:09.6673771+05:30</CreatedDate>
<DocumentURL>sample string 13</DocumentURL>
<ModifiedBy>sample string 16</ModifiedBy>
<ModifiedDate>2026-01-10T14:15:09.6673771+05:30</ModifiedDate>
<clientName>sample string 11</clientName>
<returnErrorMessage>sample string 8</returnErrorMessage>
<returnStatus>true</returnStatus>
<ESIDependancyDetails>
<ESIDependancyDetails>
<ClientId>sample string 13</ClientId>
<Connectionstring>sample string 15</Connectionstring>
<CreatedBy>sample string 17</CreatedBy>
<CreatedDate>2026-01-10T14:15:09.6673771+05:30</CreatedDate>
<DocumentURL>sample string 16</DocumentURL>
<ModifiedBy>sample string 19</ModifiedBy>
<ModifiedDate>2026-01-10T14:15:09.6673771+05:30</ModifiedDate>
<clientName>sample string 14</clientName>
<returnErrorMessage>sample string 11</returnErrorMessage>
<returnStatus>true</returnStatus>
<AadharCardNo>sample string 6</AadharCardNo>
<AadharCardPhoto>sample string 7</AadharCardPhoto>
<AadharCardPhotoURL>sample string 8</AadharCardPhotoURL>
<DOB>2026-01-10T14:15:09.6673771+05:30</DOB>
<ESIDependancyID>1</ESIDependancyID>
<EmployeeFrameId>2</EmployeeFrameId>
<RelationName>sample string 4</RelationName>
<RelationPhoto>sample string 9</RelationPhoto>
<RelationPhotoURL>sample string 10</RelationPhotoURL>
<RelationShip>sample string 3</RelationShip>
</ESIDependancyDetails>
<ESIDependancyDetails>
<ClientId>sample string 13</ClientId>
<Connectionstring>sample string 15</Connectionstring>
<CreatedBy>sample string 17</CreatedBy>
<CreatedDate>2026-01-10T14:15:09.6673771+05:30</CreatedDate>
<DocumentURL>sample string 16</DocumentURL>
<ModifiedBy>sample string 19</ModifiedBy>
<ModifiedDate>2026-01-10T14:15:09.6673771+05:30</ModifiedDate>
<clientName>sample string 14</clientName>
<returnErrorMessage>sample string 11</returnErrorMessage>
<returnStatus>true</returnStatus>
<AadharCardNo>sample string 6</AadharCardNo>
<AadharCardPhoto>sample string 7</AadharCardPhoto>
<AadharCardPhotoURL>sample string 8</AadharCardPhotoURL>
<DOB>2026-01-10T14:15:09.6673771+05:30</DOB>
<ESIDependancyID>1</ESIDependancyID>
<EmployeeFrameId>2</EmployeeFrameId>
<RelationName>sample string 4</RelationName>
<RelationPhoto>sample string 9</RelationPhoto>
<RelationPhotoURL>sample string 10</RelationPhotoURL>
<RelationShip>sample string 3</RelationShip>
</ESIDependancyDetails>
</ESIDependancyDetails>
<ESIIsFresher>true</ESIIsFresher>
<ESINumber>sample string 7</ESINumber>
<ESI_Dispensary>sample string 2</ESI_Dispensary>
<ESI_State>sample string 1</ESI_State>
<ESI_Telephone>sample string 3</ESI_Telephone>
<EmployeeFrameId>4</EmployeeFrameId>
<Username>sample string 5</Username>
</ESI_Info>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |