Surveys

CRUD end point for managing surveys in TEF

APIDescription
GET surveys/{surveyID}

Get a survey by its TEF assigned ID

POST surveys

Create a survey

DELETE surveys/{surveyID}

Delete a survey

PUT surveys

Update a survey

GET surveys?projectID={projectID}

Get all surveys associated with a ProjectiD

POST surveys/search

Search for surveys

GET surveys/roles

Get all Survey Roles

GET surveys/{surveyID}/users

Get a Survey's users

POST surveys/{surveyID}/users/{surveyUserID}/role/{surveyRoleID}

Create a Survey User

DELETE surveys/{surveyID}/users/{surveyUserID}/role/{surveyRoleID}

Delete a Survey User

GET {authenticationKey}/{version}/Surveys/HeartBeat

No documentation available.

Projects

CRUD end point for managing projects in TEF

APIDescription
GET projects/{projectID}

Get a project by the TEF assigned project ID

POST projects

Create a project in TEF

PUT projects

Update a project in TEF

DELETE projects/{projectID}

Delete (soft) a project in TEF. The project status must be Pending.

POST projects/search

Search for projects by search criteria

GET {authenticationKey}/{version}/Projects/HeartBeat

No documentation available.

SurveyEndPoint

Manages Survey End Points used to describe different stages to a survey such as prescreener etc...

APIDescription
GET surveyendpoints/{surveyEndPointID}

Get a survey end point

DELETE surveyendpoints/{surveyEndPointID}

Delete a survey end point

POST surveyendpoints

Create a survey end point

GET surveyendpoints?waveID={waveID}

Get the survey end points associated with a wave

GET {authenticationKey}/{version}/SurveyEndPoint/HeartBeat

No documentation available.

StudyTypes

Encapsulates logic for controlling StudyTypes

APIDescription
GET studytypes/{StudyTypeID}?jobTypeID={jobTypeID}

Get a StudyType by StudyTypeID

POST studytypes

Create a StudyType

PUT studytypes

Update a StudyType

DELETE studytypes/{StudyTypeID}?jobTypeID={jobTypeID}

Delete a StudyType

GET studytypes

Gets all StudyTypes

GET {authenticationKey}/{version}/StudyTypes/HeartBeat

No documentation available.

Quotas

CRUD end point for managing intake quotas in TEF

APIDescription
GET quotas/{quotaID}

Get a quota (including the layers and subquotas)

DELETE quotas/{quotaID}

Delete a quota

POST quotas

Create a quota (including layers and subquotas)

PUT quotas

Update a quota (including layers and subquotas)

GET quotas?waveID={waveID}

Get the quotas associated with a wave

GET quotas/{quotaID}/schedule

Get the schedule specification for a wave

PUT quotas/{quotaID}/schedule

Update the schedule specification for a wave

GET quotas/{quotaID}/currenttarget

Get the targeted (completes or starts) for the current period for a live quota. (similar to getting the intervalic targets for the current period in UPS)

PUT quotas/{quotaID}/currenttarget

Set the targeted (completes or starts) for the current period for a live quota (similar to setting the intervalic targets for the current period in UPS)

GET {authenticationKey}/{version}/Quotas/HeartBeat

No documentation available.

Health

APIDescription
GET Health/Status

No documentation available.

ReferenceData

Encapsulates logic for controlling JobTypes

APIDescription
GET reference/countries

Gets all countries

GET reference/jobtypes

Gets all jobtypes

GET reference/projectstatuses

Gets all project statuses

GET reference/channels

Get channels

GET reference/vendors

Get vendors

GET reference/projectmanagers

Get project managers

GET reference/productcategories

Get product category types

GET {authenticationKey}/{version}/ReferenceData/HeartBeat

No documentation available.

SampleOrder

Manages Sample Order

APIDescription
GET sampleorders/{sampleOrderID}

Get a sample order

DELETE sampleorders/{sampleOrderID}

Delete a sample order

POST sampleorders

Create a sample order

PUT sampleorders

Update a sample order

GET sampleorders?waveID={waveID}

Get the sample orders associated with a wave

GET {authenticationKey}/{version}/SampleOrder/HeartBeat

No documentation available.

Waves

CRUD end point for managing waves in TEF

APIDescription
GET waves/{waveID}

Get a wave by the TEF assigned ID

POST waves

Create a wave

PUT waves

Update a wave

DELETE waves/{waveID}

Delete a wave

GET waves?surveyID={surveyID}

Get all waves associated with a survey

GET waves/{waveID}/events

Get all Wave Events associated to a WaveID

PUT waves/{waveID}/dynamicgids

Update a wave with a list of GIDs to be dynamically assigned to respondents

PUT waves/{waveID}/reservedgids

Update a wave with a list of GIDs pre-assigned to reserved sample

GET waves/{waveID}/gidcounts

Return a summary of the counts of GIDs (i.e. total number of GIDs, number that are still available, number that are used)

GET {authenticationKey}/{version}/Waves/HeartBeat

No documentation available.

WavesWorkflow

Change wave status

APIDescription
PUT waves/{waveID}/launch

Launch a wave (make it live)

PUT waves/{waveID}/launch?launchTime={launchTime}

Schedule the launch of a wave. The scheduled datetime format is yyyyMMddHHmmss (for example 6/1/2017 2:00 pm UTC would be 201706011140000)

PUT waves/{waveID}/hold

Put a wave on hold

PUT waves/{waveID}/close

Close a wave

GET {authenticationKey}/{version}/WavesWorkflow/HeartBeat

No documentation available.

JobTypes

Encapsulates logic for controlling JobTypes

APIDescription
GET jobtypes/{jobTypeID}

Get a JobType by JobTypeID

POST jobtypes

Create a JobType

PUT jobtypes

Update a JobType

DELETE jobtypes/{jobTypeID}

Delete a JobType

GET jobtypes

Gets all JobTypes

GET {authenticationKey}/{version}/JobTypes/HeartBeat

No documentation available.