Applications¶
(implementation of Application entity)
Provides following method for API calls:
Create¶
URL:¶
/api/v1/{format}/applications
Method:¶
POST
Parameters request:¶
Object< Application >
Parameters response:¶
Object
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)
Delete¶
URL:¶
/api/v1/{format}/applications/{id}
Method:¶
DELETE
Parameters request:¶
null
Parameters response:¶
Object
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)
DeleteByIds¶
URL:¶
/api/v1/{format}/applications
Method:¶
DELETE
Parameters request:¶
Url parameters: ids
Parameters response:¶
Array
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)
Get¶
URL:¶
/api/v1/{format}/applications/{id}
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Object
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)
GetAll¶
URL:¶
/api/v1/{format}/applications
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)
SaveAll¶
URL:¶
/api/v1/{format}/applications/saveall
Method:¶
POST
Parameters request:¶
Array< Application >
Parameters response:¶
Array
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)
SaveAllAndReturnIds¶
URL:¶
/api/v1/{format}/applications/saveall
Method:¶
POST
Parameters request:¶
Url parameters: full
Array< Application >
Parameters response:¶
Array
- Description:
- ARRAY<NUMBER>
Search¶
URL:¶
/api/v1/{format}/applications/search
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Array
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)
SearchFirst¶
URL:¶
/api/v1/{format}/applications/search/first
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Object
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)
Update¶
URL:¶
/api/v1/{format}/applications/{id}
Method:¶
PUT
Parameters request:¶
Object< Application >
Parameters response:¶
Object
Description:
- application_form(OBJECT< ApplicationForm >)
- submitted_user(OBJECT< User >)
- regarding_user(OBJECT< User >)
- registration_number(NUMBER)
- decision(OBJECT< Decision >)
- handled_user(OBJECT< Person >)
- create_date(NUMBER(Date representation wrapped))
- update_date(NUMBER(Date representation wrapped))
- id(NUMBER)