POST api/ApiIntegration/SBApiDeleteJob

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PrivateApiKey		string	None.
JobKey		globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "jobKey": "e2a9cb8b-3335-4234-bd1c-33670a3c711e"
}

application/xml, text/xml

Sample:

<ApiDeleteJobParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <JobKey>e2a9cb8b-3335-4234-bd1c-33670a3c711e</JobKey>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiDeleteJobParam>

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": "ad8c548f-d192-4aa6-a7d0-d21f0b17f010",
  "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>ad8c548f-d192-4aa6-a7d0-d21f0b17f010</ReturnKey>
</ApiResponse>