Net3 API Interface for Customer Portal

<back to all web services

Workflow

Requires Authentication
The following routes are available for this service:
GET/workflowsReturn information about Workflows
GET/workflowReturn detailed information about workflow
POST/workflow/{workflowId}Execute workflow
Workflow Parameters:
NameParameterData TypeRequiredDescription
workflowIdpathstringNo
WorkflowBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
datacenterLocationformstringNo
WorkflowResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseformObjectNo
ReponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /workflow/{workflowId} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Workflow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <datacenterLocation>String</datacenterLocation>
  <sessionId>String</sessionId>
  <workflowId>String</workflowId>
</Workflow>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <ReponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ReponseStatus>
  <Response />
</WorkflowResponse>