GET api/GetExpiringDocuments?idpId={idpId}&expiryWithinDays={expiryWithinDays}&branchList={branchList}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
idpId

string

Required

expiryWithinDays

integer

Required

branchList

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of DocumentExpirationDTO
NameDescriptionTypeAdditional information
AgencyName

string

None.

AgencyEmail

string

None.

EmployeeId

string

None.

EmployeeName

string

None.

DocumentName

string

None.

ExpirationDate

date

None.

EmployeeEmail

string

None.

AssignedBranchName

string

None.

Recruiter

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AgencyName": "sample string 1",
    "AgencyEmail": "sample string 2",
    "EmployeeId": "sample string 3",
    "EmployeeName": "sample string 4",
    "DocumentName": "sample string 5",
    "ExpirationDate": "2026-02-04T01:40:25.5875641-08:00",
    "EmployeeEmail": "sample string 7",
    "AssignedBranchName": "sample string 8",
    "Recruiter": "sample string 9"
  },
  {
    "AgencyName": "sample string 1",
    "AgencyEmail": "sample string 2",
    "EmployeeId": "sample string 3",
    "EmployeeName": "sample string 4",
    "DocumentName": "sample string 5",
    "ExpirationDate": "2026-02-04T01:40:25.5875641-08:00",
    "EmployeeEmail": "sample string 7",
    "AssignedBranchName": "sample string 8",
    "Recruiter": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDocumentExpirationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WurkNowDTO.ClientApi.UnifyApps">
  <DocumentExpirationDTO>
    <AgencyEmail>sample string 2</AgencyEmail>
    <AgencyName>sample string 1</AgencyName>
    <AssignedBranchName>sample string 8</AssignedBranchName>
    <DocumentName>sample string 5</DocumentName>
    <EmployeeEmail>sample string 7</EmployeeEmail>
    <EmployeeId>sample string 3</EmployeeId>
    <EmployeeName>sample string 4</EmployeeName>
    <ExpirationDate>2026-02-04T01:40:25.5875641-08:00</ExpirationDate>
    <Recruiter>sample string 9</Recruiter>
  </DocumentExpirationDTO>
  <DocumentExpirationDTO>
    <AgencyEmail>sample string 2</AgencyEmail>
    <AgencyName>sample string 1</AgencyName>
    <AssignedBranchName>sample string 8</AssignedBranchName>
    <DocumentName>sample string 5</DocumentName>
    <EmployeeEmail>sample string 7</EmployeeEmail>
    <EmployeeId>sample string 3</EmployeeId>
    <EmployeeName>sample string 4</EmployeeName>
    <ExpirationDate>2026-02-04T01:40:25.5875641-08:00</ExpirationDate>
    <Recruiter>sample string 9</Recruiter>
  </DocumentExpirationDTO>
</ArrayOfDocumentExpirationDTO>