POST api/Workflow/Save

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
WorkflowId	globally unique identifier	None.
CurrentStepId	globally unique identifier	None.
UserId	globally unique identifier	None.
CPDId	globally unique identifier	None.
CPDPeriodId	globally unique identifier	None.
WaitlistEventId	globally unique identifier	None.
WaitlistTicketTypeId	globally unique identifier	None.
CPDReductionId	globally unique identifier	None.
CartId	globally unique identifier	None.
EntityId	globally unique identifier	None.
EntityType	string	None.
Created	date	None.
LastModified	date	None.
WorkflowName	string	None.
Values	Collection of WorkflowPostedField	None.
PaymentSuccessful	boolean	None.
PaymentGatewayTransactionRef	string	None.
PreviousStepIds	Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "9e13875a-4b19-4d14-b78d-a30e1efab9b9",
  "WorkflowId": "19b79891-24ba-4626-8196-c98ec6bfd3d7",
  "CurrentStepId": "99fc27c3-74dd-4971-b899-86e23244285d",
  "UserId": "cbdf476d-ac8a-4684-b9e8-f05e3b053180",
  "CPDId": "a34b6d4c-242c-4d22-aa32-4d8824f73b5f",
  "CPDPeriodId": "02fc914a-e017-4789-a365-2930fa6d731e",
  "WaitlistEventId": "e66d3efb-0d70-4bce-bac1-32f925cadb73",
  "WaitlistTicketTypeId": "2ce285e3-072e-4827-b66b-6fb051a3d220",
  "CPDReductionId": "3058a02a-c270-424f-a054-47b3a3f63078",
  "CartId": "ee0b4d18-5591-48f3-aa32-a308cfb4e338",
  "EntityId": "3b0e924b-a1e7-4ff6-9d0d-376dee540c5b",
  "EntityType": "sample string 4",
  "Created": "2024-11-29T09:53:49.4560951+11:00",
  "LastModified": "2024-11-29T09:53:49.4560951+11:00",
  "WorkflowName": "sample string 7",
  "Values": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "FileValues": [
        {
          "Name": "sample string 1",
          "NewName": "sample string 2",
          "Path": "sample string 3",
          "IsDeleted": true
        },
        {
          "Name": "sample string 1",
          "NewName": "sample string 2",
          "Path": "sample string 3",
          "IsDeleted": true
        }
      ],
      "Mapping": "sample string 3",
      "FieldType": "sample string 4",
      "Text": "sample string 5",
      "AdditionalRef": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2",
      "FileValues": [
        {
          "Name": "sample string 1",
          "NewName": "sample string 2",
          "Path": "sample string 3",
          "IsDeleted": true
        },
        {
          "Name": "sample string 1",
          "NewName": "sample string 2",
          "Path": "sample string 3",
          "IsDeleted": true
        }
      ],
      "Mapping": "sample string 3",
      "FieldType": "sample string 4",
      "Text": "sample string 5",
      "AdditionalRef": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "PaymentSuccessful": true,
  "PaymentGatewayTransactionRef": "sample string 8",
  "PreviousStepIds": [
    "3fd65eea-393e-46c6-a482-5e2885cb2a1f",
    "38d4be54-2938-4947-8fdf-e52cdd7f9da8"
  ]
}

application/xml, text/xml

Sample:

<WorkflowPostedFieldsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Request">
  <CPDId>a34b6d4c-242c-4d22-aa32-4d8824f73b5f</CPDId>
  <CPDPeriodId>02fc914a-e017-4789-a365-2930fa6d731e</CPDPeriodId>
  <CPDReductionId>3058a02a-c270-424f-a054-47b3a3f63078</CPDReductionId>
  <CartId>ee0b4d18-5591-48f3-aa32-a308cfb4e338</CartId>
  <Created>2024-11-29T09:53:49.4560951+11:00</Created>
  <CurrentStepId>99fc27c3-74dd-4971-b899-86e23244285d</CurrentStepId>
  <EntityId>3b0e924b-a1e7-4ff6-9d0d-376dee540c5b</EntityId>
  <EntityType>sample string 4</EntityType>
  <Id>9e13875a-4b19-4d14-b78d-a30e1efab9b9</Id>
  <LastModified>2024-11-29T09:53:49.4560951+11:00</LastModified>
  <PaymentGatewayTransactionRef>sample string 8</PaymentGatewayTransactionRef>
  <PaymentSuccessful>true</PaymentSuccessful>
  <PreviousStepIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>3fd65eea-393e-46c6-a482-5e2885cb2a1f</d2p1:guid>
    <d2p1:guid>38d4be54-2938-4947-8fdf-e52cdd7f9da8</d2p1:guid>
  </PreviousStepIds>
  <UserId>cbdf476d-ac8a-4684-b9e8-f05e3b053180</UserId>
  <Values>
    <WorkflowPostedField>
      <AdditionalRef>
        <WorkflowAdditionalRef>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </WorkflowAdditionalRef>
        <WorkflowAdditionalRef>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </WorkflowAdditionalRef>
      </AdditionalRef>
      <FieldType>sample string 4</FieldType>
      <FileValues>
        <DocumentValues>
          <IsDeleted>true</IsDeleted>
          <Name>sample string 1</Name>
          <NewName>sample string 2</NewName>
          <Path>sample string 3</Path>
        </DocumentValues>
        <DocumentValues>
          <IsDeleted>true</IsDeleted>
          <Name>sample string 1</Name>
          <NewName>sample string 2</NewName>
          <Path>sample string 3</Path>
        </DocumentValues>
      </FileValues>
      <Mapping>sample string 3</Mapping>
      <Name>sample string 1</Name>
      <Text>sample string 5</Text>
      <Value>sample string 2</Value>
    </WorkflowPostedField>
    <WorkflowPostedField>
      <AdditionalRef>
        <WorkflowAdditionalRef>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </WorkflowAdditionalRef>
        <WorkflowAdditionalRef>
          <Key>sample string 1</Key>
          <Value>sample string 2</Value>
        </WorkflowAdditionalRef>
      </AdditionalRef>
      <FieldType>sample string 4</FieldType>
      <FileValues>
        <DocumentValues>
          <IsDeleted>true</IsDeleted>
          <Name>sample string 1</Name>
          <NewName>sample string 2</NewName>
          <Path>sample string 3</Path>
        </DocumentValues>
        <DocumentValues>
          <IsDeleted>true</IsDeleted>
          <Name>sample string 1</Name>
          <NewName>sample string 2</NewName>
          <Path>sample string 3</Path>
        </DocumentValues>
      </FileValues>
      <Mapping>sample string 3</Mapping>
      <Name>sample string 1</Name>
      <Text>sample string 5</Text>
      <Value>sample string 2</Value>
    </WorkflowPostedField>
  </Values>
  <WaitlistEventId>e66d3efb-0d70-4bce-bac1-32f925cadb73</WaitlistEventId>
  <WaitlistTicketTypeId>2ce285e3-072e-4827-b66b-6fb051a3d220</WaitlistTicketTypeId>
  <WorkflowId>19b79891-24ba-4626-8196-c98ec6bfd3d7</WorkflowId>
  <WorkflowName>sample string 7</WorkflowName>
</WorkflowPostedFieldsRequestModel>

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

Response Information

Resource Description

WorkflowSaveResponseModel

Name	Type	Additional information
MemberId	string	None.
SubscriptionId	globally unique identifier	None.
InvoiceId	globally unique identifier	None.
ClassifiedItemId	globally unique identifier	None.
PaymentSuccessful	boolean	None.
PaymentGatewayTransactionRef	string	None.
Result	ResponseResult	None.

Response Formats

application/json, text/json

Sample:

{
  "MemberId": "sample string 1",
  "SubscriptionId": "f288e469-f22f-4b2b-b6e6-36568c77062e",
  "InvoiceId": "2906243f-a9cc-4527-916a-4b547a32d2b9",
  "ClassifiedItemId": "7d85b4a6-ef34-413c-9782-88c458e75498",
  "PaymentSuccessful": true,
  "PaymentGatewayTransactionRef": "sample string 2",
  "Result": {
    "Success": true,
    "Message": "sample string 2",
    "Errors": [
      {
        "Message": "sample string 1"
      },
      {
        "Message": "sample string 1"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<WorkflowSaveResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Response">
  <Result>
    <Errors>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
    </Errors>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </Result>
  <ClassifiedItemId>7d85b4a6-ef34-413c-9782-88c458e75498</ClassifiedItemId>
  <InvoiceId>2906243f-a9cc-4527-916a-4b547a32d2b9</InvoiceId>
  <MemberId>sample string 1</MemberId>
  <PaymentGatewayTransactionRef>sample string 2</PaymentGatewayTransactionRef>
  <PaymentSuccessful>true</PaymentSuccessful>
  <SubscriptionId>f288e469-f22f-4b2b-b6e6-36568c77062e</SubscriptionId>
</WorkflowSaveResponseModel>