POST api/v1/webhooks/notification/archived

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Message	string	None.
OrganizationCode	string	None.
TargetId	globally unique identifier	None.
TargetsId	Collection of globally unique identifier	None.
ExtraData	Dictionary of string [key] and string [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "organizationCode": "sample string 2",
  "targetId": "2ed8b9e5-589f-46ca-8ba6-8eda35c5b4f5",
  "targetsId": [
    "1643a86f-ff1b-4f91-b8d7-ff03c8671101",
    "718e8d7d-c72b-4bc7-a3e4-20e51085227a"
  ],
  "extraData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<WHMessageBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.WebHooks">
  <ExtraData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ExtraData>
  <Message>sample string 1</Message>
  <OrganizationCode>sample string 2</OrganizationCode>
  <TargetId>2ed8b9e5-589f-46ca-8ba6-8eda35c5b4f5</TargetId>
  <TargetsId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>1643a86f-ff1b-4f91-b8d7-ff03c8671101</d2p1:guid>
    <d2p1:guid>718e8d7d-c72b-4bc7-a3e4-20e51085227a</d2p1:guid>
  </TargetsId>
</WHMessageBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.