POST api/document-creator/status

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DocumentType	string	None.
CurrentStateID	integer	None.
Lines	Collection of Collection of Object	None.
ActiveIndex	integer	None.
SkippedSlots	Collection of string	None.
ReopenSlots	Collection of string	None.
CompanyID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentType": "sample string 1",
  "CurrentStateID": 2,
  "Lines": null,
  "ActiveIndex": 3,
  "SkippedSlots": [
    "sample string 1",
    "sample string 2"
  ],
  "ReopenSlots": [
    "sample string 1",
    "sample string 2"
  ],
  "CompanyID": 4
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentCreatorStatusResponse

Name	Type	Additional information
Lines	Collection of Collection of Object	None.
ActiveIndex	integer	None.
Captured	Collection of string	None.
RequiredFields	Collection of string	None.
LineStatus	Collection of LineStatusDto	None.
NextGap	Object	None.
AllComplete	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Lines": null,
  "ActiveIndex": 1,
  "Captured": [
    "sample string 1",
    "sample string 2"
  ],
  "RequiredFields": [
    "sample string 1",
    "sample string 2"
  ],
  "LineStatus": [
    {
      "Index": 1,
      "IsEmpty": true,
      "Complete": true,
      "StillMissing": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Index": 1,
      "IsEmpty": true,
      "Complete": true,
      "StillMissing": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "NextGap": {},
  "AllComplete": true
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.