GET workUnit/getAll?PageNumber={PageNumber}&PageSize={PageSize}&Token={Token}

Retrieve all working units in the system. Privilege "View" of licensed agenda "Work units" required. Data may also be restricted by record permission "View" of agenda "Working units".

Request Information

Authorization

  • Authorization by token required

Availability

  • Method can be used

URI Parameters

NameDescriptionTypeAdditional information
PageNumber

Optional parameter may be omitted. All records are displayed when is omitted otherwise specific page is displayed

integer

Matching regular expression pattern: ([0-9]+)

PageSize

Optional parameter may be omitted. Define number of records in the page.

integer

Matching regular expression pattern: ([0-9]+)

Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

globally unique identifier

Required

Body Parameters

None.

Response Information

Response Codes

Http CodeError NumberDescription
200 request succesfully done 0 successfully done
400 bad request 1002 Entry parameter missing or parameter bindigs failed
401 unauthorized 1000 Token {0} not found
401 unauthorized 1001 Token {0} already expired
401 unauthorized 1006 Ip filter violated for ip client address [{0}]
401 unauthorized 1007 Ip filter [{0}] parsing failed
401 unauthorized 1008 Request rate policy violated for [{0}]
403 server refuses fo fulfill the request 2200 Privilege View of agenda Working units violated for [all]
404 required resource does not exist on the server 2201 Working units [all] not found
415 unsupported Media Type The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported
500 internal error Server exception description

Resource Description

WorkUnitGetAllResp
NameDescriptionTypeAdditional information
WorkUnits

Collection of WorkUnit

None.

Paging

PagingResp

None.

Response Formats

application/json

Sample:
{"WorkUnits":[{"Name":"Strategic development unit","Code":"SDU","Description":"Some description of the unit"},{"Name":"Head management unit","Code":"HMU","Description":"Some description of the unit"},{"Name":"Accounting unit","Code":"AU","Description":"Some description of the unit"}],"Paging":{"CurrentPage":1,"PageSize":25,"TotalCount":3,"TotalPages":1}}

application/xml

Sample:

<Response>
  <WorkUnits>
    <WorkUnit>
      <Name>Strategic development unit</Name>
      <Code>SDU</Code>
    </WorkUnit>
    <WorkUnit>
      <Name>Head management unit</Name>
      <Code>HMU</Code>
    </WorkUnit>
    <WorkUnit>
      <Name>Accounting unit</Name>
      <Code>AU</Code>
    </WorkUnit>
  </WorkUnits>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>25</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>1</TotalPages>
  </Paging>
</Response>

text/json

Sample:
{
  "WorkUnits": [
    {},
    {}
  ],
  "Paging": {
    "CurrentPage": 1,
    "PageSize": 2,
    "TotalCount": 3,
    "TotalPages": 4
  }
}

text/xml

Sample:
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WorkUnits>
    <WorkUnit />
    <WorkUnit />
  </WorkUnits>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Paging>
</Response>