Superior Mobile Insurance Solutions API Help

Events

Controller for Health Solutions Events

API	Description
GET Events/{id}	Gets an Event by ID
GET Events/{pk}/Shipments	Gets shipments for a particular Event by pk.
POST Events/ShipmentReport	Gets a report of shipments.

ePaper

ePaper is SMM's document management system. Paperwork and other documentation can be gathered here.

API	Description
GET epaper/{id}/original	Requests that the original document be sent in PDF format over the stream.
GET epaper/{id}/thumbnail	Requests that a thumbnail image of the pdf document over the stream.
GET epaper/{id}/thumbnail2x	Requests that a thumbnail image of the pdf document over the stream at 2x size for retina displays.

Carrier

The Carrier API is allows the creation and retrieving of Carrier records. Currently it is only open to partners with a valid api authentication requesting agency records tied to examiner credentials.

API	Description
GET Carrier/CustomList	This method will return a list of carrier objects all tied to the credentials supplied.
GET Carrier/{carrierid}/Product/{agencyid}	Returns a list of products for a carrier
GET Carrier/{carrierid}/Product	Returns a list of products for a carrier
GET Carrier	This method will return a list of all carrier objects.

Orders

Class containing orders for customers.

API	Description
POST Orders/Validate	Validates an orderrequest and returns any issues the request might have along with a requirement matrix output.
GET Orders/PlaceOrderAccess	This method will return a list of agency objects all tied to the examiner credentials supplied.
GET Orders/PlaceOrderLink/{PartyTypeID}/{PartyID}	This method will return a list of agency objects all tied to the examiner credentials supplied.
GET Orders	Default search for orders.
GET Orders/{id}	Gets an order by the ID.
POST Orders	Creates a new order in the SMM system based on the request sent in.

Scheduling

eXpress Scheduling API for pre-scheduling exams based on SMM availability. While pulling scheduling data from this API is open, to actually claim a block of time, an EntityID must be assigned from SMM. Please contact the marketing team "Marketing@superiormobilemedics.com" to get setup.

API	Description
POST Scheduling/Hold	Once a date has been picked from the schedule request, a hold can be made on an appointment. Use this method to claim that block. The PrimaryDate node will be checked against aviailable time. The secondary and tertiary dates can be set to anything and should be used if no coverage was available via the ScheduleRequest method call.
POST Scheduling/InCenterLocations	Send in the applicants location to get the nearest facilities that the applicant can go to for their exam.
POST Scheduling/InCenterTimes	Send Location IDs for the facilities that the applicant would like to be seen to get their availability.
POST Scheduling	SMIS availability is available using this method. Send in a start and end date to determine the window in which dates should be made available and a list of available dates within that range will be sent in JSON/XML format.

Quote

Allows for quoting on different SMM business.

API	Description
POST Quote/GoTicket	Quotes out SMM GOTicket approved carriers.

Requirements

The Requirement API allows the retrieving of requirement codes and descriptions. Currently it is only open to partners with a valid api authentication for direct billing.

API	Description
POST Requirements/Calculate	Requirements calculator for determing exam requirements

Utilities

API	Description
GET Utilities/Geo/Zip/{zipCode}	Returns city and state detail for a zip code entry.
GET Utilities/Phone/{phoneNumber}	Scrubs a phone number to return a normalized phone number string with extension.

Docusign

Docusign API for receiving envelope status

API	Description
POST Docusign/Envelope/Status	This method will accept posts coming from DocuSign

SessionInformation

Provides limited information for sessions.

API	Description
GET SessionInformation/{SessionCode}/Report	Gets a pre-filled session report that can be filled in for use to complete a session.
POST SessionInformation/Report	Send a session report that can be filled in for use to complete a session.
GET SessionInformation?SessionCode={SessionCode}	Gets information for the session, based on the SessionCode provided

SMISViewPaperwork

API	Description
GET SMISViewPaperwork/{id}	GET api/smisviewpaperwork/5 Returns a list of byte arrays for image consumption.

MarkViewed

Marks orders and events as viewed from the client device.

