GET api/v1/allNotificationConditionalStates/locations/{locationId}?additionalInput={additionalInput}

Get the list of notification states permitted for this location. Equivalent SOAP API: GetAllNotificationConditionalStates

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationId

Location ID

integer

Required

additionalInput

additionalInput

string

None.

Body Parameters

None.

Response Information

Resource Description

NotificationConditionalStateResult

NotificationConditionalStateResult
NameDescriptionTypeAdditional information
NotificationConditionalStates

Collection of NotificationConditionalState

None.

ResultCode

integer

None.

ResultData

string

None.

Response Formats

application/json, text/json

Sample:
{
  "NotificationConditionalStates": [
    {
      "ConditionalStateID": 1,
      "ConditionalStateName": "sample string 2"
    },
    {
      "ConditionalStateID": 1,
      "ConditionalStateName": "sample string 2"
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:
<NotificationConditionalStateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <NotificationConditionalStates xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
    <d2p1:NotificationConditionalState>
      <d2p1:ConditionalStateID>1</d2p1:ConditionalStateID>
      <d2p1:ConditionalStateName>sample string 2</d2p1:ConditionalStateName>
    </d2p1:NotificationConditionalState>
    <d2p1:NotificationConditionalState>
      <d2p1:ConditionalStateID>1</d2p1:ConditionalStateID>
      <d2p1:ConditionalStateName>sample string 2</d2p1:ConditionalStateName>
    </d2p1:NotificationConditionalState>
  </NotificationConditionalStates>
</NotificationConditionalStateResult>