POST jxc_api/TPEvent/Subscribe?asId={asId}&eventName={eventName}

Request Information

URI Parameters

Name	Description	Type	Additional information
asId		integer	Required
eventName		APPEventNames	Required

Body Parameters

RegisterOption

Name	Type	Additional information
SuccessUrl	URI	None.
FailedUrl	URI	None.
BlockOnFailed	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SuccessUrl": "http://webapihelppage1.com",
  "FailedUrl": "http://webapihelppage2.com",
  "BlockOnFailed": true
}

application/xml, text/xml

Sample:

<RegisterOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LemonScm.WebApi.Areas.ThirdParty.Models">
  <BlockOnFailed>true</BlockOnFailed>
  <FailedUrl>http://webapihelppage2.com/</FailedUrl>
  <SuccessUrl>http://webapihelppage1.com/</SuccessUrl>
</RegisterOption>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SubscribeResult

Name	Type	Additional information
EventId	string	None.
Status	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "EventId": "sample string 1",
  "Status": true,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:

<SubscribeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LemonScm.WebApi.Areas.ThirdParty.Models">
  <EventId>sample string 1</EventId>
  <Message>sample string 3</Message>
  <Status>true</Status>
</SubscribeResult>