Coverage Transmissions
Detailed mapping of the fields used in a GET request to fetch the coverage transmissions associated with a given file delivery or coverage period.
Set-up
This information is required when implementing to Coverage Transmissions via the Ideon API.
id
resources for each request (coverage periodsid
s)API access
Endpoints
Here are the available coverage_transmissions
endpoints:
GET:
/coverage_periods/{id}/coverage_transmissions
/members/{id}/coverage_transmissions
/file_deliveries/{id}/coverage_transmissions
With these, you can:
View coverage transmissions at the member, coverage period or file delivery level
Audit file deliveries and coverage periods for anticipated coverage transmissions
Display these coverage transmissions for users to view and use for confirmation
Request Mapping
This information is required when using a GET request to fetch Coverage Transmissions via the Ideon API.
/coverage_periods/{id}/coverage_transmissions
/members/{id}/coverage_transmissions
/file_deliveries/{id}/coverage_transmissions
id
In the request url, provide the unique id for the resource. Based on the endpoint used, this is either a coverage_period
id, a subscriber
or dependent
id, or a file_delivery
id
Ex.
for coverage_periods/{id}/coverage_transmissions
this is the coverage period id
for which Organization Name, Carrier and Time Period you would like to view coverage transmissions.
Response Mapping
Coverage Period, Member & File Delivery
This is the information returned on a coverage_transmissions
response.
There is a top level array called coverage_transmissions
. For each entry in this object, we return the following fields:
file_delivery_id
This is the unique id for the given file delivery. This file delivery associated with all of the elections and member ids listed
member_id
This is the unique id for the given member. This member's elections will be listed in the associated elections
object
type
This is the type of member transmitted.
subscriber
dependent
elections
Design Questions
The way you use coverage transmissions information depends on the needs of your users. Consider using the questions below to evaluate your implementation and how the design fits your user:
What questions are your users trying to answer when viewing fa single, or many coverage transmissions?
What training do they possess to intepret, or troubleshoot coverages transmitted?
What level of detail should you show the user?
Where in the current system are the users seeking information?
Is there an equivalent process that would be replaced by this new tool?
What level of security will be required to view the data?
At what level will the user be viewing this information - member, group, across many groups?
What data relationships are important to consider in your system?
Can this data be updated or created?
Is this data view-only?
Could a person attempt to send information to Ideon?
Consider the following relationships implicit in Ideon's API:
A coverage period has many file deliveries
A file delivery has many coverage transmissions
A coverage transmission belongs to a single file delivery
A file delivery belongs to many coverage periods
Many employers can be delivered at once to a carrier in a multi-group file
API and EDI coverages have coverage transmissions recorded
See Additional Documentation for links to our current API documentation.
Last updated
Was this helpful?