POST api/import

Import Entities

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Entity		EnumEntity	None.
Data		Collection of Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "Entity": 1,
  "Data": [
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<ImportApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vending.BLL.Models.ApiModels">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
  </Data>
  <Entity>Token</Entity>
</ImportApiModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

ImportApiViewModel

Name	Type	Additional information
Imported	integer	None.
Updated	integer	None.
Errors	Collection of ImportErrorApiViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Imported": 1,
  "Updated": 2,
  "Errors": [
    {
      "LineNo": 1,
      "ColumnName": "sample string 2",
      "ErrorMessage": "sample string 3"
    },
    {
      "LineNo": 1,
      "ColumnName": "sample string 2",
      "ErrorMessage": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<ImportApiViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vending.BLL.Models.ApiModels">
  <Errors>
    <ImportErrorApiViewModel>
      <ColumnName>sample string 2</ColumnName>
      <ErrorMessage>sample string 3</ErrorMessage>
      <LineNo>1</LineNo>
    </ImportErrorApiViewModel>
    <ImportErrorApiViewModel>
      <ColumnName>sample string 2</ColumnName>
      <ErrorMessage>sample string 3</ErrorMessage>
      <LineNo>1</LineNo>
    </ImportErrorApiViewModel>
  </Errors>
  <Imported>1</Imported>
  <Updated>2</Updated>
</ImportApiViewModel>