GET api/ProviderSearch/SearchCityZipState

Request Information

URI Parameters

NameDescriptionTypeAdditional information
StateInitials

string

None.

GetCountOnly

boolean

None.

PageNumber

integer

None.

PageSize

integer

None.

Body Parameters

None.

Response Information

Resource Description

ProviderSearchCityZipStateResult
NameDescriptionTypeAdditional information
CityZipStateResults

Collection of ProviderSearchCityZipStateObject

None.

Query

ProviderSearchCityZipStateQuery

None.

ErrorMessage

string

None.

NextPage

string

None.

PreviousPage

string

None.

ResultCount

integer

None.

Success

boolean

None.

TotalResultCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "CityZipStateResults": [
    {
      "City": "sample string 1",
      "State": "sample string 2",
      "Zip": 3
    },
    {
      "City": "sample string 1",
      "State": "sample string 2",
      "Zip": 3
    }
  ],
  "Query": {
    "StateInitials": "sample string 1",
    "GetCountOnly": true,
    "PageNumber": 3,
    "PageSize": 4
  },
  "ErrorMessage": "sample string 1",
  "NextPage": "sample string 2",
  "PreviousPage": "sample string 3",
  "ResultCount": 4,
  "Success": true,
  "TotalResultCount": 6
}

text/html

Sample:
{"CityZipStateResults":[{"City":"sample string 1","State":"sample string 2","Zip":3},{"City":"sample string 1","State":"sample string 2","Zip":3}],"Query":{"StateInitials":"sample string 1","GetCountOnly":true,"PageNumber":3,"PageSize":4},"ErrorMessage":"sample string 1","NextPage":"sample string 2","PreviousPage":"sample string 3","ResultCount":4,"Success":true,"TotalResultCount":6}

application/xml, text/xml

Sample:
<ProviderSearchCityZipStateResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TheHealthPlan.Library.ProviderSearch">
  <ErrorMessage>sample string 1</ErrorMessage>
  <NextPage>sample string 2</NextPage>
  <PreviousPage>sample string 3</PreviousPage>
  <ResultCount>4</ResultCount>
  <Success>true</Success>
  <TotalResultCount>6</TotalResultCount>
  <CityZipStateResults>
    <ProviderSearchCityZipStateObject>
      <City>sample string 1</City>
      <State>sample string 2</State>
      <Zip>3</Zip>
    </ProviderSearchCityZipStateObject>
    <ProviderSearchCityZipStateObject>
      <City>sample string 1</City>
      <State>sample string 2</State>
      <Zip>3</Zip>
    </ProviderSearchCityZipStateObject>
  </CityZipStateResults>
  <Query>
    <GetCountOnly>true</GetCountOnly>
    <PageNumber>3</PageNumber>
    <PageSize>4</PageSize>
    <StateInitials>sample string 1</StateInitials>
  </Query>
</ProviderSearchCityZipStateResult>