Numeric Pager Device Parameters

Note: As of 4.1 patch 006 and 4.0 patch 014, updating or adding a numeric pager via web services will no longer accept both a pin and a phone number; you can submit either a pin or an area code and phone number, but not both.

The following table lists the web service parameters for numeric pager Devices

Name

Description

Optional

Valid Values

active

Indicates whether the Device should be active

no

true or false

default

Indicates whether the Device should be set as the default Device for the User

no

true or false

delay

Delay to use for this Device (in minutes)

no

Integer

externallyOwned

Indicates whether an external data source owns this Device

no

true or false

name

Device name

no

Any valid unused Device name

priorityThreshold

Priority threshold to set for this Device

no

A valid priority threshold setting; the default available values are LOW, MEDIUM, and HIGH.

userServiceProvider

ID of the User Service Provider to associate with this Device

no

SoapUserServiceProvider

areaCode The area code for the pager's phone number    

countryCodeOverride

Two-letter country code for the numeric pager number

no

Long

number

The pager's phone number

no

String; maximum length of 30 characters matching the following:

[0-9]{1}[0-9()., -]+

pin

The pager's PIN

no

String; maximum length of 100 characters matching the following:

[0-9]+

Example

<sch:numericPagerDevice>
  <sch:active>true</sch:active>
  <sch:default>true</sch:default>
  <sch:delay>0</sch:delay>
  <sch:externallyOwned>true</sch:externallyOwned>
  <sch:name>Numeric Pager</sch:name>
  <sch:priorityThreshold>HIGH</sch:priorityThreshold>
  <sch:userServiceProvider>
    <sch:identifier></sch:identifier>
    <sch:name>Pager Provider</sch:name>
  </sch:userServiceProvider>
  <sch:areaCode>304</sch:areaCode>
  <sch:countryCodeOverride>US</sch:countryCodeOverride>
  <sch:number>3940298</sch:number>
</sch:numericPagerDevice>
 

Example Two

<sch:numericPagerDevice>
  <sch:active>true</sch:active>
  <sch:default>true</sch:default>
  <sch:delay>0</sch:delay>
  <sch:externallyOwned>true</sch:externallyOwned>
  <sch:name>Numeric Pager</sch:name>
  <sch:priorityThreshold>HIGH</sch:priorityThreshold>
  <sch:userServiceProvider>
    <sch:identifier></sch:identifier>
    <sch:name>Pager Provider</sch:name>
  </sch:userServiceProvider>
  <sch:pin>1234567890</sch:pin>
</sch:numericPagerDevice>

Web Service Device Specification

AddDevice

UpdateDevice