POST api/batch/upload

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
id	integer	None.
provider	ProviderModel	None.
type	string	None.
batch_name	string	None.
friendly_id	string	None.
external_id	string	None.
domain_id	string	None.
status	string	None.
created_date	date	None.
submission_date	date	None.
completed_date	date	None.
created_by	string	None.
documents	Collection of BatchDocumentModel	None.
row_json	string	None.
user	UserModel	None.
is_skip_duplicate_check	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "provider": {
    "id": 1,
    "name": "sample string 1",
    "suit_name": "sample string 2",
    "type": "sample string 3",
    "group_name": "sample string 4",
    "group_id": 1,
    "created_by": "sample string 5",
    "updated_by": "sample string 6",
    "created_date": "2026-05-01T21:08:49.8506386+00:00",
    "updated_date": "2026-05-01T21:08:49.8506386+00:00",
    "is_active": true
  },
  "type": "sample string 1",
  "batch_name": "sample string 2",
  "friendly_id": "sample string 3",
  "external_id": "sample string 4",
  "domain_id": "sample string 5",
  "status": "sample string 6",
  "created_date": "2026-05-01T21:08:49.8506386+00:00",
  "submission_date": "2026-05-01T21:08:49.8506386+00:00",
  "completed_date": "2026-05-01T21:08:49.8506386+00:00",
  "created_by": "sample string 8",
  "documents": [
    {
      "id": 1,
      "file_name": "sample string 2",
      "path": "sample string 3",
      "friendly_id": "sample string 4"
    },
    {
      "id": 1,
      "file_name": "sample string 2",
      "path": "sample string 3",
      "friendly_id": "sample string 4"
    }
  ],
  "row_json": "sample string 9",
  "user": {
    "id": 1,
    "first_name": "sample string 2",
    "last_name": "sample string 3",
    "email": "sample string 4",
    "username": "sample string 5",
    "user_role_type": "sample string 6",
    "is_active": true,
    "user_type": "sample string 8",
    "email_token": "sample string 9",
    "department_id": 1,
    "department": {
      "id": 1,
      "name": "sample string 1"
    },
    "roles": [
      {
        "id": 1,
        "name": "sample string 1",
        "department_id": 1,
        "department_name": "sample string 2"
      },
      {
        "id": 1,
        "name": "sample string 1",
        "department_id": 1,
        "department_name": "sample string 2"
      }
    ],
    "user_id": 10,
    "created_by": "sample string 11",
    "updated_by": "sample string 12",
    "created_date": "2026-05-01T21:08:49.8506386+00:00",
    "updated_date": "2026-05-01T21:08:49.8506386+00:00"
  },
  "is_skip_duplicate_check": true
}

text/html

Sample:

{"id":1,"provider":{"id":1,"name":"sample string 1","suit_name":"sample string 2","type":"sample string 3","group_name":"sample string 4","group_id":1,"created_by":"sample string 5","updated_by":"sample string 6","created_date":"2026-05-01T21:08:49.8506386+00:00","updated_date":"2026-05-01T21:08:49.8506386+00:00","is_active":true},"type":"sample string 1","batch_name":"sample string 2","friendly_id":"sample string 3","external_id":"sample string 4","domain_id":"sample string 5","status":"sample string 6","created_date":"2026-05-01T21:08:49.8506386+00:00","submission_date":"2026-05-01T21:08:49.8506386+00:00","completed_date":"2026-05-01T21:08:49.8506386+00:00","created_by":"sample string 8","documents":[{"id":1,"file_name":"sample string 2","path":"sample string 3","friendly_id":"sample string 4"},{"id":1,"file_name":"sample string 2","path":"sample string 3","friendly_id":"sample string 4"}],"row_json":"sample string 9","user":{"id":1,"first_name":"sample string 2","last_name":"sample string 3","email":"sample string 4","username":"sample string 5","user_role_type":"sample string 6","is_active":true,"user_type":"sample string 8","email_token":"sample string 9","department_id":1,"department":{"id":1,"name":"sample string 1"},"roles":[{"id":1,"name":"sample string 1","department_id":1,"department_name":"sample string 2"},{"id":1,"name":"sample string 1","department_id":1,"department_name":"sample string 2"}],"user_id":10,"created_by":"sample string 11","updated_by":"sample string 12","created_date":"2026-05-01T21:08:49.8506386+00:00","updated_date":"2026-05-01T21:08:49.8506386+00:00"},"is_skip_duplicate_check":true}

