POST api/Sahel/cEnquiryForImportedProducts?civilId={civilId}&stepNo={stepNo}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
civilId

string

Required

stepNo

integer

Required

Body Parameters

Collection of InputItemModels
NameDescriptionTypeAdditional information
Key

string

None.

Value

string

None.

Type

integer

None.

Extension

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "Key": "sample string 1",
    "Value": "sample string 2",
    "Type": 3,
    "Extension": "sample string 4"
  },
  {
    "Key": "sample string 1",
    "Value": "sample string 2",
    "Type": 3,
    "Extension": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfInputItemModels xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <InputItemModels>
    <Key>sample string 1</Key>
    <Value>sample string 2</Value>
    <Type>3</Type>
    <Extension>sample string 4</Extension>
  </InputItemModels>
  <InputItemModels>
    <Key>sample string 1</Key>
    <Value>sample string 2</Value>
    <Type>3</Type>
    <Extension>sample string 4</Extension>
  </InputItemModels>
</ArrayOfInputItemModels>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Root
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Message

string

None.

MessageEn

string

None.

Result

Result

None.

Actions

Collection of Action

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Message": "sample string 2",
  "MessageEn": "sample string 3",
  "Result": {
    "NameAr": "sample string 1",
    "NameEn": "sample string 2",
    "HintAr": "sample string 3",
    "HintEn": "sample string 4",
    "StepNo": 5,
    "TOS": "sample string 6",
    "ButtonLabelEn": "sample string 7",
    "ButtonLabelAr": "sample string 8",
    "ControlsModels": [
      {
        "Id": "sample string 1",
        "Type": "sample string 2",
        "LabelAr": "sample string 3",
        "LabelEn": "sample string 4",
        "HintAr": "sample string 5",
        "HintEn": "sample string 6",
        "MaxLength": "sample string 7",
        "IsRequired": true,
        "IsDisable": true,
        "OptionControlModels": [
          {
            "Value": "sample string 1",
            "TextAr": "sample string 2",
            "TextEn": "sample string 3"
          },
          {
            "Value": "sample string 1",
            "TextAr": "sample string 2",
            "TextEn": "sample string 3"
          }
        ],
        "AllowedExtensions": "sample string 10",
        "DefaultValue": "sample string 11",
        "FirstDate": "sample string 12",
        "LastDate": "sample string 13",
        "Validators": [
          {
            "Regex": "sample string 1",
            "MessageAr": "sample string 2",
            "MessageEn": "sample string 3"
          },
          {
            "Regex": "sample string 1",
            "MessageAr": "sample string 2",
            "MessageEn": "sample string 3"
          }
        ]
      },
      {
        "Id": "sample string 1",
        "Type": "sample string 2",
        "LabelAr": "sample string 3",
        "LabelEn": "sample string 4",
        "HintAr": "sample string 5",
        "HintEn": "sample string 6",
        "MaxLength": "sample string 7",
        "IsRequired": true,
        "IsDisable": true,
        "OptionControlModels": [
          {
            "Value": "sample string 1",
            "TextAr": "sample string 2",
            "TextEn": "sample string 3"
          },
          {
            "Value": "sample string 1",
            "TextAr": "sample string 2",
            "TextEn": "sample string 3"
          }
        ],
        "AllowedExtensions": "sample string 10",
        "DefaultValue": "sample string 11",
        "FirstDate": "sample string 12",
        "LastDate": "sample string 13",
        "Validators": [
          {
            "Regex": "sample string 1",
            "MessageAr": "sample string 2",
            "MessageEn": "sample string 3"
          },
          {
            "Regex": "sample string 1",
            "MessageAr": "sample string 2",
            "MessageEn": "sample string 3"
          }
        ]
      }
    ]
  },
  "actions": [
    {
      "actionType": "sample string 1",
      "actionUrl": "sample string 2",
      "viewBag": "sample string 3",
      "labelAr": "sample string 4",
      "labelEn": "sample string 5"
    },
    {
      "actionType": "sample string 1",
      "actionUrl": "sample string 2",
      "viewBag": "sample string 3",
      "labelAr": "sample string 4",
      "labelEn": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<Root xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <MessageEn>sample string 3</MessageEn>
  <Result>
    <NameAr>sample string 1</NameAr>
    <NameEn>sample string 2</NameEn>
    <HintAr>sample string 3</HintAr>
    <HintEn>sample string 4</HintEn>
    <StepNo>5</StepNo>
    <TOS>sample string 6</TOS>
    <ButtonLabelEn>sample string 7</ButtonLabelEn>
    <ButtonLabelAr>sample string 8</ButtonLabelAr>
    <ControlsModels>
      <ControlsModel>
        <Id>sample string 1</Id>
        <Type>sample string 2</Type>
        <LabelAr>sample string 3</LabelAr>
        <LabelEn>sample string 4</LabelEn>
        <HintAr>sample string 5</HintAr>
        <HintEn>sample string 6</HintEn>
        <MaxLength>sample string 7</MaxLength>
        <IsRequired>true</IsRequired>
        <IsDisable>true</IsDisable>
        <OptionControlModels>
          <OptionControlModel>
            <Value>sample string 1</Value>
            <TextAr>sample string 2</TextAr>
            <TextEn>sample string 3</TextEn>
          </OptionControlModel>
          <OptionControlModel>
            <Value>sample string 1</Value>
            <TextAr>sample string 2</TextAr>
            <TextEn>sample string 3</TextEn>
          </OptionControlModel>
        </OptionControlModels>
        <AllowedExtensions>sample string 10</AllowedExtensions>
        <DefaultValue>sample string 11</DefaultValue>
        <FirstDate>sample string 12</FirstDate>
        <LastDate>sample string 13</LastDate>
        <Validators>
          <Validator>
            <Regex>sample string 1</Regex>
            <MessageAr>sample string 2</MessageAr>
            <MessageEn>sample string 3</MessageEn>
          </Validator>
          <Validator>
            <Regex>sample string 1</Regex>
            <MessageAr>sample string 2</MessageAr>
            <MessageEn>sample string 3</MessageEn>
          </Validator>
        </Validators>
      </ControlsModel>
      <ControlsModel>
        <Id>sample string 1</Id>
        <Type>sample string 2</Type>
        <LabelAr>sample string 3</LabelAr>
        <LabelEn>sample string 4</LabelEn>
        <HintAr>sample string 5</HintAr>
        <HintEn>sample string 6</HintEn>
        <MaxLength>sample string 7</MaxLength>
        <IsRequired>true</IsRequired>
        <IsDisable>true</IsDisable>
        <OptionControlModels>
          <OptionControlModel>
            <Value>sample string 1</Value>
            <TextAr>sample string 2</TextAr>
            <TextEn>sample string 3</TextEn>
          </OptionControlModel>
          <OptionControlModel>
            <Value>sample string 1</Value>
            <TextAr>sample string 2</TextAr>
            <TextEn>sample string 3</TextEn>
          </OptionControlModel>
        </OptionControlModels>
        <AllowedExtensions>sample string 10</AllowedExtensions>
        <DefaultValue>sample string 11</DefaultValue>
        <FirstDate>sample string 12</FirstDate>
        <LastDate>sample string 13</LastDate>
        <Validators>
          <Validator>
            <Regex>sample string 1</Regex>
            <MessageAr>sample string 2</MessageAr>
            <MessageEn>sample string 3</MessageEn>
          </Validator>
          <Validator>
            <Regex>sample string 1</Regex>
            <MessageAr>sample string 2</MessageAr>
            <MessageEn>sample string 3</MessageEn>
          </Validator>
        </Validators>
      </ControlsModel>
    </ControlsModels>
  </Result>
  <actions>
    <Action>
      <actionType>sample string 1</actionType>
      <actionUrl>sample string 2</actionUrl>
      <viewBag>sample string 3</viewBag>
      <labelAr>sample string 4</labelAr>
      <labelEn>sample string 5</labelEn>
    </Action>
    <Action>
      <actionType>sample string 1</actionType>
      <actionUrl>sample string 2</actionUrl>
      <viewBag>sample string 3</viewBag>
      <labelAr>sample string 4</labelAr>
      <labelEn>sample string 5</labelEn>
    </Action>
  </actions>
</Root>