candid.charitycheckpdf
Modules
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_candid_0.1.1.png)
ballerinax/candid.charitycheckpdf Ballerina library
Clients![](/images/permalink.svg)
candid.charitycheckpdf: Client![](/images/permalink.svg)
This end-point will allow you to retrieve organization's Charity Check information in PDF format. API returns the byte stream.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://apidata.guidestar.org/charitycheckpdf" - URL of the target service
get v1/pdf/[string ein]![](/images/permalink.svg)
/charitycheckpdf/v1/pdf
Records![](/images/permalink.svg)
candid.charitycheckpdf: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- subscriptionKey string -
candid.charitycheckpdf: BadRequest![](/images/permalink.svg)
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
candid.charitycheckpdf: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
candid.charitycheckpdf: Forbidden![](/images/permalink.svg)
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: InternalServerError![](/images/permalink.svg)
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: NotAcceptable![](/images/permalink.svg)
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: NotFound![](/images/permalink.svg)
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
candid.charitycheckpdf: TooManyRequests![](/images/permalink.svg)
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: Unauthorized![](/images/permalink.svg)
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
Import
import ballerinax/candid.charitycheckpdf;
Metadata
Released date: 6 months ago
Version: 0.1.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.8.0
GraalVM compatible: Yes
Pull count
Total: 51
Current verison: 0
Weekly downloads
Keywords
Candid
Nonprofit Data
Philanthropy Data
Nonprofit APIs
Contributors