POST api/Candidate
Request Information
URI Parameters
None.
Body Parameters
ShortCandidateName | Description | Type | Additional information |
---|---|---|---|
id | integer |
None. |
|
companyId | integer |
None. |
|
name | string |
None. |
|
string |
None. |
||
mobile | string |
None. |
|
isActive | boolean |
None. |
|
isArchived | boolean |
None. |
|
positionId | integer |
None. |
|
positionName | string |
None. |
|
status | string |
None. |
|
statusDate | string |
None. |
|
linkid | string |
None. |
|
candidateStatus | string |
None. |
|
candidateCreated | string |
None. |
|
requesterEmail | string |
None. |
|
statusId | integer |
None. |
|
refDone | integer |
None. |
|
refTotal | integer |
None. |
|
refRefused | integer |
None. |
|
refRefusedByApp | integer |
None. |
|
sendText | boolean |
None. |
|
sendEmail | boolean |
None. |
|
apiKey | string |
None. |
|
linkExpiration | date |
None. |
|
ExpireDays | integer |
None. |
|
WarningPct | integer |
None. |
|
UrgentPct | integer |
None. |
|
references | Collection of ShortCandidateReference |
None. |
Request Formats
application/json, text/json
Sample:
{ "id": 1, "companyId": 2, "name": "sample string 3", "email": "sample string 4", "mobile": "sample string 5", "isActive": true, "isArchived": true, "positionId": 8, "positionName": "sample string 9", "status": "sample string 10", "statusDate": "sample string 11", "linkid": "sample string 12", "candidateStatus": "sample string 13", "candidateCreated": "sample string 14", "requesterEmail": "sample string 15", "statusId": 16, "refDone": 17, "refTotal": 18, "refRefused": 19, "refRefusedByApp": 20, "sendText": true, "sendEmail": true, "apiKey": "sample string 22", "linkExpiration": "2025-03-24T04:05:01.8501251+00:00", "ExpireDays": 24, "WarningPct": 25, "UrgentPct": 26, "references": [ { "email": "sample string 1", "name": "sample string 2", "surveyName": "sample string 3", "referenceRole": "sample string 4", "linkId": "69ef86f8-42a4-4d15-84ca-c25254320c33", "responseStatus": "sample string 5", "responseDateTime": "2025-03-24T04:05:01.8501251+00:00", "linkExpiration": "2025-03-24T04:05:01.8501251+00:00", "cellNumber": "sample string 6", "neededId": 7, "referenceId": 1, "crId": 1, "isRefusedByApplicant": true, "isRefusedByReference": true, "roleId": 10, "sendText": true, "sendEmail": true, "refuseReason": "sample string 13" }, { "email": "sample string 1", "name": "sample string 2", "surveyName": "sample string 3", "referenceRole": "sample string 4", "linkId": "69ef86f8-42a4-4d15-84ca-c25254320c33", "responseStatus": "sample string 5", "responseDateTime": "2025-03-24T04:05:01.8501251+00:00", "linkExpiration": "2025-03-24T04:05:01.8501251+00:00", "cellNumber": "sample string 6", "neededId": 7, "referenceId": 1, "crId": 1, "isRefusedByApplicant": true, "isRefusedByReference": true, "roleId": 10, "sendText": true, "sendEmail": true, "refuseReason": "sample string 13" } ] }
application/xml, text/xml
Sample:
<ShortCandidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoRefCheck.Data"> <ExpireDays>24</ExpireDays> <UrgentPct>26</UrgentPct> <WarningPct>25</WarningPct> <apiKey>sample string 22</apiKey> <candidateCreated>sample string 14</candidateCreated> <candidateStatus>sample string 13</candidateStatus> <companyId>2</companyId> <email>sample string 4</email> <id>1</id> <isActive>true</isActive> <isArchived>true</isArchived> <linkExpiration>2025-03-24T04:05:01.8501251+00:00</linkExpiration> <linkid>sample string 12</linkid> <mobile>sample string 5</mobile> <name>sample string 3</name> <positionId>8</positionId> <positionName>sample string 9</positionName> <refDone>17</refDone> <refRefused>19</refRefused> <refRefusedByApp>20</refRefusedByApp> <refTotal>18</refTotal> <references> <ShortCandidateReference> <cellNumber>sample string 6</cellNumber> <crId>1</crId> <email>sample string 1</email> <isRefusedByApplicant>true</isRefusedByApplicant> <isRefusedByReference>true</isRefusedByReference> <linkExpiration>2025-03-24T04:05:01.8501251+00:00</linkExpiration> <linkId>69ef86f8-42a4-4d15-84ca-c25254320c33</linkId> <name>sample string 2</name> <neededId>7</neededId> <referenceId>1</referenceId> <referenceRole>sample string 4</referenceRole> <refuseReason>sample string 13</refuseReason> <responseDateTime>2025-03-24T04:05:01.8501251+00:00</responseDateTime> <responseStatus>sample string 5</responseStatus> <roleId>10</roleId> <sendEmail>true</sendEmail> <sendText>true</sendText> <surveyName>sample string 3</surveyName> </ShortCandidateReference> <ShortCandidateReference> <cellNumber>sample string 6</cellNumber> <crId>1</crId> <email>sample string 1</email> <isRefusedByApplicant>true</isRefusedByApplicant> <isRefusedByReference>true</isRefusedByReference> <linkExpiration>2025-03-24T04:05:01.8501251+00:00</linkExpiration> <linkId>69ef86f8-42a4-4d15-84ca-c25254320c33</linkId> <name>sample string 2</name> <neededId>7</neededId> <referenceId>1</referenceId> <referenceRole>sample string 4</referenceRole> <refuseReason>sample string 13</refuseReason> <responseDateTime>2025-03-24T04:05:01.8501251+00:00</responseDateTime> <responseStatus>sample string 5</responseStatus> <roleId>10</roleId> <sendEmail>true</sendEmail> <sendText>true</sendText> <surveyName>sample string 3</surveyName> </ShortCandidateReference> </references> <requesterEmail>sample string 15</requesterEmail> <sendEmail>true</sendEmail> <sendText>true</sendText> <status>sample string 10</status> <statusDate>sample string 11</statusDate> <statusId>16</statusId> </ShortCandidate>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | 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. |