NppesRequest

io.zhkv.api.nppesnpi.NppesRequest

```
public class NppesRequest
```
The data class is used to hold the request parameters and build the URL to perform the request to NPPES NPI Registry.

Constructor Summary

Constructors
Constructor and Description
`NppesRequest(java.lang.String number, EnumerationType enumerationType, java.lang.String taxonomyDescription, java.lang.String organizationName, AddressPurpose addressPurpose, java.lang.String city, java.lang.String state, java.lang.String postalCode, java.lang.String countryCode, int limit, int skip)` Creates an immutable NPPES request based on provided parameters and default values.
`NppesRequest()` Creates an immutable NPPES request based on provided parameters and default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`component1()` The unique,
`int`	`component10()` Limit the results returned.
`int`	`component11()` The first N
`EnumerationType`	`component2()` The Read API can be refined to retrieve only Individual Providers or Organizational Providers.
`java.lang.String`	`component3()` Search for providers by their taxonomy by entering the taxonomy description.
`java.lang.String`	`component4()` This field only applies to Organizational Providers.
`AddressPurpose`	`component5()` Refers to whether the address information entered pertains to the provider
`java.lang.String`	`component6()` The City associated with the provider
`java.lang.String`	`component7()` The State abbreviation associated with the provider
`java.lang.String`	`component8()` The Postal Code associated with the provider
`java.lang.String`	`component9()` The Country associated with the provider
`NppesRequest`	`copy(java.lang.String number, EnumerationType enumerationType, java.lang.String taxonomyDescription, java.lang.String organizationName, AddressPurpose addressPurpose, java.lang.String city, java.lang.String state, java.lang.String postalCode, java.lang.String countryCode, int limit, int skip)` The data class is used to hold the request parameters and build the URL to perform the request to NPPES NPI Registry.
`boolean`	`equals(java.lang.Object p)`
`AddressPurpose`	`getAddressPurpose()` Refers to whether the address information entered pertains to the provider
`java.lang.String`	`getCity()` The City associated with the provider
`java.lang.String`	`getCountryCode()` The Country associated with the provider
`EnumerationType`	`getEnumerationType()` The Read API can be refined to retrieve only Individual Providers or Organizational Providers.
`int`	`getLimit()` Limit the results returned.
`java.lang.String`	`getNumber()` The unique,
`java.lang.String`	`getOrganizationName()` This field only applies to Organizational Providers.
`java.lang.String`	`getPostalCode()` The Postal Code associated with the provider
`int`	`getSkip()` The first N
`java.lang.String`	`getState()` The State abbreviation associated with the provider
`java.lang.String`	`getTaxonomyDescription()` Search for providers by their taxonomy by entering the taxonomy description.
`int`	`hashCode()`
`java.lang.String`	`toString()`
`java.lang.String`	`url()` Builds the request URL based on provided data.

- Constructor Detail
  - NppesRequest
```
public NppesRequest(java.lang.String number,
                    EnumerationType enumerationType,
                    java.lang.String taxonomyDescription,
                    java.lang.String organizationName,
                    AddressPurpose addressPurpose,
                    java.lang.String city,
                    java.lang.String state,
                    java.lang.String postalCode,
                    java.lang.String countryCode,
                    int limit,
                    int skip)
```
    Creates an immutable NPPES request based on provided parameters and default values.
    
    Parameters:
    
    number - The unique, 10-digit National Provider Identifier (NPI) assigned to the provider.
    
    enumerationType - The Read API can be refined to retrieve only Individual Providers or Organizational Providers. When usingthe Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be enteredas well.
    
    taxonomyDescription - Search for providers by their taxonomy by entering the taxonomy description.
    
    organizationName - This field only applies to Organizational Providers. Trailing wildcard entries are permitted requiring atleast two characters to be entered.
    
    addressPurpose - Refers to whether the address information entered pertains to the provider's Mailing Address or theprovider's Practice Location Address. When not specified, the results will contain the providers whereeither the Mailing Address or the Practice Location Addresses match the entered address information
    
    city - The City associated with the provider's address identified in Address Purpose.
    
    state - The State abbreviation associated with the provider's address identified in Address Purpose.
    
    postalCode - The Postal Code associated with the provider's address identified in Address Purpose. There is an impliedtrailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codesin the data.
    
    countryCode - The Country associated with the provider's address identified in Address Purpose. This field can be used asthe only input criterion as long as the value selected is not US (United States).
    
    limit - Limit the results returned. The default value is 10. The value can be set to any value from 1 to 200.
    
    skip - The first N (value entered) results meeting the entered criteria will be bypassed and will not be includedin the output.
  - NppesRequest
```
public NppesRequest()
```
    Creates an immutable NPPES request based on provided parameters and default values.
- Method Detail
  - url
```
public java.lang.String url()
```
    Builds the request URL based on provided data.
    
    Returns:
    
    url as a String
  - getNumber
