| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /endpoints/phone-numbers/search |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
/**
* Search for phone numbers
*/
@Api(Description="Search for phone numbers")
public static class SearchPhoneNumbers implements IGet
{
/**
* The account you are searching for
*/
@ApiMember(Description="The account you are searching for")
public String accountId = null;
/**
* The area code
*/
@ApiMember(Description="The area code")
public String areaCode = null;
/**
* The country code you are searching for
*/
@ApiMember(Description="The country code you are searching for")
public String countryCode = null;
/**
* The postal code you are searching for
*/
@ApiMember(Description="The postal code you are searching for")
public String postalCode = null;
/**
* The distance from the specified postal code (default is 100)
*/
@ApiMember(Description="The distance from the specified postal code (default is 100)")
public Integer distance = null;
/**
* Search for fax numbers
*/
@ApiMember(Description="Search for fax numbers")
public Boolean isFaxNumber = null;
/**
* Contains specific digits
*/
@ApiMember(Description="Contains specific digits")
public String contains = null;
public String getAccountId() { return accountId; }
public SearchPhoneNumbers setAccountId(String value) { this.accountId = value; return this; }
public String getAreaCode() { return areaCode; }
public SearchPhoneNumbers setAreaCode(String value) { this.areaCode = value; return this; }
public String getCountryCode() { return countryCode; }
public SearchPhoneNumbers setCountryCode(String value) { this.countryCode = value; return this; }
public String getPostalCode() { return postalCode; }
public SearchPhoneNumbers setPostalCode(String value) { this.postalCode = value; return this; }
public Integer getDistance() { return distance; }
public SearchPhoneNumbers setDistance(Integer value) { this.distance = value; return this; }
public Boolean getIsFaxNumber() { return isFaxNumber; }
public SearchPhoneNumbers setIsFaxNumber(Boolean value) { this.isFaxNumber = value; return this; }
public String getContains() { return contains; }
public SearchPhoneNumbers setContains(String value) { this.contains = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /endpoints/phone-numbers/search HTTP/1.1 Host: evovoice.io Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
[{"phoneNumber":"String"}]