Applications

(implementation of Application entity)

Provides following method for API calls:

• Create
• Delete
• DeleteByIds
• Get
• GetAll
• SaveAll
• SaveAllAndReturnIds
• Search
• SearchFirst
• Update

Create

URL:

/api/v1/{format}/applications

Method:

POST

Parameters request:

Object< Application >

Parameters response:

Object

Description:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. id(NUMBER)

Delete

URL:

/api/v1/{format}/applications/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/applications

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. id(NUMBER)

Get

URL:

/api/v1/{format}/applications/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. id(NUMBER)

GetAll

URL:

/api/v1/{format}/applications

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. id(NUMBER)

SaveAll

URL:

/api/v1/{format}/applications/saveall

Method:

POST

Parameters request:

Array< Application >

Parameters response:

Array

Description:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. 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:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. id(NUMBER)

SearchFirst

URL:

/api/v1/{format}/applications/search/first

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Object

Description:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. id(NUMBER)

Update

URL:

/api/v1/{format}/applications/{id}

Method:

PUT

Parameters request:

Object< Application >

Parameters response:

Object

Description:

1. application_form(OBJECT< ApplicationForm >)
2. submitted_user(OBJECT< User >)
3. regarding_user(OBJECT< User >)
4. registration_number(NUMBER)
5. decision(OBJECT< Decision >)
6. handled_user(OBJECT< Person >)
7. create_date(NUMBER(Date representation wrapped))
8. update_date(NUMBER(Date representation wrapped))
9. id(NUMBER)