POST api/Options

Post api for options

Request Information

URI Parameters

None.

Body Parameters

OptionsInsertUpdateModel
NameDescriptionTypeAdditional information
OptionID

integer

None.

QuotationID

integer

None.

InvoiceID

integer

None.

SalesOrderID

integer

None.

lstItem

Collection of OptionItemModel

None.

UserID

integer

None.

APIKey

string

None.

IsDefault

integer

None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "optionID": 1,
  "quotationID": 1,
  "invoiceID": 1,
  "salesOrderID": 1,
  "lstItem": [
    {
      "optionType": "sample string 1",
      "optionNumber": 2,
      "rating": 3.0,
      "partID": 4,
      "partCode": "sample string 5",
      "partDescription": "sample string 6",
      "totalAmount": 7.0,
      "custom1": "sample string 8",
      "custom2": "sample string 9",
      "custom3": "sample string 10",
      "custom4": "sample string 11",
      "custom5": "sample string 12"
    },
    {
      "optionType": "sample string 1",
      "optionNumber": 2,
      "rating": 3.0,
      "partID": 4,
      "partCode": "sample string 5",
      "partDescription": "sample string 6",
      "totalAmount": 7.0,
      "custom1": "sample string 8",
      "custom2": "sample string 9",
      "custom3": "sample string 10",
      "custom4": "sample string 11",
      "custom5": "sample string 12"
    }
  ],
  "userID": 1,
  "apiKey": "sample string 2",
  "isDefault": 3
}

application/xml, text/xml

Sample:
<OptionsInsertUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <APIKey>sample string 2</APIKey>
  <InvoiceID>1</InvoiceID>
  <IsDefault>3</IsDefault>
  <OptionID>1</OptionID>
  <QuotationID>1</QuotationID>
  <SalesOrderID>1</SalesOrderID>
  <UserID>1</UserID>
  <lstItem>
    <OptionItemModel>
      <Custom1>sample string 8</Custom1>
      <Custom2>sample string 9</Custom2>
      <Custom3>sample string 10</Custom3>
      <Custom4>sample string 11</Custom4>
      <Custom5>sample string 12</Custom5>
      <OptionNumber>2</OptionNumber>
      <OptionType>sample string 1</OptionType>
      <PartCode>sample string 5</PartCode>
      <PartDescription>sample string 6</PartDescription>
      <PartID>4</PartID>
      <Rating>3</Rating>
      <TotalAmount>7</TotalAmount>
    </OptionItemModel>
    <OptionItemModel>
      <Custom1>sample string 8</Custom1>
      <Custom2>sample string 9</Custom2>
      <Custom3>sample string 10</Custom3>
      <Custom4>sample string 11</Custom4>
      <Custom5>sample string 12</Custom5>
      <OptionNumber>2</OptionNumber>
      <OptionType>sample string 1</OptionType>
      <PartCode>sample string 5</PartCode>
      <PartDescription>sample string 6</PartDescription>
      <PartID>4</PartID>
      <Rating>3</Rating>
      <TotalAmount>7</TotalAmount>
    </OptionItemModel>
  </lstItem>
</OptionsInsertUpdateModel>

multipart/form-data

Sample:
<OptionsInsertUpdateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><APIKey>sample string 2</APIKey><InvoiceID>1</InvoiceID><IsDefault>3</IsDefault><OptionID>1</OptionID><QuotationID>1</QuotationID><SalesOrderID>1</SalesOrderID><UserID>1</UserID><lstItem><OptionItemModel><Custom1>sample string 8</Custom1><Custom2>sample string 9</Custom2><Custom3>sample string 10</Custom3><Custom4>sample string 11</Custom4><Custom5>sample string 12</Custom5><OptionNumber>2</OptionNumber><OptionType>sample string 1</OptionType><PartCode>sample string 5</PartCode><PartDescription>sample string 6</PartDescription><PartID>4</PartID><Rating>3</Rating><TotalAmount>7</TotalAmount></OptionItemModel><OptionItemModel><Custom1>sample string 8</Custom1><Custom2>sample string 9</Custom2><Custom3>sample string 10</Custom3><Custom4>sample string 11</Custom4><Custom5>sample string 12</Custom5><OptionNumber>2</OptionNumber><OptionType>sample string 1</OptionType><PartCode>sample string 5</PartCode><PartDescription>sample string 6</PartDescription><PartID>4</PartID><Rating>3</Rating><TotalAmount>7</TotalAmount></OptionItemModel></lstItem></OptionsInsertUpdateModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

QuotationInvoiceOptionSaveResponseModel
NameDescriptionTypeAdditional information
OptionGUID

string

None.

ReturnID

integer

Required

Message

string

Required

Successful

boolean

Required

Code

integer

None.

TotalRecord

integer

None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:
{
  "optionGUID": "sample string 1",
  "returnID": 2,
  "message": "sample string 3",
  "successful": true,
  "code": 5,
  "totalRecord": 6
}

application/xml, text/xml

Sample:
<QuotationInvoiceOptionSaveResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel">
  <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</Code>
  <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 3</Message>
  <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">2</ReturnID>
  <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
  <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">6</TotalRecord>
  <OptionGUID>sample string 1</OptionGUID>
</QuotationInvoiceOptionSaveResponseModel>

multipart/form-data

Sample:
<QuotationInvoiceOptionSaveResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 3</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">2</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">6</TotalRecord><OptionGUID>sample string 1</OptionGUID></QuotationInvoiceOptionSaveResponseModel>