POST api/BackgroundProcessing/SaveTransactionRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserID	string	None.
BranchID	integer	None.
FormName	string	None.
FormPath	string	None.
JSON	Collection of NameValuePair	None.
FormFiles	Collection of FileNameValuePair	None.
CollectionJSON	Collection of NameValuePair	None.
FileUploadTags	Collection of string	None.
Html	string	None.
TransactionDocumentID	string	None.
UniqueTransactionID	string	None.
ClientSideID	string	None.
ExternalTenantID	integer	None.
EmailWorkFlows	Collection of EmailWorkFlowItem	None.
Synced	boolean	None.
AttachmentsInBackground	boolean	None.
NumberOfAttachments	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserID": "sample string 1",
  "BranchID": 1,
  "FormName": "sample string 2",
  "FormPath": "sample string 3",
  "JSON": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "FormFiles": [
    {
      "fileExt": "sample string 1",
      "ClientSideID": "sample string 2",
      "Complete": true,
      "name": "sample string 4",
      "value": "sample string 5"
    },
    {
      "fileExt": "sample string 1",
      "ClientSideID": "sample string 2",
      "Complete": true,
      "name": "sample string 4",
      "value": "sample string 5"
    }
  ],
  "CollectionJSON": [
    {
      "name": "sample string 1",
      "value": "sample string 2"
    },
    {
      "name": "sample string 1",
      "value": "sample string 2"
    }
  ],
  "FileUploadTags": [
    "sample string 1",
    "sample string 2"
  ],
  "Html": "sample string 4",
  "TransactionDocumentID": "sample string 5",
  "UniqueTransactionID": "sample string 6",
  "ClientSideID": "sample string 7",
  "ExternalTenantID": 8,
  "EmailWorkFlows": [
    {
      "ToAddresses": [
        "sample string 1",
        "sample string 2"
      ],
      "SubjectLine": "sample string 1",
      "Body": "sample string 2",
      "DocumentsToSend": "sample string 3"
    },
    {
      "ToAddresses": [
        "sample string 1",
        "sample string 2"
      ],
      "SubjectLine": "sample string 1",
      "Body": "sample string 2",
      "DocumentsToSend": "sample string 3"
    }
  ],
  "Synced": true,
  "AttachmentsInBackground": true,
  "NumberOfAttachments": 11
}

text/html

Sample:

{"UserID":"sample string 1","BranchID":1,"FormName":"sample string 2","FormPath":"sample string 3","JSON":[{"name":"sample string 1","value":"sample string 2"},{"name":"sample string 1","value":"sample string 2"}],"FormFiles":[{"fileExt":"sample string 1","ClientSideID":"sample string 2","Complete":true,"name":"sample string 4","value":"sample string 5"},{"fileExt":"sample string 1","ClientSideID":"sample string 2","Complete":true,"name":"sample string 4","value":"sample string 5"}],"CollectionJSON":[{"name":"sample string 1","value":"sample string 2"},{"name":"sample string 1","value":"sample string 2"}],"FileUploadTags":["sample string 1","sample string 2"],"Html":"sample string 4","TransactionDocumentID":"sample string 5","UniqueTransactionID":"sample string 6","ClientSideID":"sample string 7","ExternalTenantID":8,"EmailWorkFlows":[{"ToAddresses":["sample string 1","sample string 2"],"SubjectLine":"sample string 1","Body":"sample string 2","DocumentsToSend":"sample string 3"},{"ToAddresses":["sample string 1","sample string 2"],"SubjectLine":"sample string 1","Body":"sample string 2","DocumentsToSend":"sample string 3"}],"Synced":true,"AttachmentsInBackground":true,"NumberOfAttachments":11}

application/xml, text/xml

Sample:

<FormDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GreemFormServices.Models">
  <AttachmentsInBackground>true</AttachmentsInBackground>
  <BranchID>1</BranchID>
  <ClientSideID>sample string 7</ClientSideID>
  <CollectionJSON>
    <NameValuePair>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </NameValuePair>
    <NameValuePair>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </NameValuePair>
  </CollectionJSON>
  <EmailWorkFlows>
    <EmailWorkFlowItem>
      <Body>sample string 2</Body>
      <DocumentsToSend>sample string 3</DocumentsToSend>
      <SubjectLine>sample string 1</SubjectLine>
      <ToAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ToAddresses>
    </EmailWorkFlowItem>
    <EmailWorkFlowItem>
      <Body>sample string 2</Body>
      <DocumentsToSend>sample string 3</DocumentsToSend>
      <SubjectLine>sample string 1</SubjectLine>
      <ToAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </ToAddresses>
    </EmailWorkFlowItem>
  </EmailWorkFlows>
  <ExternalTenantID>8</ExternalTenantID>
  <FileUploadTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FileUploadTags>
  <FormFiles>
    <FileNameValuePair>
      <name>sample string 4</name>
      <value>sample string 5</value>
      <ClientSideID>sample string 2</ClientSideID>
      <Complete>true</Complete>
      <fileExt>sample string 1</fileExt>
    </FileNameValuePair>
    <FileNameValuePair>
      <name>sample string 4</name>
      <value>sample string 5</value>
      <ClientSideID>sample string 2</ClientSideID>
      <Complete>true</Complete>
      <fileExt>sample string 1</fileExt>
    </FileNameValuePair>
  </FormFiles>
  <FormName>sample string 2</FormName>
  <FormPath>sample string 3</FormPath>
  <Html>sample string 4</Html>
  <JSON>
    <NameValuePair>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </NameValuePair>
    <NameValuePair>
      <name>sample string 1</name>
      <value>sample string 2</value>
    </NameValuePair>
  </JSON>
  <NumberOfAttachments>11</NumberOfAttachments>
  <Synced>true</Synced>
  <TransactionDocumentID>sample string 5</TransactionDocumentID>
  <UniqueTransactionID>sample string 6</UniqueTransactionID>
  <UserID>sample string 1</UserID>
</FormDataModel>

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 'FormDataModel'.

Response Information

Resource Description

ApiResponse

Name	Type	Additional information
HttpResponseCode	HttpStatusCode	None.
ResponseMessage	string	None.
ResponseObject	Object	None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.