POST v1/batches/{batchid}/actions/notifications

Create an action to be triggered on Batch completion. The only supported action currently is to trigger a notification message.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
batchid

The unique Id of the batch that was returned during creation.

string

Required

Body Parameters

The updated Batch, if found, otherwise a failure result with a 404 error code.

Notification
NameDescriptionTypeAdditional information
Level

NotificationLevel

None.

Type

NotificationType

None.

AppTag

string

None.

Subject

string

None.

Message

string

None.

Address

string

None.

Parameters

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "Level": 0,
  "Type": 0,
  "AppTag": "sample string 1",
  "Subject": "sample string 2",
  "Message": "sample string 3",
  "Address": "sample string 4",
  "Parameters": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<Notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Address>sample string 4</Address>
  <AppTag>sample string 1</AppTag>
  <Level>normal</Level>
  <Message>sample string 3</Message>
  <Parameters 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>
  </Parameters>
  <Subject>sample string 2</Subject>
  <Type>technical</Type>
</Notification>

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 'Notification'.

Response Information

Resource Description

PBPRReturnOfBatchAction
NameDescriptionTypeAdditional information
Data

BatchAction

None.

Success

Gets the success status of the API call

boolean

None.

Meta

Gets the optional meta-data

Dictionary of string [key] and string [value]

None.

Code

Get the http code of the API call e.g. 200, 202, 409

integer

None.

ErrorCode

Get the failure error code of the API call. This is available if Success is false

integer

None.

ErrorSubCode

Gets the error sub code if available

integer

None.

ErrorDescription

Gets a textual description of the error

string

None.

StatusUrl

Gets the status url for any ACCEPTed API commands. Any command (POST,DELETE,PATCh,PUT) to the API usually returns a 202 response code. The status of the command can be queried using the URL provided

string

None.

ContinuationToken

Gets the token to be used for paged queries

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Meta": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Code": 2,
  "ErrorCode": 3,
  "Data": {
    "ID": "sample string 1",
    "ActionType": 2,
    "ActionPayload": "sample string 3"
  },
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "BxFAXRUEKVV%2BTRMbGlBGdA%3D%3D"
}

application/xml, text/xml

Sample:
<PBPRReturnOfBatchAction7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>BxFAXRUEKVV%2BTRMbGlBGdA%3D%3D</ContinuationToken>
  <ErrorCode>3</ErrorCode>
  <ErrorDescription>sample string 5</ErrorDescription>
  <ErrorSubCode>4</ErrorSubCode>
  <Meta 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>
  </Meta>
  <StatusUrl>sample string 6</StatusUrl>
  <Success>true</Success>
  <Data>
    <ActionPayload>sample string 3</ActionPayload>
    <ActionType>2</ActionType>
    <ID>sample string 1</ID>
  </Data>
</PBPRReturnOfBatchAction7NMnQmOk>