GET project/getProjectItems?Code={Code}&Token={Token}&PageNumber={PageNumber}&PageSize={PageSize}

Retrieve all items for current project. Privilege "View" of licensed agenda "Projects.Projects" required. Privilege "View" of item "Project items" of licensed agenda "Project.Project items" required. Data may also be restricted by record permission "View" of agenda "Projects". Paging supported

Request Information

Authorization

Authorization by token required

Availability

Method disabled by configuration

URI Parameters

Name	Description	Type	Additional information
Code	Unique identification of the project in the system	string	Required String length: inclusive between 0 and 100
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
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]+)

Body Parameters

None.

Response Information

Response Codes

Http Code	Error Number	Description
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 to fulfill the request	1280	Privilege View of agenda Projects.Projects violated for [{0}]
403 server refuses to fulfill the request	1266	Privilege View of item Project items of agenda Project.Project items violated for [{0}]
404 required resource does not exist on the server	1281	Project [{0}] not found
404 required resource does not exist on the server	1241	ProjectItem [{0}] 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

ProjectPrjItemsGetResp

Name	Description	Type	Additional information
Code	Unique identification of the project in the system	string	None.
Items		Collection of ProjectPrjItem	None.
Paging		PagingResp	None.

Response Formats

application/json

Sample:

{"Code":"PROJECT CODE 1001","Items":[{"Code":"ITEM CODE 1001","Description":"Description of the item 1001","Name":"Name of the item 1001","Name2":"Another Name of the item 1001","Shortcut":"Shortcut of the item 1001","Identifier":"Identifier of the item 1001","Unit":0,"PlannedDuration":0,"Persons":null},{"Code":"ITEM CODE 1002","Description":"Description of the item 1002","Name":"Name of the item 1002","Name2":"Another Name of the item 1002","Shortcut":"Shortcut of the item 1002","Identifier":"Identifier of the item 1002","Unit":0,"PlannedDuration":0,"Persons":null},{"Code":"ITEM CODE 1003","Description":"Description of the item 1003","Name":"Name of the item 1003","Name2":"Another Name of the item 1003","Shortcut":"Shortcut of the item 1003","Identifier":"Identifier of the item 1003","Unit":0,"PlannedDuration":0,"Persons":null}],"Paging":{"CurrentPage":1,"PageSize":25,"TotalCount":3,"TotalPages":5}}

application/xml

Sample:


<Response>
  <Code>PROJECT CODE 1001</Code>
  <ProjectItems>
    <ProjectPrjItem>
      <Code>ITEM CODE 1001</Code>
    </ProjectPrjItem>
    <ProjectPrjItem>
      <Code>ITEM CODE 1002</Code>
    </ProjectPrjItem>
    <ProjectPrjItem>
      <Code>ITEM CODE 1003</Code>
    </ProjectPrjItem>
  </ProjectItems>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>25</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>5</TotalPages>
  </Paging>
</Response>

text/json

Sample:

{
  "Code": "sample string 1",
  "Items": [
    {},
    {}
  ],
  "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">
  <Code>sample string 1</Code>
  <ProjectItems>
    <ProjectPrjItem />
    <ProjectPrjItem />
  </ProjectItems>
  <Paging>
    <CurrentPage>1</CurrentPage>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Paging>
</Response>