POST api/GetGLDepartments_V1
Get All GL Departments
Request Information
URI Parameters
None.
Body Parameters
The request is presented below!
WS_Repository.Models.Requests.Lists.GetGLDepartmentsRequestName | 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:
<GetGLDepartmentsRequest 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> </GetGLDepartmentsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
WS_Repository.Models.Responses.Lists.GetGLDepartmentsResponseName | 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. |
GLDepartmentsList |
The List of GL departments |
Collection of WS_Repository.Models.Responses.Lists.GLDepartment |
None. |
Response Formats
application/json, text/json
Sample:
{ "Success": true, "ErrorMessage": "sample string 2", "GLDepartmentsList": [ { "DepartmentName": "sample string 1", "GLDepartmentStoresList": [ { "StoreName": "sample string 1", "GLCode": "sample string 2", "Store3": "sample string 3", "Store4": "sample string 4", "Store5": "sample string 5", "ApprovalGroupID": 1 }, { "StoreName": "sample string 1", "GLCode": "sample string 2", "Store3": "sample string 3", "Store4": "sample string 4", "Store5": "sample string 5", "ApprovalGroupID": 1 } ] }, { "DepartmentName": "sample string 1", "GLDepartmentStoresList": [ { "StoreName": "sample string 1", "GLCode": "sample string 2", "Store3": "sample string 3", "Store4": "sample string 4", "Store5": "sample string 5", "ApprovalGroupID": 1 }, { "StoreName": "sample string 1", "GLCode": "sample string 2", "Store3": "sample string 3", "Store4": "sample string 4", "Store5": "sample string 5", "ApprovalGroupID": 1 } ] } ] }
application/xml, text/xml
Sample:
<GetGLDepartmentsResponse 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> <GLDepartmentsList> <GLDepartment> <DepartmentName>sample string 1</DepartmentName> <GLDepartmentStoresList> <GLDepartment_Store> <ApprovalGroupID>1</ApprovalGroupID> <GLCode>sample string 2</GLCode> <Store3>sample string 3</Store3> <Store4>sample string 4</Store4> <Store5>sample string 5</Store5> <StoreName>sample string 1</StoreName> </GLDepartment_Store> <GLDepartment_Store> <ApprovalGroupID>1</ApprovalGroupID> <GLCode>sample string 2</GLCode> <Store3>sample string 3</Store3> <Store4>sample string 4</Store4> <Store5>sample string 5</Store5> <StoreName>sample string 1</StoreName> </GLDepartment_Store> </GLDepartmentStoresList> </GLDepartment> <GLDepartment> <DepartmentName>sample string 1</DepartmentName> <GLDepartmentStoresList> <GLDepartment_Store> <ApprovalGroupID>1</ApprovalGroupID> <GLCode>sample string 2</GLCode> <Store3>sample string 3</Store3> <Store4>sample string 4</Store4> <Store5>sample string 5</Store5> <StoreName>sample string 1</StoreName> </GLDepartment_Store> <GLDepartment_Store> <ApprovalGroupID>1</ApprovalGroupID> <GLCode>sample string 2</GLCode> <Store3>sample string 3</Store3> <Store4>sample string 4</Store4> <Store5>sample string 5</Store5> <StoreName>sample string 1</StoreName> </GLDepartment_Store> </GLDepartmentStoresList> </GLDepartment> </GLDepartmentsList> <Success>true</Success> </GetGLDepartmentsResponse>