POST api/GetDepartments_V1
Get All Departments
Request Information
URI Parameters
None.
Body Parameters
The request is presented below!
WS_Repository.Models.Requests.Lists.GetDepartmentsRequestName | Description | Type | Additional 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. |
Request Formats
application/json, text/json
Sample:
{ "WS_Key": "sample string 1", "WSKeyLevel": 0 }
application/xml, text/xml
Sample:
<GetDepartmentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Lists"> <WSKeyLevel>User</WSKeyLevel> <WS_Key>sample string 1</WS_Key> </GetDepartmentsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
WS_Repository.Models.Responses.Lists.GetDepartmentsResponseName | Description | Type | Additional information |
---|---|---|---|
Success |
Specify if the request was successfully done |
boolean |
None. |
ErrorMessage |
The error message if the request get an error |
string |
None. |
DepartmentsList |
The List of departments |
Collection of WS_Repository.Models.Responses.Lists.Department |
None. |
Response Formats
application/json, text/json
Sample:
{ "Success": true, "ErrorMessage": "sample string 2", "DepartmentsList": [ { "Code": "sample string 1", "Name": "sample string 2" }, { "Code": "sample string 1", "Name": "sample string 2" } ] }
application/xml, text/xml
Sample:
<GetDepartmentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Lists"> <DepartmentsList> <Department> <Code>sample string 1</Code> <Name>sample string 2</Name> </Department> <Department> <Code>sample string 1</Code> <Name>sample string 2</Name> </Department> </DepartmentsList> <ErrorMessage>sample string 2</ErrorMessage> <Success>true</Success> </GetDepartmentsResponse>