```
public java.lang.String getNumber()
```
    The unique,
    10-digit National Provider Identifier (NPI) assigned to the provider.
  - getEnumerationType
```
public EnumerationType getEnumerationType()
```
    The Read API can be refined to retrieve only Individual Providers or Organizational Providers.
    When usingthe Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be enteredas well.
  - getTaxonomyDescription
```
public java.lang.String getTaxonomyDescription()
```
    Search for providers by their taxonomy by entering the taxonomy description.
  - getOrganizationName
```
public java.lang.String getOrganizationName()
```
    This field only applies to Organizational Providers.
    Trailing wildcard entries are permitted requiring atleast two characters to be entered.
  - getAddressPurpose
```
public AddressPurpose getAddressPurpose()
```
    Refers to whether the address information entered pertains to the provider
    's Mailing Address or theprovider's Practice Location Address. When not specified, the results will contain the providers whereeither the Mailing Address or the Practice Location Addresses match the entered address information
  - getCity
```
public java.lang.String getCity()
```
    The City associated with the provider
    's address identified in Address Purpose.
  - getState
```
public java.lang.String getState()
```
    The State abbreviation associated with the provider
    's address identified in Address Purpose.
  - getPostalCode
```
public java.lang.String getPostalCode()
```
    The Postal Code associated with the provider
    's address identified in Address Purpose. There is an impliedtrailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codesin the data.
  - getCountryCode
```
public java.lang.String getCountryCode()
```
    The Country associated with the provider
    's address identified in Address Purpose. This field can be used asthe only input criterion as long as the value selected is not US (United States).
  - getLimit
```
public int getLimit()
```
    Limit the results returned.
    The default value is 10. The value can be set to any value from 1 to 200.
  - getSkip
```
public int getSkip()
```
    The first N
    (value entered) results meeting the entered criteria will be bypassed and will not be includedin the output.
  - component1
```
public java.lang.String component1()
```
    The unique,
    10-digit National Provider Identifier (NPI) assigned to the provider.
  - component2
```
public EnumerationType component2()
```
    The Read API can be refined to retrieve only Individual Providers or Organizational Providers.
    When usingthe Enumeration Type, it cannot be the only criteria entered. Additional criteria must also be enteredas well.
  - component3
```
public java.lang.String component3()
```
    Search for providers by their taxonomy by entering the taxonomy description.
  - component4
```
public java.lang.String component4()
```
    This field only applies to Organizational Providers.
    Trailing wildcard entries are permitted requiring atleast two characters to be entered.
  - component5
```
public AddressPurpose component5()
```
    Refers to whether the address information entered pertains to the provider
    's Mailing Address or theprovider's Practice Location Address. When not specified, the results will contain the providers whereeither the Mailing Address or the Practice Location Addresses match the entered address information
  - component6
```
public java.lang.String component6()
```
    The City associated with the provider
    's address identified in Address Purpose.
  - component7
```
public java.lang.String component7()
```
    The State abbreviation associated with the provider
    's address identified in Address Purpose.
  - component8
```
public java.lang.String component8()
```
    The Postal Code associated with the provider
    's address identified in Address Purpose. There is an impliedtrailing wildcard. If you enter a 5 digit postal code, it will match any appropriate 9 digit (zip+4) codesin the data.
  - component9
```
public java.lang.String component9()
```
    The Country associated with the provider
    's address identified in Address Purpose. This field can be used asthe only input criterion as long as the value selected is not US (United States).
  - component10
```
public int component10()
```
    Limit the results returned.
    The default value is 10. The value can be set to any value from 1 to 200.
  - component11
```
public int component11()
```
    The first N
    (value entered) results meeting the entered criteria will be bypassed and will not be includedin the output.
  - copy
```
public NppesRequest copy(java.lang.String number,
                         EnumerationType enumerationType,
                         java.lang.String taxonomyDescription,
                         java.lang.String organizationName,
                         AddressPurpose addressPurpose,
                         java.lang.String city,
                         java.lang.String state,
                         java.lang.String postalCode,
                         java.lang.String countryCode,
                         int limit,
                         int skip)
```
    The data class is used to hold the request parameters and build the URL to perform the request to NPPES NPI Registry.
  - toString
```
public java.lang.String toString()
```
  - hashCode
```
public int hashCode()
```
  - equals
```
public boolean equals(java.lang.Object p)
```

Class NppesRequest

Constructor Summary

Method Summary

Constructor Detail

NppesRequest

NppesRequest

Method Detail

url

getNumber

getEnumerationType

getTaxonomyDescription

getOrganizationName

getAddressPurpose

getCity

getState

getPostalCode

getCountryCode

getLimit

getSkip

component1

component2

component3

component4

component5

component6

component7

component8

component9

component10

component11

copy

toString

hashCode

equals