The following series of services are part of the Geofence API. Click here for a high-level overview of Geofence.

Fence Operations

This segment of services is used to create, review and modify your geofences.

List

list.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/list.{format}?{params}

This service is used to return all geofences associated with a user.

Authentication

This method requires a generated MD5 signature.

Arguments

• key Your API Key, click here here to view.
• timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

[HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

• sig: The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

• fenceId ID of the fence associated with the user.
• status Whether or not the fence is currently active (monitoring) or inactive (not monitoring).
• startEndTime The times between which the fence monitors (if active), i.e. 915-1430, times are military.
• days Days the fence monitors (if active), note: H=Thurs, A=Sat.
• lastMonitor Date\Time of the last check on this fence.
• latitude Center latitude on which the fence is based.
• longitude Center longitude on which the fence is based.
• dimensions Dimensions of the fence (currently “radius” is v1 of geofence).

Example Request

Get

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/list?key=123abckey&timestamp=2010-03-05T10:12:00CST&sig=123abcdef456

Example Response

110(Inactive, 900-1700, MTWHF, NEVER, 38.9178, -94.6598, 50), 427(Active, 930-1115, SA, NEVER, 38.9178, -94.6598, 500)

Add

add.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/add.{format}?{params}

This service is used to add a fence.

Authentication

This method requires a generated MD5 signature.

Arguments

• key: Your API Key, click here to view.
• name: The name of the fence.
• strtTime: Earliest time to start monitoring the fence, format [HH][MM]

note: [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

• endTime: Latest time to monitor the fence, format [HH][MM]

note: [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

• lat: Center latitude on which to base the fence.
• long: Center longitude on which to base the fence.
• dim: Dimensions of the fence (for v1 of geofence, this is the radius).
• interval: The interval at which the fence should be checked;

  note: only increments of 5 min are allowed; i.e. 5, 15, 25, etc.

• days Days on which the fence should be monitored, as a String with a single representing each day

note: H=Thurs, A=Sat; i.e. SMTWHFA.

• notifyEvent: Whether the fence should notify on “in”, “out” or “both” (excluding this param will default to “both”).
• timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

note: [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

• sig: The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

 

Response:

• message Success message if recipient was added or an error message.

Example Request: Get http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/add?key=123abckey& name=My%20Fence&strtTime=900&endTime=1700&lat=38.917806&long=-94.659787&dim=50&interval=15&days=MTWHF&timestamp=2010-03-05T10:12:00CST&sig=123abcdef456

Example Response

FENCE_ADDED

Activate

activate.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/activate.{format}?{params}

This service is used to activate an existing fence.

Authentication

This method requires a generated MD5 signature.

Arguments

• key: Your API Key, click here to view.
• fenceId: The ID of the fence to activate.
• timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

[HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

• sig: The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

message: Success message if fence was activated or an error message.

Example Request

Get

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/activate?key=123abckey&fenceId=110&timestamp=2010-03-05T10:12:00CST&sig=123abcdef456

Example Response

FENCE_ACTIVATED

Deactivate

deactivate.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/deactivate.{format}?{params}
This service is used to deactivate an existing fence.

Authentication

This method requires a generated MD5 signature.

Arguments

• key: Your API Key, click here to view.
• fenceId: The ID of the fence to activate.
• timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

[HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

• sig: The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

message Success message if fence was deactivated or an error message.

Example Request

Get:

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/deactivate?key=123abckey&fenceId=110&timestamp=2010-03-05T10:12:00CST&sig=123abcdef456

Example Response

FENCE_DEACTIVATED

Device Operations

The services following are used to maintain devices being tracked in relation to a specific geofence.

List

listDevices.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/listDevices.{format}?{params}
This service is used to return all devices associated with a geofence.

Authentication

This method requires a generated MD5 signature.

Arguments

• key: Your API Key, click here to view.
• fenceId: The ID of the fence whose recipients you want listed.
• timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

[HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

• sig: The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

• deviceId ID of the device associated with the fence.
• mdn MDN of the fence device.

Example Request

Get

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/listDevices?key=123abckey&fenceId=110&timestamp=2010-03-05T10:12:00CST&sig=123abcdef456

Example Response

1(8165551111), 14(9135552121)

Add

addDevice.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/addDevice.{format}?{params} This service is used to add a device to a fence.

Authentication

This method requires a generated MD5 signature.

Arguments

• key: Your API Key, click here to view.
• fenceId: The ID of the fence to add the device to.
• Mdn: MDN of the device.
• timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

[HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

• sig: The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

message Success message if device was added or an error message.

Example Request

Get

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/addDevice?key=123abckey&fenceId=110&mdn=9135552121&timestamp=2010-03-05T10:12:00CST&sig=123abcdef456

Example Response

DEVICE_ADDED

Delete