POST api/deal/add

This operation for add new deal. Require at least "Order date" and "Department name". If a deal creation is successful, response is keyId otherwise, response is error message.

Request Information

Body Parameters

Deal_Input
NameDescriptionTypeAdditional information
deptName

Department Name

string

None.

orderDate

Order Date
Example : "01-Dec-17"

string

None.

columns

Deal details.

Collection of DealColumn

None.

Request Formats

application/json, text/json

Sample:
{
  "deptName": "sample string 1",
  "orderDate": "sample string 2",
  "columns": [
    {
      "columnId": "sample string 1",
      "value": "sample string 2"
    },
    {
      "columnId": "sample string 1",
      "value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<Deal_Input xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaleslogsRESTService.Controllers">
  <columns>
    <DealColumn>
      <columnId>sample string 1</columnId>
      <value>sample string 2</value>
    </DealColumn>
    <DealColumn>
      <columnId>sample string 1</columnId>
      <value>sample string 2</value>
    </DealColumn>
  </columns>
  <deptName>sample string 1</deptName>
  <orderDate>sample string 2</orderDate>
</Deal_Input>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

ResponseMessage
NameDescriptionTypeAdditional information
status

Return status (True or False)

boolean

None.

message

Return error description.

string

None.

keyId

Return Unique id

string

None.

logType

logType : Fail,Information,Successful

LogType

None.

Response Formats

application/json, text/json

Sample:
{
  "status": true,
  "message": "sample string 2",
  "keyId": "sample string 3",
  "logType": 0
}

application/xml, text/xml

Sample:
<ResponseMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaleslogsRESTService.Models">
  <keyId>sample string 3</keyId>
  <logType>Information</logType>
  <message>sample string 2</message>
  <status>true</status>
</ResponseMessage>