POST api/vendors/import?validateWarnings={validateWarnings}

Vendor Import

Request Information

URI Parameters

NameDescriptionTypeAdditional information
validateWarnings

Is warnings validated

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

The result can come in the form of all objects that derive from ImportFileErrorViewModel

Collection of ReturnImportErrorViewModel
NameDescriptionTypeAdditional information
ErrorMessage

Error Message Comma separated

string

None.

LineNumber

Line Number of the file; offset by 1

integer

None.

LineItem

Line Item The original line in the import file

string

None.

ColumnName

Column Name The column name that generate the error

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "errorMessage": "sample string 1",
    "lineNumber": 2,
    "lineItem": "sample string 3",
    "columnName": "sample string 4"
  },
  {
    "errorMessage": "sample string 1",
    "lineNumber": 2,
    "lineItem": "sample string 3",
    "columnName": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfReturnImportErrorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <ReturnImportErrorViewModel>
    <ColumnName>sample string 4</ColumnName>
    <ErrorMessage>sample string 1</ErrorMessage>
    <LineItem>sample string 3</LineItem>
    <LineNumber>2</LineNumber>
  </ReturnImportErrorViewModel>
  <ReturnImportErrorViewModel>
    <ColumnName>sample string 4</ColumnName>
    <ErrorMessage>sample string 1</ErrorMessage>
    <LineItem>sample string 3</LineItem>
    <LineNumber>2</LineNumber>
  </ReturnImportErrorViewModel>
</ArrayOfReturnImportErrorViewModel>