POST api/AddDepartments_V1

Add User/Client Department

Request Information

URI Parameters

None.

Body Parameters

The request is presented bellow!

WS_Repository.Models.Requests.Lists.AddDepartmentsRequest
NameDescriptionTypeAdditional information
WS_Key

(Mandatory) Client Or User Webservice Key provided by 2ship support - the type of the ws_key should be set by WSKeyLevel field

string

None.

WSKeyLevel

(Mandatory) Specify the WS_Key type ( User or Client)

WS_Repository.Models.Common.WSKeyLevelType

None.

DepartmentsList

(Mandatory) The List of departements to Add/Update

Collection of WS_Repository.Models.Requests.Lists.DepartmentToAdd

None.

Request Formats

application/json, text/json

Sample:
{
  "WS_Key": "sample string 1",
  "WSKeyLevel": 0,
  "DepartmentsList": [
    {
      "Code": "sample string 1",
      "Name": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<AddDepartmentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Lists">
  <DepartmentsList>
    <DepartmentToAdd>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </DepartmentToAdd>
    <DepartmentToAdd>
      <Code>sample string 1</Code>
      <Name>sample string 2</Name>
    </DepartmentToAdd>
  </DepartmentsList>
  <WSKeyLevel>User</WSKeyLevel>
  <WS_Key>sample string 1</WS_Key>
</AddDepartmentsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WS_Repository.Models.Responses.Lists.AddDepartmentsResponse
NameDescriptionTypeAdditional information
Success

Specify if the import was successfully done

boolean

None.

ErrorMessage

The error message if the import get an error

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<AddDepartmentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Lists">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Success>true</Success>
</AddDepartmentsResponse>