ApplicationFormSteps¶
(implementation of ApplicationFormStep entity)
Provides following method for API calls:
Create¶
URL:¶
/api/v1/{format}/applicationformsteps
Method:¶
POST
Parameters request:¶
Object< ApplicationFormStep >
Parameters response:¶
Object
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)
Delete¶
URL:¶
/api/v1/{format}/applicationformsteps/{id}
Method:¶
DELETE
Parameters request:¶
null
Parameters response:¶
Object
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)
DeleteByIds¶
URL:¶
/api/v1/{format}/applicationformsteps
Method:¶
DELETE
Parameters request:¶
Url parameters: ids
Parameters response:¶
Array
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)
Get¶
URL:¶
/api/v1/{format}/applicationformsteps/{id}
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Object
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)
GetAll¶
URL:¶
/api/v1/{format}/applicationformsteps
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)
SaveAll¶
URL:¶
/api/v1/{format}/applicationformsteps/saveall
Method:¶
POST
Parameters request:¶
Array< ApplicationFormStep >
Parameters response:¶
Array
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)
SaveAllAndReturnIds¶
URL:¶
/api/v1/{format}/applicationformsteps/saveall
Method:¶
POST
Parameters request:¶
Url parameters: full
Array< ApplicationFormStep >
Parameters response:¶
Array
- Description:
- ARRAY<NUMBER>
Search¶
URL:¶
/api/v1/{format}/applicationformsteps/search
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Array
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)
SearchFirst¶
URL:¶
/api/v1/{format}/applicationformsteps/search/first
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Object
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)
Update¶
URL:¶
/api/v1/{format}/applicationformsteps/{id}
Method:¶
PUT
Parameters request:¶
Object< ApplicationFormStep >
Parameters response:¶
Object
Description:
- text(STRING)
- question_groups(ARRAY< ApplicationFormQuestionGroup >)
- application_form(OBJECT< ApplicationForm >)
- sort_order(NUMBER)
- name(STRING)
- id(NUMBER)