POST api/Activity/DeleteActivity

Request a delete/deactivate for an activity. You will have to either be an InfoCare, SubContractor or Partner user to call this function. If you are a partner user, you must also have the PartnerIntegrator role. If you call this function without the correct permissions, you will get a ReadOnlyHttpResponseException

Request Information

URI Parameters

None.

Body Parameters

ActivityArgumentModel
NameDescriptionTypeAdditional information
CombinedContractLineId

Gets or sets the combined contract line id. If this property is specified and CombinedActivityId is not specified a new activity will be created based on this contract line and the updates specified in the ActivityUpdates list will be applied to the newly created activity.

 string

None.
TransactionKey

Gets or sets the transaction key you got when getting the activity

 string

None.
ActivityUpdates

Gets or sets a list of update actions.

 Collection of AttributeUpdateModel

None.
IsPublicCommentsAllowed

Gets or sets whether you are allowed to create public comments.

 boolean

None.
CombinedActivityId

Get or set combined activity id

 string

None.
FormName

Gets or sets the optional FormName. The FormName is used to limit the number of fields returned from GetActivity.

 string

None.
TicketId

Gets or sets the ticket id

 string

None.
Culture

Gets or sets culture, if not specified we will use culture set on user.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CombinedContractLineId": "sample string 1",
  "TransactionKey": "sample string 2",
  "ActivityUpdates": [
    {
      "AttributeName": "sample string 1",
      "AttributeAction": 0,
      "AttributeType": 0,
      "AttributeTransaction": "sample string 2",
      "AttributeData": {}
    },
    {
      "AttributeName": "sample string 1",
      "AttributeAction": 0,
      "AttributeType": 0,
      "AttributeTransaction": "sample string 2",
      "AttributeData": {}
    }
  ],
  "IsPublicCommentsAllowed": true,
  "CombinedActivityId": "sample string 4",
  "FormName": "sample string 5",
  "TicketId": "sample string 6",
  "Culture": "sample string 7"
}

application/xml, text/xml

Sample: 
<ActivityArgumentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">
  <Culture>sample string 7</Culture>
  <TicketId>sample string 6</TicketId>
  <CombinedActivityId>sample string 4</CombinedActivityId>
  <FormName>sample string 5</FormName>
  <ActivityUpdates>
    <AttributeUpdateModel>
      <AttributeAction>Add</AttributeAction>
      <AttributeData />
      <AttributeName>sample string 1</AttributeName>
      <AttributeTransaction>sample string 2</AttributeTransaction>
      <AttributeType>Field</AttributeType>
    </AttributeUpdateModel>
    <AttributeUpdateModel>
      <AttributeAction>Add</AttributeAction>
      <AttributeData />
      <AttributeName>sample string 1</AttributeName>
      <AttributeTransaction>sample string 2</AttributeTransaction>
      <AttributeType>Field</AttributeType>
    </AttributeUpdateModel>
  </ActivityUpdates>
  <CombinedContractLineId>sample string 1</CombinedContractLineId>
  <IsPublicCommentsAllowed>true</IsPublicCommentsAllowed>
  <TransactionKey>sample string 2</TransactionKey>
</ActivityArgumentModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ActivityArgumentModel'.

Response Information

Resource Description

BaseReturnModel
NameDescriptionTypeAdditional information
CombinedPerformanceId

Gets or sets the performance id. If performance monitoring is not turned on this property will not be present or set to null

 string

Json null value handling: Ignore

Response Formats

application/json, text/json

Sample: 
{
  "CombinedPerformanceId": "sample string 1"
}

application/xml, text/xml

Sample: 
<BaseReturnModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rostov.Models">
  <CombinedPerformanceId>sample string 1</CombinedPerformanceId>
</BaseReturnModel>