PUT api/SIDStartDoCheck

Request Information

URI Parameters

None.

Body Parameters

RequestSelfIDStartDoCheck
NameDescriptionTypeAdditional information
ProcessId

string

None.

Token

string

None.

Data

StartdochecktransactionrequestDto

None.

Request Formats

application/json, text/json

Sample:
{
  "ProcessId": "sample string 1",
  "Token": "sample string 2",
  "Data": {
    "runnableId": "sample string 1",
    "processInstanceId": "sample string 2",
    "routingKey": "sample string 3",
    "actionRequest": {
      "data": {
        "redirectUrl": "sample string 1"
      }
    }
  }
}

application/xml, text/xml

Sample:
<RequestSelfIDStartDoCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IT.CarmerFirma.Application.DTO.SelfIDDTO">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/IT.CarmerFirma.Application.DTO">
    <d2p1:actionRequest>
      <d2p1:data>
        <d2p1:redirectUrl>sample string 1</d2p1:redirectUrl>
      </d2p1:data>
    </d2p1:actionRequest>
    <d2p1:processInstanceId>sample string 2</d2p1:processInstanceId>
    <d2p1:routingKey>sample string 3</d2p1:routingKey>
    <d2p1:runnableId>sample string 1</d2p1:runnableId>
  </Data>
  <ProcessId>sample string 1</ProcessId>
  <Token>sample string 2</Token>
</RequestSelfIDStartDoCheck>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseSelfIDStartDoCheck
NameDescriptionTypeAdditional information
Status

string

None.

MsgStatus

string

None.

Data

StartdochecktransactionresponseDto

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "MsgStatus": "sample string 2",
  "Data": {
    "masterProcessInstanceId": "sample string 1",
    "processInstanceId": "sample string 2",
    "actionInstanceId": "sample string 3",
    "runnableId": "sample string 4",
    "status": "sample string 5",
    "errors": "sample string 6",
    "data": {
      "docheckUrl": "sample string 1",
      "docheckTransactionId": "sample string 2",
      "docheckToken": "sample string 3"
    }
  }
}

application/xml, text/xml

Sample:
<ResponseSelfIDStartDoCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IT.CarmerFirma.Application.DTO">
  <Data>
    <actionInstanceId>sample string 3</actionInstanceId>
    <data>
      <docheckToken>sample string 3</docheckToken>
      <docheckTransactionId>sample string 2</docheckTransactionId>
      <docheckUrl>sample string 1</docheckUrl>
    </data>
    <errors>sample string 6</errors>
    <masterProcessInstanceId>sample string 1</masterProcessInstanceId>
    <processInstanceId>sample string 2</processInstanceId>
    <runnableId>sample string 4</runnableId>
    <status>sample string 5</status>
  </Data>
  <MsgStatus>sample string 2</MsgStatus>
  <Status>sample string 1</Status>
</ResponseSelfIDStartDoCheck>