GET api/DeliveryAgent/Agents/GetDeliveryAgentDocuments?DeliveryAgentID={DeliveryAgentID}

Request Information

URI Parameters

Name	Description	Type	Additional information
DeliveryAgentID		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of DeliveryAgentDocumentDtlsModel

Name	Type	Additional information
DocumentID	integer	None.
DeliveryAgentID	string	Required
MainDocTypeID	string	Required
MainDocTypeName	string	None.
MainDocTypeDescription	string	None.
SelectedDocTypeID	string	None.
SelectedDocTypeName	string	None.
SelectedDocTypeDescription	string	None.
IsRequired	boolean	None.
HasValidity	boolean	None.
MustRenew	boolean	None.
AgentCanView	boolean	None.
ValidityDate	date	Data type: Date
UploadedDocuments	Collection of DeliveryAgentUploadedDocumentDtlsModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentID": 1,
    "DeliveryAgentID": "sample string 2",
    "MainDocTypeID": "sample string 3",
    "MainDocTypeName": "sample string 4",
    "MainDocTypeDescription": "sample string 5",
    "SelectedDocTypeID": "sample string 6",
    "SelectedDocTypeName": "sample string 7",
    "SelectedDocTypeDescription": "sample string 8",
    "IsRequired": true,
    "HasValidity": true,
    "MustRenew": true,
    "AgentCanView": true,
    "ValidityDate": "2025-12-07T09:56:12.9317251+05:30",
    "UploadedDocuments": [
      {
        "DocumentID": 1,
        "DeliveryAgentID": "sample string 2",
        "UploadedDocument": "sample string 3",
        "DocumentDescription": "sample string 4",
        "DocTypeID": "sample string 5",
        "DocTypeName": "sample string 6",
        "DocTypeDescription": "sample string 7",
        "IsRequired": true
      },
      {
        "DocumentID": 1,
        "DeliveryAgentID": "sample string 2",
        "UploadedDocument": "sample string 3",
        "DocumentDescription": "sample string 4",
        "DocTypeID": "sample string 5",
        "DocTypeName": "sample string 6",
        "DocTypeDescription": "sample string 7",
        "IsRequired": true
      }
    ]
  },
  {
    "DocumentID": 1,
    "DeliveryAgentID": "sample string 2",
    "MainDocTypeID": "sample string 3",
    "MainDocTypeName": "sample string 4",
    "MainDocTypeDescription": "sample string 5",
    "SelectedDocTypeID": "sample string 6",
    "SelectedDocTypeName": "sample string 7",
    "SelectedDocTypeDescription": "sample string 8",
    "IsRequired": true,
    "HasValidity": true,
    "MustRenew": true,
    "AgentCanView": true,
    "ValidityDate": "2025-12-07T09:56:12.9317251+05:30",
    "UploadedDocuments": [
      {
        "DocumentID": 1,
        "DeliveryAgentID": "sample string 2",
        "UploadedDocument": "sample string 3",
        "DocumentDescription": "sample string 4",
        "DocTypeID": "sample string 5",
        "DocTypeName": "sample string 6",
        "DocTypeDescription": "sample string 7",
        "IsRequired": true
      },
      {
        "DocumentID": 1,
        "DeliveryAgentID": "sample string 2",
        "UploadedDocument": "sample string 3",
        "DocumentDescription": "sample string 4",
        "DocTypeID": "sample string 5",
        "DocTypeName": "sample string 6",
        "DocTypeDescription": "sample string 7",
        "IsRequired": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfDeliveryAgentDocumentDtlsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DeliveryAgent.Operations.CustomModels">
  <DeliveryAgentDocumentDtlsModel>
    <AgentCanView>true</AgentCanView>
    <DeliveryAgentID>sample string 2</DeliveryAgentID>
    <DocumentID>1</DocumentID>
    <HasValidity>true</HasValidity>
    <IsRequired>true</IsRequired>
    <MainDocTypeDescription>sample string 5</MainDocTypeDescription>
    <MainDocTypeID>sample string 3</MainDocTypeID>
    <MainDocTypeName>sample string 4</MainDocTypeName>
    <MustRenew>true</MustRenew>
    <SelectedDocTypeDescription>sample string 8</SelectedDocTypeDescription>
    <SelectedDocTypeID>sample string 6</SelectedDocTypeID>
    <SelectedDocTypeName>sample string 7</SelectedDocTypeName>
    <UploadedDocuments>
      <DeliveryAgentUploadedDocumentDtlsModel>
        <DeliveryAgentID>sample string 2</DeliveryAgentID>
        <DocTypeDescription>sample string 7</DocTypeDescription>
        <DocTypeID>sample string 5</DocTypeID>
        <DocTypeName>sample string 6</DocTypeName>
        <DocumentDescription>sample string 4</DocumentDescription>
        <DocumentID>1</DocumentID>
        <IsRequired>true</IsRequired>
        <UploadedDocument>sample string 3</UploadedDocument>
      </DeliveryAgentUploadedDocumentDtlsModel>
      <DeliveryAgentUploadedDocumentDtlsModel>
        <DeliveryAgentID>sample string 2</DeliveryAgentID>
        <DocTypeDescription>sample string 7</DocTypeDescription>
        <DocTypeID>sample string 5</DocTypeID>
        <DocTypeName>sample string 6</DocTypeName>
        <DocumentDescription>sample string 4</DocumentDescription>
        <DocumentID>1</DocumentID>
        <IsRequired>true</IsRequired>
        <UploadedDocument>sample string 3</UploadedDocument>
      </DeliveryAgentUploadedDocumentDtlsModel>
    </UploadedDocuments>
    <ValidityDate>2025-12-07T09:56:12.9317251+05:30</ValidityDate>
  </DeliveryAgentDocumentDtlsModel>
  <DeliveryAgentDocumentDtlsModel>
    <AgentCanView>true</AgentCanView>
    <DeliveryAgentID>sample string 2</DeliveryAgentID>
    <DocumentID>1</DocumentID>
    <HasValidity>true</HasValidity>
    <IsRequired>true</IsRequired>
    <MainDocTypeDescription>sample string 5</MainDocTypeDescription>
    <MainDocTypeID>sample string 3</MainDocTypeID>
    <MainDocTypeName>sample string 4</MainDocTypeName>
    <MustRenew>true</MustRenew>
    <SelectedDocTypeDescription>sample string 8</SelectedDocTypeDescription>
    <SelectedDocTypeID>sample string 6</SelectedDocTypeID>
    <SelectedDocTypeName>sample string 7</SelectedDocTypeName>
    <UploadedDocuments>
      <DeliveryAgentUploadedDocumentDtlsModel>
        <DeliveryAgentID>sample string 2</DeliveryAgentID>
        <DocTypeDescription>sample string 7</DocTypeDescription>
        <DocTypeID>sample string 5</DocTypeID>
        <DocTypeName>sample string 6</DocTypeName>
        <DocumentDescription>sample string 4</DocumentDescription>
        <DocumentID>1</DocumentID>
        <IsRequired>true</IsRequired>
        <UploadedDocument>sample string 3</UploadedDocument>
      </DeliveryAgentUploadedDocumentDtlsModel>
      <DeliveryAgentUploadedDocumentDtlsModel>
        <DeliveryAgentID>sample string 2</DeliveryAgentID>
        <DocTypeDescription>sample string 7</DocTypeDescription>
        <DocTypeID>sample string 5</DocTypeID>
        <DocTypeName>sample string 6</DocTypeName>
        <DocumentDescription>sample string 4</DocumentDescription>
        <DocumentID>1</DocumentID>
        <IsRequired>true</IsRequired>
        <UploadedDocument>sample string 3</UploadedDocument>
      </DeliveryAgentUploadedDocumentDtlsModel>
    </UploadedDocuments>
    <ValidityDate>2025-12-07T09:56:12.9317251+05:30</ValidityDate>
  </DeliveryAgentDocumentDtlsModel>
</ArrayOfDeliveryAgentDocumentDtlsModel>