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

Retrieve project data in the system. Privilege "View" of licensed agenda "Projects" required. Data may also be restricted by record permission "View" of agenda "Projects"

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 violated for [{0}]
403 server refuses to fulfill the request	1297	Record permission View of agenda Projects violated for [{0}]
404 required resource does not exist on the server	1281	Project code [{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

ProjectGetResp

Name	Description	Type	Additional information
Code	Unique identification of the project in the system	string	None.
Name	The name of the project	string	None.
Name2	The alternative name of the project	string	None.
Shortcut	The shortcut of the project	string	None.
Code2	The identifier of the project	string	None.
Type	The name of the project type	string	None.
Description	The description of the project	string	None.
SuperiorProjectCode	Unique identification of the superior project in the system	string	None.
Street	The address of project	string	None.
HouseNr	The address of project	string	None.
City	The address of project	string	None.
PostalCode	The address of project	string	None.
TimeLastChange	The last change time of the data record. Can be used to check manual modification of data record	date	None.
PlannedFrom	Scheduled start of the project	string	None.
PlannedTo	Scheduled end of the project	string	None.
Started	Begin of the project	string	None.
Finished	Finish of the project	string	None.
Closed	Close of the project	string	None.
PersonIDInCharge	The identification of the official person in charge	string	None.
PersonIDResolver	The identification of the resolver	string	None.

Response Formats

application/json

Sample:

{"PlannedFrom":"2019-01-01T08:00:00","PlannedTo":"2019-02-01T08:00:00","Started":"2019-01-03T08:00:00","Finished":"2019-01-26T18:00:00","Closed":"2019-01-27T08:00:00","PersonIDInCharge":"X0004","PersonIDResolver":"X0001","Code":"CODE 1001","Name":"Name of the project 1001","Name2":null,"Shortcut":null,"Code2":null,"Type":"Name of the project Type 1001","Description":"Description of the project 1001","SuperiorProjectCode":"","Street":"Street 5","HouseNr":"HouseNr 5","City":"City 5","PostalCode":"ZIP 5","TimeLastChange":"\/Date(1732183511569)\/"}

application/xml

Sample:


<Response>
  <PlannedFrom>2019-01-01T08:00:00</PlannedFrom>
  <PlannedTo>2019-02-01T08:00:00</PlannedTo>
  <Started>2019-01-03T08:00:00</Started>
  <Finished>2019-01-26T18:00:00</Finished>
  <PersonIDInCharge>X0004</PersonIDInCharge>
  <PersonIDResolver>X0001</PersonIDResolver>
  <Code>CODE 1001</Code>
  <Name>Name of the project 1001</Name>
  <Type>Name of the project Type 1001</Type>
  <Description>Description of the project 1001</Description>
  <SuperiorProjectCode />
  <Street>Street 5</Street>
  <HouseNr>HouseNr 5</HouseNr>
  <City>City 5</City>
  <PostalCode>ZIP 5</PostalCode>
  <TimeLastChange>2024-11-21T10:05:11.5695698Z</TimeLastChange>
</Response>

text/json

Sample:

{
  "Started": "sample string 3",
  "PersonIDInCharge": "sample string 6",
  "PersonIDResolver": "sample string 7",
  "Code2": "sample string 5",
  "SuperiorProjectCode": "sample string 8"
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Started>sample string 3</Started>
  <PersonIDInCharge>sample string 6</PersonIDInCharge>
  <PersonIDResolver>sample string 7</PersonIDResolver>
  <Code2>sample string 5</Code2>
  <SuperiorProjectCode>sample string 8</SuperiorProjectCode>
</Response>