API	Description
GET MarkViewed/Order?id={id}	Marks an SMIS Order as viewed.
GET MarkViewed/Event?id={id}	Marks an SMHS Event as viewed.
GET MarkViewed/EventAndSessions?id={id}	Marks an SMHS Event as viewed.

Messages

Provides hooks into the messaging system, including a digest and marking items as read (to exclude them from further digest pulls)

API	Description
POST Messages/Action	Handles the response to an action card.
POST Messages/Send	Sends a message to a user.
GET Messages/Digest	Pulls the digest for the given user
POST Messages/MarkRead	Marks the messages as read based on the integers posted.

ParticipantEligibility

API	Description
POST ParticipantEligibility	Retrieves eligibility information based on the participant information provided.

Acord

Acord controller for submitting and validating TXLife requests. Requires authorization.

API	Description
POST Acord	Method for submitting Acord TXLife requests
POST Acord?isStatusRequest={isStatusRequest}	No documentation available.

Location

A class for controlling login events

API	Description
POST Location	Posts a location for an examiner

SMISOrders

Pulls orders for SMIS customers

API	Description
GET SMISOrders/{id}	GET api/smisorders/1610001
POST SMISOrders	POST api/smisorders/{JSON}

EventStatusOptions

API	Description
GET EventStatusOptions	A list of statusoptions for an event

Upcoming

API	Description
GET Upcoming	A list of scheduled orders, ordered by scheduled date descending

SubmitScriptAnswers

API	Description
POST SubmitScriptAnswers	Receives answers for scripts.

Unviewed

API	Description
GET Unviewed	A list of unviewed orders

Delinquent

Controller for work items that are delinquent in status.

API	Description
GET Delinquent	A list of delinquent status orders

UserInfo

API	Description
GET UserInfo?pk={pk}	No documentation available.
POST UserInfo	No documentation available.

StatusOptions

API	Description
GET StatusOptions/{id}	A list of statusoptions for an order, based on the context of the order, to determine if the barcode is necessary

Flagged

API	Description
GET Flagged	No documentation available.

SubmitEventStatus

API	Description
POST SubmitEventStatus	Submission of status via json object contained in the httpbody

Cancelled

API	Description
GET Cancelled	No documentation available.

Agency

The Agency API is allows the creation and retrieving of agency records. Currently it is only open to partners with a valid api authentication requesting agency records tied to examiner credentials.

API	Description
POST Agency	New Agency records are required by external systems to for self-maintenance. This method is available only to systems requiring examiner-agency ownership. When an agency record is successfully created it will be tied to the examiner credentials used in the post.
GET Agency/{id}	This method will return a single agency object. It queries by the examiner credentials used and the agency id passed in.
GET Agency	This method will return a list of agency objects all tied to the examiner credentials supplied.

Completed

API	Description
GET Completed	No documentation available.

PendingCompletion

API	Description
GET PendingCompletion	A list of orders that are past the schedule date, and not yet completed

Agent

The Agent API is allows the creation and retrieving of agent records. Currently it is only open to partners with a valid api authentication requesting agency records tied to examiner credentials.

API	Description
POST Agent	New Agent records are required by external systems to for self-maintenance. This method is available only to systems requiring examiner-agent ownership. When an agent record is successfully created it will be tied to the examiner credentials used in the post.
GET Agent/{id}	This method will return a single agent object. It queries by the examiner credentials used and the agent id passed in.
GET Agent	This method will return a list of agent objects all tied to the examiner credentials supplied.

ScriptPack

API	Description
GET ScriptPack	Returns all valid scripts to be loaded onto an mobile device for event screening.

NeedsScheduling

Controller for work items that need to be scheduled.

API	Description
GET NeedsScheduling	A list of orders that are not scheduled

ExaminerCheckIn

API	Description
POST ExaminerCheckIn	Takes the examiner check in

Health

Controller for determining site health.

API	Description
GET Health	If this returns a value, the site is up.

SubmitStatus

API	Description
POST SubmitStatus	Submission of status via json object contained in the httpbody

MarkSessionsViewed

Marks sessions as viewed.

API	Description
GET MarkSessionsViewed/{id}	Marks sessions as viewed by Event.