POST api/ApiIntegration/SBCreateUpdateMaterial

Request Information

URI Parameters

None.

Body Parameters

ApiAddUpdateMaterialCost
NameDescriptionTypeAdditional information
PrivateApiKey

string

None.

ListOfMaterials

Collection of ApiMaterialInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "privateApiKey": "sample string 1",
  "listOfMaterials": [
    {
      "material": "sample string 1",
      "grain": true,
      "costMethod": "sample string 3",
      "basePercentage": "sample string 4",
      "class": "sample string 5",
      "weight": 1,
      "abbrev": "sample string 6"
    },
    {
      "material": "sample string 1",
      "grain": true,
      "costMethod": "sample string 3",
      "basePercentage": "sample string 4",
      "class": "sample string 5",
      "weight": 1,
      "abbrev": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiAddUpdateMaterialCost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ListOfMaterials>
    <ApiMaterialInfo>
      <Abbrev>sample string 6</Abbrev>
      <BasePercentage>sample string 4</BasePercentage>
      <Class>sample string 5</Class>
      <CostMethod>sample string 3</CostMethod>
      <Grain>true</Grain>
      <Material>sample string 1</Material>
      <Weight>1</Weight>
    </ApiMaterialInfo>
    <ApiMaterialInfo>
      <Abbrev>sample string 6</Abbrev>
      <BasePercentage>sample string 4</BasePercentage>
      <Class>sample string 5</Class>
      <CostMethod>sample string 3</CostMethod>
      <Grain>true</Grain>
      <Material>sample string 1</Material>
      <Weight>1</Weight>
    </ApiMaterialInfo>
  </ListOfMaterials>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiAddUpdateMaterialCost>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
ResponseCode

integer

None.

ReturnKey

globally unique identifier

None.

ResponseNote

string

None.

Response Formats

application/json, text/json

Sample:
{
  "responseCode": 1,
  "returnKey": "1b46afc1-fbd9-4a8f-97f8-c96d1793a394",
  "responseNote": "sample string 2"
}

application/xml, text/xml

Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>1b46afc1-fbd9-4a8f-97f8-c96d1793a394</ReturnKey>
</ApiResponse>