GET api/Consultant/Personality/TaxDocuments?consultantName={consultantName}&candidateName={candidateName}&sentFromDate={sentFromDate}&sentToDate={sentToDate}
Used to fetch a consultant Tax documents
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
consultantName |
This is the string that contained in the consultant name who sent tax document |
string |
Default value is |
candidateName |
This is the string that contained in the candidate name who was sent tax document |
string |
Default value is |
sentFromDate |
This is the date (in string format). if it is provided it gets the results of the tax documents that are sent on or after this date |
string |
Default value is |
sentToDate |
This is the date (in string format). if it is provided it gets the results of the tax documents that are sent on or before this date |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of TaxDocumentSearchResultDataDTOName | Description | Type | Additional information |
---|---|---|---|
CandidateName |
This is Candidate Name |
string |
None. |
CandidateDateOfBirth |
This is Candidate's Date of Birth |
date |
None. |
CandidateNo |
This is Candidate's ID (code) |
string |
None. |
EmployeeNo |
This is Employee No |
string |
None. |
CandidateStatus |
This Candidate status |
string |
None. |
This is Candidate's Email |
string |
None. |
|
Suburb |
This is Candidate's Suburb |
string |
None. |
State |
This is Candidate's State |
string |
None. |
OwningBranch |
This is Candidate's Owning Branch |
string |
None. |
OwningConsultant |
This is Candidate's Owning Consultant |
string |
None. |
TaxDocumentStatus |
This is TFN document's status |
string |
None. |
TaxDocumentStyle |
This is TFN document's style(AU TFN) |
string |
None. |
CreatedOn |
This is Candidate's TFN Document Sent Date |
date |
None. |
TaxDocumentType |
This is Tax Document Type(manual or edoc) |
string |
None. |
EmpTaxDocumentID |
This is Employee Tax DocumentID |
integer |
None. |
TaxDocumentStatusCode |
This is Tax document's status Code |
string |
None. |
DocumentId |
This is DocumentID |
integer |
None. |
Response Formats
application/json, text/json
[ { "CandidateName": "sample string 1", "CandidateDateOfBirth": "2024-06-29T07:41:11.6735095+10:00", "CandidateNo": "sample string 2", "EmployeeNo": "sample string 3", "CandidateStatus": "sample string 4", "Email": "sample string 5", "Suburb": "sample string 6", "State": "sample string 7", "OwningBranch": "sample string 8", "OwningConsultant": "sample string 9", "TaxDocumentStatus": "sample string 10", "TaxDocumentStyle": "sample string 11", "CreatedOn": "2024-06-29T07:41:11.6745174+10:00", "TaxDocumentType": "sample string 12", "EmpTaxDocumentID": 13, "TaxDocumentStatusCode": "sample string 14", "DocumentId": 15 }, { "CandidateName": "sample string 1", "CandidateDateOfBirth": "2024-06-29T07:41:11.6735095+10:00", "CandidateNo": "sample string 2", "EmployeeNo": "sample string 3", "CandidateStatus": "sample string 4", "Email": "sample string 5", "Suburb": "sample string 6", "State": "sample string 7", "OwningBranch": "sample string 8", "OwningConsultant": "sample string 9", "TaxDocumentStatus": "sample string 10", "TaxDocumentStyle": "sample string 11", "CreatedOn": "2024-06-29T07:41:11.6745174+10:00", "TaxDocumentType": "sample string 12", "EmpTaxDocumentID": 13, "TaxDocumentStatusCode": "sample string 14", "DocumentId": 15 } ]
text/xml
<ArrayOfTaxDocumentSearchResultDataDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"> <TaxDocumentSearchResultDataDTO> <CandidateDateOfBirth>2024-06-29T07:41:11.6735095+10:00</CandidateDateOfBirth> <CandidateName>sample string 1</CandidateName> <CandidateNo>sample string 2</CandidateNo> <CandidateStatus>sample string 4</CandidateStatus> <CreatedOn>2024-06-29T07:41:11.6745174+10:00</CreatedOn> <DocumentId>15</DocumentId> <Email>sample string 5</Email> <EmpTaxDocumentID>13</EmpTaxDocumentID> <EmployeeNo>sample string 3</EmployeeNo> <OwningBranch>sample string 8</OwningBranch> <OwningConsultant>sample string 9</OwningConsultant> <State>sample string 7</State> <Suburb>sample string 6</Suburb> <TaxDocumentStatus>sample string 10</TaxDocumentStatus> <TaxDocumentStatusCode>sample string 14</TaxDocumentStatusCode> <TaxDocumentStyle>sample string 11</TaxDocumentStyle> <TaxDocumentType>sample string 12</TaxDocumentType> </TaxDocumentSearchResultDataDTO> <TaxDocumentSearchResultDataDTO> <CandidateDateOfBirth>2024-06-29T07:41:11.6735095+10:00</CandidateDateOfBirth> <CandidateName>sample string 1</CandidateName> <CandidateNo>sample string 2</CandidateNo> <CandidateStatus>sample string 4</CandidateStatus> <CreatedOn>2024-06-29T07:41:11.6745174+10:00</CreatedOn> <DocumentId>15</DocumentId> <Email>sample string 5</Email> <EmpTaxDocumentID>13</EmpTaxDocumentID> <EmployeeNo>sample string 3</EmployeeNo> <OwningBranch>sample string 8</OwningBranch> <OwningConsultant>sample string 9</OwningConsultant> <State>sample string 7</State> <Suburb>sample string 6</Suburb> <TaxDocumentStatus>sample string 10</TaxDocumentStatus> <TaxDocumentStatusCode>sample string 14</TaxDocumentStatusCode> <TaxDocumentStyle>sample string 11</TaxDocumentStyle> <TaxDocumentType>sample string 12</TaxDocumentType> </TaxDocumentSearchResultDataDTO> </ArrayOfTaxDocumentSearchResultDataDTO>
multipart/form-data
<ArrayOfTaxDocumentSearchResultDataDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><TaxDocumentSearchResultDataDTO><CandidateDateOfBirth>2024-06-29T07:41:11.6735095+10:00</CandidateDateOfBirth><CandidateName>sample string 1</CandidateName><CandidateNo>sample string 2</CandidateNo><CandidateStatus>sample string 4</CandidateStatus><CreatedOn>2024-06-29T07:41:11.6745174+10:00</CreatedOn><DocumentId>15</DocumentId><Email>sample string 5</Email><EmpTaxDocumentID>13</EmpTaxDocumentID><EmployeeNo>sample string 3</EmployeeNo><OwningBranch>sample string 8</OwningBranch><OwningConsultant>sample string 9</OwningConsultant><State>sample string 7</State><Suburb>sample string 6</Suburb><TaxDocumentStatus>sample string 10</TaxDocumentStatus><TaxDocumentStatusCode>sample string 14</TaxDocumentStatusCode><TaxDocumentStyle>sample string 11</TaxDocumentStyle><TaxDocumentType>sample string 12</TaxDocumentType></TaxDocumentSearchResultDataDTO><TaxDocumentSearchResultDataDTO><CandidateDateOfBirth>2024-06-29T07:41:11.6735095+10:00</CandidateDateOfBirth><CandidateName>sample string 1</CandidateName><CandidateNo>sample string 2</CandidateNo><CandidateStatus>sample string 4</CandidateStatus><CreatedOn>2024-06-29T07:41:11.6745174+10:00</CreatedOn><DocumentId>15</DocumentId><Email>sample string 5</Email><EmpTaxDocumentID>13</EmpTaxDocumentID><EmployeeNo>sample string 3</EmployeeNo><OwningBranch>sample string 8</OwningBranch><OwningConsultant>sample string 9</OwningConsultant><State>sample string 7</State><Suburb>sample string 6</Suburb><TaxDocumentStatus>sample string 10</TaxDocumentStatus><TaxDocumentStatusCode>sample string 14</TaxDocumentStatusCode><TaxDocumentStyle>sample string 11</TaxDocumentStyle><TaxDocumentType>sample string 12</TaxDocumentType></TaxDocumentSearchResultDataDTO></ArrayOfTaxDocumentSearchResultDataDTO>