SA Phone Carriers

Get Phone Carrier

GET /api/.../phonecarriers/{id}

Return a single phone carrier by carrier id.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the phone carrier. Used to return a single object.

Response Information

Example
application/json, text/json 
{
    "CarrierID":1,
    "CarrierName":"AT&T",
    "Email2SMSEmailAddress":"@txt.att.net",
    "NumberOfDigits":10,
    "Display":true
}

HTTP Response Codes

Code Description
200 OK. Success

List SA Phone Carriers

GET /api/.../phonecarriers

Return a list of all phone carriers in the system.

GET /api/.../phonecarriers?includeEmptyObject=true

Return a list of all phone carriers in the system. Include the '(none)' entry for a user listbox or combobox.

Request Information

Parameters
Name Type Required Description
includeEmptyObject Boolean No Set to 'true' to return an empty object with CarrierID set to '0' and CarrierName set to '(none)'. This may be used when populating a listbox for a user selection.

Response Information

Example
application/json, text/json 
[
  {
    "CarrierID": 1,
    "CarrierName": "sample string 2",
    "Email2SMSEmailAddress": "sample string 3",
    "NumberOfDigits": 4,
    "Display": true
  },
  {
    "CarrierID": 1,
    "CarrierName": "sample string 2",
    "Email2SMSEmailAddress": "sample string 3",
    "NumberOfDigits": 4,
    "Display": true
  },
  {
    "CarrierID": 1,
    "CarrierName": "sample string 2",
    "Email2SMSEmailAddress": "sample string 3",
    "NumberOfDigits": 4,
    "Display": true
  }
]

HTTP Response Codes

Code Description
200 OK. Success