POST api/ESB/Status

Retrieve status of transaction.

Request Information

URI Parameters

None.

Body Parameters

string

Request Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'String'.

Response Information

Resource Description

Returns detailed data for transaction including events of all documents.

StatusResult

Name	Description	Type	Additional information
TransactionId		string	None.
LastEventDateTime		string	None.
PortfolioId		integer	None.
PortfolioStatus	Portfolio Status: In Progress, Completed, Locked, Deleted,	string	None.
PortfolioEvents		Collection of StatusEvent	None.
Documents		Collection of StatusDocument	None.
Signers		Collection of StatusSigner	None.

Response Formats

application/json, text/json

Sample:

{
  "TransactionId": "sample string 1",
  "LastEventDateTime": "sample string 2",
  "PortfolioId": 3,
  "PortfolioStatus": "sample string 4",
  "PortfolioEvents": [
    {
      "EventDateTime": "sample string 1",
      "Event": "sample string 2",
      "TriggeredBy": "sample string 3",
      "EventType": "sample string 4"
    },
    {
      "EventDateTime": "sample string 1",
      "Event": "sample string 2",
      "TriggeredBy": "sample string 3",
      "EventType": "sample string 4"
    }
  ],
  "Documents": [
    {
      "LastEventDateTime": "sample string 1",
      "DocumentType": "sample string 2",
      "DocumentStatus": "sample string 3",
      "DocumentEvents": [
        {
          "EventDateTime": "sample string 1",
          "Event": "sample string 2",
          "TriggeredBy": "sample string 3",
          "EventType": "sample string 4"
        },
        {
          "EventDateTime": "sample string 1",
          "Event": "sample string 2",
          "TriggeredBy": "sample string 3",
          "EventType": "sample string 4"
        }
      ]
    },
    {
      "LastEventDateTime": "sample string 1",
      "DocumentType": "sample string 2",
      "DocumentStatus": "sample string 3",
      "DocumentEvents": [
        {
          "EventDateTime": "sample string 1",
          "Event": "sample string 2",
          "TriggeredBy": "sample string 3",
          "EventType": "sample string 4"
        },
        {
          "EventDateTime": "sample string 1",
          "Event": "sample string 2",
          "TriggeredBy": "sample string 3",
          "EventType": "sample string 4"
        }
      ]
    }
  ],
  "Signers": [
    {
      "LastEventDateTime": "sample string 1",
      "FullName": "sample string 2",
      "Email": "sample string 3",
      "CellNumber": "sample string 4",
      "IdNumber": "sample string 5",
      "UserStatus": "sample string 6",
      "SignerEvents": [
        {
          "EventDateTime": "sample string 1",
          "Event": "sample string 2",
          "TriggeredBy": "sample string 3",
          "EventType": "sample string 4"
        },
        {
          "EventDateTime": "sample string 1",
          "Event": "sample string 2",
          "TriggeredBy": "sample string 3",
          "EventType": "sample string 4"
        }
      ]
    },
    {
      "LastEventDateTime": "sample string 1",
      "FullName": "sample string 2",
      "Email": "sample string 3",
      "CellNumber": "sample string 4",
      "IdNumber": "sample string 5",
      "UserStatus": "sample string 6",
      "SignerEvents": [
        {
          "EventDateTime": "sample string 1",
          "Event": "sample string 2",
          "TriggeredBy": "sample string 3",
          "EventType": "sample string 4"
        },
        {
          "EventDateTime": "sample string 1",
          "Event": "sample string 2",
          "TriggeredBy": "sample string 3",
          "EventType": "sample string 4"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<StatusResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <Documents>
    <StatusDocument>
      <DocumentEvents>
        <StatusEvent>
          <Event>sample string 2</Event>
          <EventDateTime>sample string 1</EventDateTime>
          <EventType>sample string 4</EventType>
          <TriggeredBy>sample string 3</TriggeredBy>
        </StatusEvent>
        <StatusEvent>
          <Event>sample string 2</Event>
          <EventDateTime>sample string 1</EventDateTime>
          <EventType>sample string 4</EventType>
          <TriggeredBy>sample string 3</TriggeredBy>
        </StatusEvent>
      </DocumentEvents>
      <DocumentStatus>sample string 3</DocumentStatus>
      <DocumentType>sample string 2</DocumentType>
      <LastEventDateTime>sample string 1</LastEventDateTime>
    </StatusDocument>
    <StatusDocument>
      <DocumentEvents>
        <StatusEvent>
          <Event>sample string 2</Event>
          <EventDateTime>sample string 1</EventDateTime>
          <EventType>sample string 4</EventType>
          <TriggeredBy>sample string 3</TriggeredBy>
        </StatusEvent>
        <StatusEvent>
          <Event>sample string 2</Event>
          <EventDateTime>sample string 1</EventDateTime>
          <EventType>sample string 4</EventType>
          <TriggeredBy>sample string 3</TriggeredBy>
        </StatusEvent>
      </DocumentEvents>
      <DocumentStatus>sample string 3</DocumentStatus>
      <DocumentType>sample string 2</DocumentType>
      <LastEventDateTime>sample string 1</LastEventDateTime>
    </StatusDocument>
  </Documents>
  <LastEventDateTime>sample string 2</LastEventDateTime>
  <PortfolioEvents>
    <StatusEvent>
      <Event>sample string 2</Event>
      <EventDateTime>sample string 1</EventDateTime>
      <EventType>sample string 4</EventType>
      <TriggeredBy>sample string 3</TriggeredBy>
    </StatusEvent>
    <StatusEvent>
      <Event>sample string 2</Event>
      <EventDateTime>sample string 1</EventDateTime>
      <EventType>sample string 4</EventType>
      <TriggeredBy>sample string 3</TriggeredBy>
    </StatusEvent>
  </PortfolioEvents>
  <PortfolioId>3</PortfolioId>
  <PortfolioStatus>sample string 4</PortfolioStatus>
  <Signers>
    <StatusSigner>
      <CellNumber>sample string 4</CellNumber>
      <Email>sample string 3</Email>
      <FullName>sample string 2</FullName>
      <IdNumber>sample string 5</IdNumber>
      <LastEventDateTime>sample string 1</LastEventDateTime>
      <SignerEvents>
        <StatusEvent>
          <Event>sample string 2</Event>
          <EventDateTime>sample string 1</EventDateTime>
          <EventType>sample string 4</EventType>
          <TriggeredBy>sample string 3</TriggeredBy>
        </StatusEvent>
        <StatusEvent>
          <Event>sample string 2</Event>
          <EventDateTime>sample string 1</EventDateTime>
          <EventType>sample string 4</EventType>
          <TriggeredBy>sample string 3</TriggeredBy>
        </StatusEvent>
      </SignerEvents>
      <UserStatus>sample string 6</UserStatus>
    </StatusSigner>
    <StatusSigner>
      <CellNumber>sample string 4</CellNumber>
      <Email>sample string 3</Email>
      <FullName>sample string 2</FullName>
      <IdNumber>sample string 5</IdNumber>
      <LastEventDateTime>sample string 1</LastEventDateTime>
      <SignerEvents>
        <StatusEvent>
          <Event>sample string 2</Event>
          <EventDateTime>sample string 1</EventDateTime>
          <EventType>sample string 4</EventType>
          <TriggeredBy>sample string 3</TriggeredBy>
        </StatusEvent>
        <StatusEvent>
          <Event>sample string 2</Event>
          <EventDateTime>sample string 1</EventDateTime>
          <EventType>sample string 4</EventType>
          <TriggeredBy>sample string 3</TriggeredBy>
        </StatusEvent>
      </SignerEvents>
      <UserStatus>sample string 6</UserStatus>
    </StatusSigner>
  </Signers>
  <TransactionId>sample string 1</TransactionId>
</StatusResult>