Subscriber Location

/api/subscriber/location

The location interface is intended to be used to view/import/edit/delete a location in issuetracker

Headers: Content-Type: application/json

Query Parameters (HTTP GET)

These params are required retrieve a location

id	External billing system location ID
api_key	Key (password) sent with every request to help identify the system sending the query. This is can be given to serverplus, or generated by serverplus. Combined with HTTPS and Access Control lists, a query page can be secured so unauthorized users cannot retrieve information.

Response JSON

Responses are JSON encoded and are an object with the following properties:

Element Name	Description
status	“ok” or “error”
error_fields	If there was an error while creating the callback
data	data related to the created callback
status_message	status message

Success Response Object:

Element Name	|Description
active	bool
external_id	The same id used to make the GET request
name	The name of the location as stored in Issuetracker
id	The internal location ID as stored in ServerPlus’ database

Example Response JSON

An example response for successful callback

https://tracker.serverplus.com/api/subscriber/location?api_key=someapikey&id=249

JSON Response Body:

{
    "status": "ok",
    "data": {
        "active": true,
        "external_id": "249",
        "name": "Bunker Hill [249]",
        "id": 12454
    },
    "error_fields": {},
    "status_message": null
}

Query Parameters (HTTP POST)

These params are required add a location to Issuetracker

id	External billing system location ID (must be unique)
name	Name of the location, (must be unique)
status	one of “active” or “disabled”
api_key	Key (password) sent with every request to help identify the system sending the query. This is can be given to serverplus, or generated by serverplus. Combined with HTTPS and Access Control lists, a query page can be secured so unauthorized users cannot retrieve information.

Response JSON

Responses are JSON encoded and are an object with the following properties:

Element Name	Description
status	“ok” or “error”
error_fields	If there was an error while creating the callback
data	data related to the created callback
status_message	status message

Success Response Object:

Element Name	|Description
active	bool
external_id	The same id used to make the POST request
name	The name of the location as stored in Issuetracker
id	The internal location ID as stored in ServerPlus’ database

Example Response JSON

An example response for successful callback

https://tracker.serverplus.com/api/subscriber/location?api_key=someapikey&id=249&name=Bunker%20Hill&status=active

JSON Response Body:

{
    "status": "ok",
    "data": {
        "active": true,
        "external_id": "249",
        "name": "Bunker Hill [249]",
        "id": 12454
    },
    "error_fields": {},
    "status_message": null
}

Query Parameters (HTTP PUT)

These params are required change a location in Issuetracker, This should only be used to enable / disable a location If a subscriber is associated with a location, there could be problems loading their profile

id	External billing system location ID (must be unique)
status	one of “active” or “disabled”
api_key	Key (password) sent with every request to help identify the system sending the query. This is can be given to serverplus, or generated by serverplus. Combined with HTTPS and Access Control lists, a query page can be secured so unauthorized users cannot retrieve information.

Response JSON

Responses are JSON encoded and are an object with the following properties:

Element Name	Description
status	“ok” or “error”
error_fields	If there was an error while creating the callback
data	data related to the created callback
status_message	status message

Success Response Object:

Example Response JSON

An example response for successful callback

PUT https://tracker.serverplus.com/api/subscriber/location?api_key=someapikey&id=249&status=disabled

JSON Response Body:

{
    "status": "ok",
    "data": {
        "active": false,
        "external_id": "249",
        "name": "Bunker Hill [249]",
        "id": 12454
    },
    "error_fields": {},
    "status_message": null
}

Query Parameters (HTTP DELETE)

These params are required to delete a location from Issuetracker (use with caution) If a subscriber is associated with a location, there could be problems deleting the location. It’s typically best to just deactivate the location instead of deleting it. Unless you are absolutely sure you want to delete the location and it will never be used later on.

id	External billing system location ID (must be unique)
api_key	Key (password) sent with every request to help identify the system sending the query. This is can be given to serverplus, or generated by serverplus. Combined with HTTPS and Access Control lists, a query page can be secured so unauthorized users cannot retrieve information.

Response JSON

Responses are JSON encoded and are an object with the following properties:

Element Name	Description
status	“ok” or “error”
error_fields	If there was an error while creating the callback
data	data related to the created callback
status_message	status message

Success Response Object:

Element Name	|Description
active	bool
external_id	The same id used to make the DELETE request
name	The name of the location as stored in Issuetracker
id	The internal location ID as stored in ServerPlus’ database

Example Response JSON

An example response for successful callback

DELETE https://tracker.serverplus.com/api/subscriber/location?api_key=someapikey&id=249

JSON Response Body:

{
    "status": "ok",
    "data": {
        "active": false,
        "external_id": "249",
        "name": "Bunker Hill [249]",
        "id": 12454
    },
    "error_fields": {},
    "status_message": "Location deleted"
}