GET api/applicant/application/GenerateAllRequiredDocuments?code={code}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
code

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of MCDocumentGroupGetDTO
NameDescriptionTypeAdditional information
DocGroupID

integer

None.

DocGroupName

string

None.

IsGroupMandatory

boolean

None.

Documents

Collection of MCDocumentOptionGetDTO

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DocGroupID": 1,
    "DocGroupName": "sample string 2",
    "IsGroupMandatory": true,
    "Documents": [
      {
        "MapDocID": 1,
        "DocumentID": 2,
        "DocumentName": "sample string 3",
        "DocumentCode": "sample string 4",
        "AllowedFileTypes": "sample string 5",
        "MaxFileSizeMB": 6,
        "IsMandatory": true,
        "AppDocID": "sample string 8",
        "IsGroomDoc": true,
        "IsBrideDoc": true,
        "DocFilePath": "sample string 9"
      },
      {
        "MapDocID": 1,
        "DocumentID": 2,
        "DocumentName": "sample string 3",
        "DocumentCode": "sample string 4",
        "AllowedFileTypes": "sample string 5",
        "MaxFileSizeMB": 6,
        "IsMandatory": true,
        "AppDocID": "sample string 8",
        "IsGroomDoc": true,
        "IsBrideDoc": true,
        "DocFilePath": "sample string 9"
      }
    ]
  },
  {
    "DocGroupID": 1,
    "DocGroupName": "sample string 2",
    "IsGroupMandatory": true,
    "Documents": [
      {
        "MapDocID": 1,
        "DocumentID": 2,
        "DocumentName": "sample string 3",
        "DocumentCode": "sample string 4",
        "AllowedFileTypes": "sample string 5",
        "MaxFileSizeMB": 6,
        "IsMandatory": true,
        "AppDocID": "sample string 8",
        "IsGroomDoc": true,
        "IsBrideDoc": true,
        "DocFilePath": "sample string 9"
      },
      {
        "MapDocID": 1,
        "DocumentID": 2,
        "DocumentName": "sample string 3",
        "DocumentCode": "sample string 4",
        "AllowedFileTypes": "sample string 5",
        "MaxFileSizeMB": 6,
        "IsMandatory": true,
        "AppDocID": "sample string 8",
        "IsGroomDoc": true,
        "IsBrideDoc": true,
        "DocFilePath": "sample string 9"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfMCDocumentGroupGetDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Married.Entities.customsmodels">
  <MCDocumentGroupGetDTO>
    <DocGroupID>1</DocGroupID>
    <DocGroupName>sample string 2</DocGroupName>
    <Documents>
      <MCDocumentOptionGetDTO>
        <AllowedFileTypes>sample string 5</AllowedFileTypes>
        <AppDocID>sample string 8</AppDocID>
        <DocFilePath>sample string 9</DocFilePath>
        <DocumentCode>sample string 4</DocumentCode>
        <DocumentID>2</DocumentID>
        <DocumentName>sample string 3</DocumentName>
        <IsBrideDoc>true</IsBrideDoc>
        <IsGroomDoc>true</IsGroomDoc>
        <IsMandatory>true</IsMandatory>
        <MapDocID>1</MapDocID>
        <MaxFileSizeMB>6</MaxFileSizeMB>
      </MCDocumentOptionGetDTO>
      <MCDocumentOptionGetDTO>
        <AllowedFileTypes>sample string 5</AllowedFileTypes>
        <AppDocID>sample string 8</AppDocID>
        <DocFilePath>sample string 9</DocFilePath>
        <DocumentCode>sample string 4</DocumentCode>
        <DocumentID>2</DocumentID>
        <DocumentName>sample string 3</DocumentName>
        <IsBrideDoc>true</IsBrideDoc>
        <IsGroomDoc>true</IsGroomDoc>
        <IsMandatory>true</IsMandatory>
        <MapDocID>1</MapDocID>
        <MaxFileSizeMB>6</MaxFileSizeMB>
      </MCDocumentOptionGetDTO>
    </Documents>
    <IsGroupMandatory>true</IsGroupMandatory>
  </MCDocumentGroupGetDTO>
  <MCDocumentGroupGetDTO>
    <DocGroupID>1</DocGroupID>
    <DocGroupName>sample string 2</DocGroupName>
    <Documents>
      <MCDocumentOptionGetDTO>
        <AllowedFileTypes>sample string 5</AllowedFileTypes>
        <AppDocID>sample string 8</AppDocID>
        <DocFilePath>sample string 9</DocFilePath>
        <DocumentCode>sample string 4</DocumentCode>
        <DocumentID>2</DocumentID>
        <DocumentName>sample string 3</DocumentName>
        <IsBrideDoc>true</IsBrideDoc>
        <IsGroomDoc>true</IsGroomDoc>
        <IsMandatory>true</IsMandatory>
        <MapDocID>1</MapDocID>
        <MaxFileSizeMB>6</MaxFileSizeMB>
      </MCDocumentOptionGetDTO>
      <MCDocumentOptionGetDTO>
        <AllowedFileTypes>sample string 5</AllowedFileTypes>
        <AppDocID>sample string 8</AppDocID>
        <DocFilePath>sample string 9</DocFilePath>
        <DocumentCode>sample string 4</DocumentCode>
        <DocumentID>2</DocumentID>
        <DocumentName>sample string 3</DocumentName>
        <IsBrideDoc>true</IsBrideDoc>
        <IsGroomDoc>true</IsGroomDoc>
        <IsMandatory>true</IsMandatory>
        <MapDocID>1</MapDocID>
        <MaxFileSizeMB>6</MaxFileSizeMB>
      </MCDocumentOptionGetDTO>
    </Documents>
    <IsGroupMandatory>true</IsGroupMandatory>
  </MCDocumentGroupGetDTO>
</ArrayOfMCDocumentGroupGetDTO>