POST api/ApiIntegration/SBSetTag

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PrivateApiKey		string	None.
JobsAndTagsList		Collection of ApiJobTagsInfoParam	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "jobsAndTagsList": [
    {
      "jobOrQuoteNumber": "sample string 1",
      "tagName": "sample string 2"
    },
    {
      "jobOrQuoteNumber": "sample string 1",
      "tagName": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ApiSetTagParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <JobsAndTagsList>
    <ApiJobTagsInfoParam>
      <JobOrQuoteNumber>sample string 1</JobOrQuoteNumber>
      <TagName>sample string 2</TagName>
    </ApiJobTagsInfoParam>
    <ApiJobTagsInfoParam>
      <JobOrQuoteNumber>sample string 1</JobOrQuoteNumber>
      <TagName>sample string 2</TagName>
    </ApiJobTagsInfoParam>
  </JobsAndTagsList>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiSetTagParam>

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.
ErrorString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "fae4133f-44f6-4c93-8b37-99e0c65580df",
  "responseNote": "sample string 2",
  "errorString": "sample string 3"
}

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">
  <ErrorString>sample string 3</ErrorString>
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>fae4133f-44f6-4c93-8b37-99e0c65580df</ReturnKey>
</ApiResponse>