Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | projects.json | |
General | Yes | Parameters described in overview | see overview | Structure of an API call |
Model Structure | Yes | Name of model required | modelstructure=projectslist | Using data models |
View | No | Stored filter applied | Using views | |
Sort | No | Change the view's default sort order | sort=CREATED | Sorting |
Filters | No | Filter by a key field | Filters | |
Company | Yes | The company number | company=1 | |
Client | Yes | Client ID | client=1/A001 |
Example request:
http://<SERVER>/jsonAPI/projects.json?user=user&password=user&version=4&modelstructure=projectslist&company=1&client=1/A001
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 2,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"projectuuid": "56AC26F48BC1402EA8B0E1DB33AD9F37",
"projectTimeStampModified": 1519314082,
"projectRecordVersionNumber": 4,
"projectNo": 232,
"projectClientCode": "1/A001",
"projectClientName": "Proton Cars plc",
"projectName": "Project to copy",
"projectCreatedDate": "0000-00-00",
"projectHandlerName": "Syn Mike Dev",
"projectCompleted": false,
"projectBudget": 0
},
{
"projectuuid": "E0CC0FFDDC024439BA831CD645DEDC09",
"projectTimeStampModified": 1461677568,
"projectRecordVersionNumber": 5,
"projectNo": 10,
"projectClientCode": "1/A001",
"projectClientName": "Proton Cars plc",
"projectName": "World Cup 98",
"projectCreatedDate": "1998-07-30",
"projectHandlerName": "",
"projectCompleted": false,
"projectBudget": 0
}
]
}