POST api/ApiIntegration/SPAddOrUpdatePart

Request Information

URI Parameters

None.

Body Parameters

APIPartAddUpdateViewModel
NameDescriptionTypeAdditional information
PrivateApiKey

string

None.

Category

string

None.

PartDetail

PartDetailViewModel

None.

Request Formats

application/json, text/json

Sample:
{
  "privateApiKey": "sample string 1",
  "category": "sample string 2",
  "partDetail": {
    "partKey": 1,
    "category": 2,
    "categoryDescription": "sample string 3",
    "style": "sample string 4",
    "timber": "sample string 5",
    "width": "sample string 6",
    "depth": "sample string 7",
    "length": "sample string 8",
    "flatLength": "sample string 9",
    "turn": "sample string 10",
    "fittingType": "sample string 11",
    "curved": true,
    "curvedText": "sample string 13",
    "radiusType": "sample string 14",
    "sideNose": "sample string 15",
    "description": "sample string 16",
    "partId": "sample string 17",
    "altSku": "sample string 18",
    "buy": "sample string 19",
    "sell1": "sample string 20",
    "sell2": "sample string 21",
    "uom": "sample string 22",
    "waste": "sample string 23",
    "laborCost": "sample string 24",
    "laborMinutes": "sample string 25",
    "hide": true,
    "hideText": "sample string 27",
    "note": "sample string 28",
    "tag": "sample string 29",
    "group": "sample string 30",
    "tailTime": "sample string 31",
    "notes2": "sample string 32",
    "autoPrice": "sample string 33",
    "groupKey": 34,
    "cost": 35.0,
    "width2": "sample string 36"
  }
}

application/xml, text/xml

Sample:
<APIPartAddUpdateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Category>sample string 2</Category>
  <PartDetail>
    <AltSku>sample string 18</AltSku>
    <AutoPrice>sample string 33</AutoPrice>
    <Buy>sample string 19</Buy>
    <Category>2</Category>
    <CategoryDescription>sample string 3</CategoryDescription>
    <Cost>35</Cost>
    <Curved>true</Curved>
    <CurvedText>sample string 13</CurvedText>
    <Depth>sample string 7</Depth>
    <Description>sample string 16</Description>
    <FittingType>sample string 11</FittingType>
    <FlatLength>sample string 9</FlatLength>
    <Group>sample string 30</Group>
    <GroupKey>34</GroupKey>
    <Hide>true</Hide>
    <HideText>sample string 27</HideText>
    <LaborCost>sample string 24</LaborCost>
    <LaborMinutes>sample string 25</LaborMinutes>
    <Length>sample string 8</Length>
    <Note>sample string 28</Note>
    <Notes2>sample string 32</Notes2>
    <PartId>sample string 17</PartId>
    <PartKey>1</PartKey>
    <RadiusType>sample string 14</RadiusType>
    <Sell1>sample string 20</Sell1>
    <Sell2>sample string 21</Sell2>
    <SideNose>sample string 15</SideNose>
    <Style>sample string 4</Style>
    <Tag>sample string 29</Tag>
    <TailTime>sample string 31</TailTime>
    <Timber>sample string 5</Timber>
    <Turn>sample string 10</Turn>
    <Uom>sample string 22</Uom>
    <Waste>sample string 23</Waste>
    <Width>sample string 6</Width>
    <Width2>sample string 36</Width2>
  </PartDetail>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</APIPartAddUpdateViewModel>

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": "dffe9f8d-3c3e-4113-b7a8-2ef5d97e4c5c",
  "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>dffe9f8d-3c3e-4113-b7a8-2ef5d97e4c5c</ReturnKey>
</ApiResponse>