Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
314 lines (230 sloc) 6.76 KB

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:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. id(NUMBER)

Delete

URL:

/api/v1/{format}/applicationformsteps/{id}

Method:

DELETE

Parameters request:

null

Parameters response:

Object

Description:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. id(NUMBER)

DeleteByIds

URL:

/api/v1/{format}/applicationformsteps

Method:

DELETE

Parameters request:

Url parameters: ids

Parameters response:

Array

Description:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. id(NUMBER)

Get

URL:

/api/v1/{format}/applicationformsteps/{id}

Method:

GET

Parameters request:

null

Parameters response:

Object

Description:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. id(NUMBER)

GetAll

URL:

/api/v1/{format}/applicationformsteps

Method:

GET

Parameters request:

null

Parameters response:

Array

Description:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. id(NUMBER)

SaveAll

URL:

/api/v1/{format}/applicationformsteps/saveall

Method:

POST

Parameters request:

Array< ApplicationFormStep >

Parameters response:

Array

Description:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. 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:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. id(NUMBER)

SearchFirst

URL:

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

Method:

POST

Parameters request:

Array< SearchCriteries$SearchCriteriaResult >

Parameters response:

Object

Description:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. id(NUMBER)

Update

URL:

/api/v1/{format}/applicationformsteps/{id}

Method:

PUT

Parameters request:

Object< ApplicationFormStep >

Parameters response:

Object

Description:

  1. text(STRING)
  2. question_groups(ARRAY< ApplicationFormQuestionGroup >)
  3. application_form(OBJECT< ApplicationForm >)
  4. sort_order(NUMBER)
  5. name(STRING)
  6. id(NUMBER)
You can’t perform that action at this time.