POST SubscribeUnsubscribeEvent

Request Information

URI Parameters

None.

Body Parameters

EventSubscription
NameDescriptionTypeAdditional information
EventId

integer

None.

Action

integer

None.

IsCustom

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "EventId": 1,
  "Action": 2,
  "IsCustom": true
}

text/html

Sample:
{"EventId":1,"Action":2,"IsCustom":true}

application/xml, text/xml

Sample:
<EventSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Events">
  <Action>2</Action>
  <EventId>1</EventId>
  <IsCustom>true</IsCustom>
</EventSubscription>

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

Response Information

Resource Description

ResponseOfEventSubscription
NameDescriptionTypeAdditional information
Message

string

None.

Status

boolean

None.

Body

EventSubscription

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": true,
  "Body": {
    "EventId": 1,
    "Action": 2,
    "IsCustom": true
  }
}

text/html

Sample:
{"Message":"sample string 1","Status":true,"Body":{"EventId":1,"Action":2,"IsCustom":true}}

application/xml, text/xml

Sample:
<ResponseOfEventSubscriptionqCs14Pcc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Common">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/PGH.NxtGN.BO.Events">
    <d2p1:Action>2</d2p1:Action>
    <d2p1:EventId>1</d2p1:EventId>
    <d2p1:IsCustom>true</d2p1:IsCustom>
  </Body>
  <Message>sample string 1</Message>
  <Status>true</Status>
</ResponseOfEventSubscriptionqCs14Pcc>