application/xml, text/xml

Sample:

<BatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models.AI">
  <batch_name>sample string 2</batch_name>
  <completed_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-05-01T21:08:49.8506386Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </completed_date>
  <created_by>sample string 8</created_by>
  <created_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-05-01T21:08:49.8506386Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </created_date>
  <documents>
    <BatchDocumentModel>
      <file_name>sample string 2</file_name>
      <friendly_id>sample string 4</friendly_id>
      <id>1</id>
      <path>sample string 3</path>
    </BatchDocumentModel>
    <BatchDocumentModel>
      <file_name>sample string 2</file_name>
      <friendly_id>sample string 4</friendly_id>
      <id>1</id>
      <path>sample string 3</path>
    </BatchDocumentModel>
  </documents>
  <domain_id>sample string 5</domain_id>
  <external_id>sample string 4</external_id>
  <friendly_id>sample string 3</friendly_id>
  <id>1</id>
  <is_skip_duplicate_check>true</is_skip_duplicate_check>
  <provider xmlns:d2p1="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models">
    <d2p1:created_by>sample string 5</d2p1:created_by>
    <d2p1:created_date>2026-05-01T21:08:49.8506386+00:00</d2p1:created_date>
    <d2p1:is_active>true</d2p1:is_active>
    <d2p1:updated_by>sample string 6</d2p1:updated_by>
    <d2p1:updated_date>2026-05-01T21:08:49.8506386+00:00</d2p1:updated_date>
    <d2p1:group_id>1</d2p1:group_id>
    <d2p1:group_name>sample string 4</d2p1:group_name>
    <d2p1:id>1</d2p1:id>
    <d2p1:name>sample string 1</d2p1:name>
    <d2p1:suit_name>sample string 2</d2p1:suit_name>
    <d2p1:type>sample string 3</d2p1:type>
  </provider>
  <row_json>sample string 9</row_json>
  <status>sample string 6</status>
  <submission_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-05-01T21:08:49.8506386Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </submission_date>
  <type>sample string 1</type>
  <user xmlns:d2p1="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models">
    <d2p1:created_by>sample string 11</d2p1:created_by>
    <d2p1:created_date>2026-05-01T21:08:49.8506386+00:00</d2p1:created_date>
    <d2p1:is_active>false</d2p1:is_active>
    <d2p1:updated_by>sample string 12</d2p1:updated_by>
    <d2p1:updated_date>2026-05-01T21:08:49.8506386+00:00</d2p1:updated_date>
    <d2p1:department>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 1</d2p1:name>
    </d2p1:department>
    <d2p1:department_id>1</d2p1:department_id>
    <d2p1:email>sample string 4</d2p1:email>
    <d2p1:email_token>sample string 9</d2p1:email_token>
    <d2p1:first_name>sample string 2</d2p1:first_name>
    <d2p1:id>1</d2p1:id>
    <d2p1:is_active>true</d2p1:is_active>
    <d2p1:last_name>sample string 3</d2p1:last_name>
    <d2p1:roles>
      <d2p1:ApplicationRoleModel>
        <d2p1:department_id>1</d2p1:department_id>
        <d2p1:department_name>sample string 2</d2p1:department_name>
        <d2p1:id>1</d2p1:id>
        <d2p1:name>sample string 1</d2p1:name>
      </d2p1:ApplicationRoleModel>
      <d2p1:ApplicationRoleModel>
        <d2p1:department_id>1</d2p1:department_id>
        <d2p1:department_name>sample string 2</d2p1:department_name>
        <d2p1:id>1</d2p1:id>
        <d2p1:name>sample string 1</d2p1:name>
      </d2p1:ApplicationRoleModel>
    </d2p1:roles>
    <d2p1:user_id>10</d2p1:user_id>
    <d2p1:user_role_type>sample string 6</d2p1:user_role_type>
    <d2p1:user_type>sample string 8</d2p1:user_type>
    <d2p1:username>sample string 5</d2p1:username>
  </user>
