POST api/applicant/documents/create/{applicantID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
applicantID

integer

Required

Body Parameters

Collection of RecApplicantDocumentsDTOW
NameDescriptionTypeAdditional information
title

string

Max length: 100

description

string

Max length: 500

document_type_id

integer

Required

other_documents

string

Max length: 100

year_recieved

integer

None.

doc_extension

string

Max length: 50

doc_binary

Collection of byte

None.

doc_size

decimal number

None.

form_data

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "title": "sample string 1",
    "description": "sample string 2",
    "document_type_id": 3,
    "other_documents": "sample string 4",
    "year_recieved": 1,
    "doc_extension": "sample string 5",
    "doc_binary": "QEA=",
    "doc_size": 1.1,
    "form_data": "sample string 6"
  },
  {
    "title": "sample string 1",
    "description": "sample string 2",
    "document_type_id": 3,
    "other_documents": "sample string 4",
    "year_recieved": 1,
    "doc_extension": "sample string 5",
    "doc_binary": "QEA=",
    "doc_size": 1.1,
    "form_data": "sample string 6"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRecApplicantDocumentsDTOW xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Xceed365EngageApi.core.DTOs.Writable">
  <RecApplicantDocumentsDTOW>
    <description>sample string 2</description>
    <doc_binary>QEA=</doc_binary>
    <doc_extension>sample string 5</doc_extension>
    <doc_size>1.1</doc_size>
    <document_type_id>3</document_type_id>
    <form_data>sample string 6</form_data>
    <other_documents>sample string 4</other_documents>
    <title>sample string 1</title>
    <year_recieved>1</year_recieved>
  </RecApplicantDocumentsDTOW>
  <RecApplicantDocumentsDTOW>
    <description>sample string 2</description>
    <doc_binary>QEA=</doc_binary>
    <doc_extension>sample string 5</doc_extension>
    <doc_size>1.1</doc_size>
    <document_type_id>3</document_type_id>
    <form_data>sample string 6</form_data>
    <other_documents>sample string 4</other_documents>
    <title>sample string 1</title>
    <year_recieved>1</year_recieved>
  </RecApplicantDocumentsDTOW>
</ArrayOfRecApplicantDocumentsDTOW>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.