Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use /entity routing instead of /user


Excerpt

Retrieve a list of all

...

currently active forms available to an account



Endpoint ID:

8005

Method:

Status
colourGreen
title

DELETE

GET

URL:

DELETE

/forms/

user

entity/

dp-key

id/{

dp

entity-

key

id}/form

/{form-id}
DELETE /user


/forms/entity/ext-key/{ext-key}/{ext-type}/form

/{form


entity-id

}

 

dp-key

dialogportal™ master key that

Rubiq entity ID that uniquely identifies the account to retrieve forms for

 


ext-key

External key that uniquely identifies the account to

form 

retrieve forms for


ext-typeType of external key

 

form-id

Numeric value that identifies the form

Request body:

None

Response body:

None
JSON array containing the formID and name of each form.


Code Block
titleExample
[
   {
      "formID": 100,
      "name": "Form 1"
   },
   {
      "formID": 101,
      "name": "Form 2"
   }
]


Status codes:

204

OK no content

 200Deleted Successfully

200

Forms successfully retrieved


404

Account not found, or no forms found for account.

The following sub codes may be returned:

404.1User not found
404.2External user could not be found
404.4No forms found