POST api/ESSystem/v1/Notification/Notify

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
OptionType	OptionType	None.
DisplayName	string	None.
Keys	Collection of globally unique identifier	None.
MaxCount	integer	None.
RequiredFields	Collection of FieldInfo	None.
ReturnType	ReturnType	None.

Request Formats

application/json, text/json

Sample:

{
  "OptionType": 0,
  "DisplayName": "sample string 1",
  "Keys": [
    "55d227a7-1b37-4308-843b-584f90efef95",
    "d80f2b92-4e99-4fcd-be1c-cf0c2009a511"
  ],
  "MaxCount": 2,
  "RequiredFields": [
    {
      "FieldName": "sample string 1",
      "Label": "sample string 2",
      "DataType": "sample string 3",
      "Required": true
    },
    {
      "FieldName": "sample string 1",
      "Label": "sample string 2",
      "DataType": "sample string 3",
      "Required": true
    }
  ],
  "ReturnType": 0
}

application/xml, text/xml

Sample:

<NotifyOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <DisplayName>sample string 1</DisplayName>
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>55d227a7-1b37-4308-843b-584f90efef95</d2p1:guid>
    <d2p1:guid>d80f2b92-4e99-4fcd-be1c-cf0c2009a511</d2p1:guid>
  </Keys>
  <MaxCount>2</MaxCount>
  <OptionType>SendLastBill</OptionType>
  <RequiredFields>
    <FieldInfo>
      <DataType>sample string 3</DataType>
      <FieldName>sample string 1</FieldName>
      <Label>sample string 2</Label>
      <Required>true</Required>
    </FieldInfo>
    <FieldInfo>
      <DataType>sample string 3</DataType>
      <FieldName>sample string 1</FieldName>
      <Label>sample string 2</Label>
      <Required>true</Required>
    </FieldInfo>
  </RequiredFields>
  <ReturnType>Nothing</ReturnType>
</NotifyOption>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult

Name	Type	Additional information
Error	integer	None.
Message	string	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": 1,
  "Message": "sample string 2",
  "Data": {}
}

application/xml, text/xml

Sample:

<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Core.Common">
  <Data />
  <Error>1</Error>
  <Message>sample string 2</Message>
</ApiResult>