POST uploadfundingdocument

Request Information

URI Parameters

None.

Body Parameters

FundingDocumentUploadRequest
NameDescriptionTypeAdditional information
UserId

string

Required

TransactionRef

string

None.

DocumentType

integer

None.

FileName

string

Required

FileType

string

None.

UserFundingId

integer

None.

FileBase64

string

Required

FileSize

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1",
  "TransactionRef": "sample string 2",
  "DocumentType": 1,
  "FileName": "sample string 3",
  "FileType": "sample string 4",
  "UserFundingId": 1,
  "FileBase64": "sample string 5",
  "FileSize": 6
}

application/xml, text/xml

Sample:
<FundingDocumentUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <DocumentType>1</DocumentType>
  <FileBase64>sample string 5</FileBase64>
  <FileName>sample string 3</FileName>
  <FileSize>6</FileSize>
  <FileType>sample string 4</FileType>
  <TransactionRef>sample string 2</TransactionRef>
  <UserFundingId>1</UserFundingId>
  <UserId>sample string 1</UserId>
</FundingDocumentUploadRequest>

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 'FundingDocumentUploadRequest'.

Response Information

Resource Description

FundingDocumentResultModel
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Data

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Data": {}
}

application/xml, text/xml

Sample:
<FundingDocumentResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Data />
  <Message>sample string 2</Message>
  <Success>true</Success>
</FundingDocumentResultModel>