POST api/ApiIntegration/SBSetMyDataValue

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
JobOrQuoteNumber	string	None.
JobsMyDataList	Collection of ApiMyDataInfoParam	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "jobOrQuoteNumber": "sample string 2",
  "jobsMyDataList": [
    {
      "myDataFieldName": "sample string 1",
      "myDataFieldValue": "sample string 2"
    },
    {
      "myDataFieldName": "sample string 1",
      "myDataFieldValue": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiMyDataParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <JobOrQuoteNumber>sample string 2</JobOrQuoteNumber>
  <JobsMyDataList>
    <ApiMyDataInfoParam>
      <MyDataFieldName>sample string 1</MyDataFieldName>
      <MyDataFieldValue>sample string 2</MyDataFieldValue>
    </ApiMyDataInfoParam>
    <ApiMyDataInfoParam>
      <MyDataFieldName>sample string 1</MyDataFieldName>
      <MyDataFieldValue>sample string 2</MyDataFieldValue>
    </ApiMyDataInfoParam>
  </JobsMyDataList>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiMyDataParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse

Name	Type	Additional information
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "25d92d19-4523-4bed-8ac0-2a3e4d55e31e",
  "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>25d92d19-4523-4bed-8ac0-2a3e4d55e31e</ReturnKey>
</ApiResponse>