</BatchModel>

multipart/form-data

Sample:

<BatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models.AI"><batch_name>sample string 2</batch_name><completed_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"><d2p1:DateTime>2026-05-01T21:08:49.8506386Z</d2p1:DateTime><d2p1:OffsetMinutes>0</d2p1:OffsetMinutes></completed_date><created_by>sample string 8</created_by><created_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"><d2p1:DateTime>2026-05-01T21:08:49.8506386Z</d2p1:DateTime><d2p1:OffsetMinutes>0</d2p1:OffsetMinutes></created_date><documents><BatchDocumentModel><file_name>sample string 2</file_name><friendly_id>sample string 4</friendly_id><id>1</id><path>sample string 3</path></BatchDocumentModel><BatchDocumentModel><file_name>sample string 2</file_name><friendly_id>sample string 4</friendly_id><id>1</id><path>sample string 3</path></BatchDocumentModel></documents><domain_id>sample string 5</domain_id><external_id>sample string 4</external_id><friendly_id>sample string 3</friendly_id><id>1</id><is_skip_duplicate_check>true</is_skip_duplicate_check><provider xmlns:d2p1="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models"><d2p1:created_by>sample string 5</d2p1:created_by><d2p1:created_date>2026-05-01T21:08:49.8506386+00:00</d2p1:created_date><d2p1:is_active>true</d2p1:is_active><d2p1:updated_by>sample string 6</d2p1:updated_by><d2p1:updated_date>2026-05-01T21:08:49.8506386+00:00</d2p1:updated_date><d2p1:group_id>1</d2p1:group_id><d2p1:group_name>sample string 4</d2p1:group_name><d2p1:id>1</d2p1:id><d2p1:name>sample string 1</d2p1:name><d2p1:suit_name>sample string 2</d2p1:suit_name><d2p1:type>sample string 3</d2p1:type></provider><row_json>sample string 9</row_json><status>sample string 6</status><submission_date xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"><d2p1:DateTime>2026-05-01T21:08:49.8506386Z</d2p1:DateTime><d2p1:OffsetMinutes>0</d2p1:OffsetMinutes></submission_date><type>sample string 1</type><user xmlns:d2p1="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models"><d2p1:created_by>sample string 11</d2p1:created_by><d2p1:created_date>2026-05-01T21:08:49.8506386+00:00</d2p1:created_date><d2p1:is_active>false</d2p1:is_active><d2p1:updated_by>sample string 12</d2p1:updated_by><d2p1:updated_date>2026-05-01T21:08:49.8506386+00:00</d2p1:updated_date><d2p1:department><d2p1:id>1</d2p1:id><d2p1:name>sample string 1</d2p1:name></d2p1:department><d2p1:department_id>1</d2p1:department_id><d2p1:email>sample string 4</d2p1:email><d2p1:email_token>sample string 9</d2p1:email_token><d2p1:first_name>sample string 2</d2p1:first_name><d2p1:id>1</d2p1:id><d2p1:is_active>true</d2p1:is_active><d2p1:last_name>sample string 3</d2p1:last_name><d2p1:roles><d2p1:ApplicationRoleModel><d2p1:department_id>1</d2p1:department_id><d2p1:department_name>sample string 2</d2p1:department_name><d2p1:id>1</d2p1:id><d2p1:name>sample string 1</d2p1:name></d2p1:ApplicationRoleModel><d2p1:ApplicationRoleModel><d2p1:department_id>1</d2p1:department_id><d2p1:department_name>sample string 2</d2p1:department_name><d2p1:id>1</d2p1:id><d2p1:name>sample string 1</d2p1:name></d2p1:ApplicationRoleModel></d2p1:roles><d2p1:user_id>10</d2p1:user_id><d2p1:user_role_type>sample string 6</d2p1:user_role_type><d2p1:user_type>sample string 8</d2p1:user_type><d2p1:username>sample string 5</d2p1:username></user></BatchModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.