Higi REST API Documentation

Web Services API for higi data and users. Report Bug

ParseGetId : /parse/getId

LocationSearch : /location?q={query}

ClickSettings : /clickSettings/byToken?t={token}

IntegrationGetUserBasic : /integration/user/{userId}

IntegrationGetUserFull : /integration/user/full/{userId}

IntegrationUpdateUserBasic : /integration/user/{userId}

BasicActivityData : /integration/user/{userId}/basicActivityData?since={sinceTimeStr}

ApiConsumerData : /user/{userId}/apiConsumer

DisableApiConsumer : /user/{userId}/disableApiConsumer?consumerId={consumerId}

NotifyApiSubscribers : /user/{userId}/notifyApiSubscribers?dateTime={dateTime}&notificationType={notificationType}

MigrateStayHealthyUserData : /migration/user/{userId}/stayhealthy

MigrateGroupstatUserData : /migration/user/{userId}/groupstat

serviceProvided : /serviceProvided?invoice_id={invoice_number}&reason_if_any={reason_if_any}

serviceProvided_v2new : /serviceProvided_v2

serviceProvidedPortal : /serviceProvidedPortal?transaction={invoice_number}&reason_if_any={reason_if_any}

serviceProvidedKiosk : /serviceProvidedKiosk

TeleconsultServiceProvided : /TeleconsultServiceProvided?invoice_id={invoice_number}&reason_if_any={reason_if_any}

Vitalcost : /Getvitalcost

set_cost : /set_cost

edit_cost : /edit_cost

VitalTotalCost : /addtotalvitalamount

CreatePaymentTransaction : /paymenttransaction

CreatePaymentTransaction_v2 : /paymenttransaction_v2

CreatePaymentTransaction_v3 : /paymenttransaction_v3

getProgramDetails : /getProgramDetails

createProgram : /createProgram

enrollToProgram : /enrollToProgram?user_ihl_id={user_ihl_id}&program_id={program_id}

userEnrolledOrNot : /userEnrolledOrNot?user_ihl_id={user_ihl_id}&program_id={program_id}

updateVisitDetails : /updateVisitDetails?user_ihl_id={user_ihl_id}&program_id={program_id}

UserFeedback : /UserFeedback

check_access_code : /check_access_code?code={code}&kiosk_id={kiosk_id}&ihl_id={ihl_id}&source={source}&consultant_id={consultant_id}&course_id={course_id}&purpose={purpose}

store_user_info : /store_user_info

edit_user_info : /edit_user_info

fetch_all_user_info : /fetch_all_user_info

delete_user_info : /delete_user_info

filter_values : /User_Status_Filters

filter_values_count : /User_Status_Filters_Count

add_affiliation : /user/add_affiliation?email={email}&affiliate_unique_name={affiliate_unique_name}&affiliate_name={affiliate_name}&affilate_email={affilate_email}&affilate_mobile={affilate_mobile}&affliate_identifier_id={affliate_identifier_id}&is_sso={is_sso}

api_higi_vital_status_check : /higi_vital_status_check

user_profile_weight_height_checkin : /user_profile_weight_height_checkin

get_recent_vital_data_by_count : /get_recent_vital_data_by_count

edit_user_weight_and_timestamp : /edit_user_weight_and_timestamp

check_and_validate_user_fingerprint : /check_and_validate_user_fingerprint

get_patient_recent_vital_data : /get_patient_recent_vital_data?patient_id={patient_id}

get_ecg_from_last_4_month : /get_ecg_from_last_4_month?start_date={start_date}

kiosk_rating_review_insert_update : /kiosk_rating_review_insert_update

kiosk_rating_review_insert_update_v1 : /kiosk_rating_review_insert_update_v1

upload_medical_device_data : /upload_medical_device_data

upload_medical_device_datav2 : /upload_medical_device_datav2

read_medical_device_data : /read_medical_device_data

read_medical_device_datav2 : /read_medical_device_datav2

PaymentTransactionSearch : /PaymentTransactionSearch/

LatLongJson : /LatLongJson/

GetUser : /user/{higiId}

GetHigiIdByEarndIt : /user/higiIdByEarndIt?email={email}&earndItId={earndit}

GetQData : /qData/{higiId}?newSession={newSession}

EmailUsed : /emailused/{email}

CreateUser : /user?password={password}

CreateNewUser : /user

CreateNewUser_v2 : /create_user_v2

CreateNewGuestUser : /create_user

affiliate : /affiliate

affiliate_programs : /affiliate_programs

DeleteAccount : /user/{higiId}

CreateOAuthUser : /oauthuser?provider={oauthProvider}&token={token}

UpdateUser : /user/{higiId}

make_affiliate : /user/make_affiliate?email={email}&affiliate_unique_name={affiliate_unique_name}&affiliate_name={affiliate_name}&affilate_email={affilate_email}&affilate_mobile={affilate_mobile}&affliate_identifier_id={affliate_identifier_id}&is_sso={is_sso}

EarndItConflict : /user/{higiId}/earndItConflict

GetEarndItPoints : /user/{higiId}/earndIt/points

UserSetPhoto : /user/{higiId}/photo

UserSetPhotoPosition : /user/{higiId}/photoPosition

FitnessData : /user/{higiId}/fitnessData

ActivityData : /user/{higiId}/activityData

EmailOrMobileUsed : /emailormobileused?email={email}&mobile={mobile}&aadhaar={aadhaar}

CreateNewUserForFingerprint : /CreateNewUserForFingerprint

CreateNewMvmStock : /CreateNewMvmStock

mvmTransactionDetailStore : /mvmTransactionDetailStore

mvmTransactionStatusUpdate : /mvmTransactionStatusUpdate

CreateNewMvmUser : /CreateNewMvmUser

MvmEditSingleStock : /MvmEditSingleStock

testDelete : /testDelete

MvmGetAllUsers : /MvmGetAllUsers

MvmGetAllTransactions : /MvmGetAllTransactions

MvmGetAllStock : /MvmGetAllStock

MvmUpload : /MvmUpload

MvmEditStock : /MvmEditStock

MvmDownload : /MvmDownload

MvmUserResetPassword : /MvmUserResetPassword

MvmUserLogin : /MvmUserLogin

MvmUserCreateLogin : /MvmUserCreateLogin

MvmEditUser : /MvmEditUser

MvmTimestampRead : /MvmTimestampRead

MvmUserDeleteLogin : /MvmUserDeleteLogin

MvmTimestampStore2 : /MvmTimestampStore2

MvmTimestampStore : /MvmTimestampStore

fingerprintExistsOrNot : /fingerprintExistsOrNot

CreateNewUserForFingerprint2 : /CreateNewUserForFingerprint2

CreateNewUserForFingerprint4 : /CreateNewUserForFingerprint4

CreateNewUserForFingerprint3 : /CreateNewUserForFingerprint3

GetCheckIns : /user/{higiId}/checkIn

ThirdPartyDataSharing : /user/thirdpartyshare

GetScores : /user/{higiId}/scores?start={start}&end={end}

GetCheckIn : /user/{higiId}/checkIn/{cid}

GetCheckInActivity : /user/{higiId}/activities/checkIn/{cid}

ImportCheckins : /user/{higiId}/external/checkIn

GetTerms : /getTerms

CreateCheckIn : /user/{higiId}/checkIn/?email={email}

CreateCheckInWithAttachment : /user/{higiId}/checkIn/v2/?email={email}

SendHtmlFiletoIhlUserIndentificationIdUserEmail : /SendHtmlFiletoIhlUserIndentificationIdUserEmail

CreateAffliateCheckIn : /user/{higiId}/CreateAffliateCheckIn/?email={email}

CreateCheckInActivity : /user/{higiId}/activities/checkIn/?email={email}

CreateCheckInActivityWithAttachment : /user/{higiId}/activities/checkIn/v2/?email={email}

CreateCheckInData : /user/checkInData

CreateQRCheckin : /user/{higiId}/qrCheckin

ClaimCheckInEmail : /user/{higiId}/claimCheckInEmail/{emailid}

ClaimCheckInCode : /user/{higiId}/claimCheckInCode/{code}

EmailCheckIn : /emailCheckIn?email={email}

EmailCheckInWithAttachment : /v2/emailCheckIn

EmailUserCheckIn : /emailUserCheckIn?id={id}&email={email}

EmailUserCheckInWithAttachment : /v2/emailUserCheckIn

GetEmailedCheckIn : /emailCheckIn/{emailedId}/

SaveKioskCheckIn : /kioskCheckIn

SaveUnauthCheckin : /unauthCheckin?time={time}

GetKioskCheckIn : /kioskCheckIn/{code}

JoinMailList : /joinMailList?email={email}&ip={ip}

TestConnections : /testConnections

CheckConnection : /checkconnection

KioskEventLog : /kioskEventLog?time={time}&sessionId={sessionId}&senderId={senderId}&eventCategory={eventCategory}&eventName={eventName}

KioskEventLogBulk : /kioskEventLog

ThirdPartyAccessAuditLog : /user/{userId}/auditThirdPartyAccess

KioskList : /kioskList

GetKiosk : /kiosk/{id}

DmaSearchListQuery : /dmaSearch?query={query}

DmaSearchList : /dma?zip={zip}&state={state}&city={city}&address={address}

kioskCluster : /kioskCluster?top={top}&bottom={bottom}&left={left}&right={right}&max={max}&q={query}

WithingsNotification : /withings/Notification/{withingsToken}

WithingsAuthRequest : /withings/authRequest

WithingsAuthBind : /withings/{higiUserId}/bind?oauth_token={oauth_token}&oauth_token_secret_enc={oauth_token_secret_enc}&oauth_verifier={oauth_verifier}&withingsUserid={withingsUserid}

WithingsAuthUnbind : /withings/{higiUserId}/unbind

HealthvaultAuthBind : /healthvault/{higiUserId}/bind?oauth_token={oauth_token}

DeleteAccountUnder13 : /deleteAccountAge13?userId={higiUserId}&dob={dob}

FacebookBind : /facebook/{higiUserId}/bind?token={token}

FacebookUnBind : /facebook/{higiUserId}/unbind

TwitterBind : /twitter/{higiUserId}/bind?token={token}&token_secret={token_secret}

TwitterUnBind : /twitter/{higiUserId}/unbind

FacebookInviteSent : /facebook/{higiUserId}/inviteSent/{inviteId}/{toFacebookId}

FacebookAcceptReferral : /facebook/{higiUserId}/acceptReferral/{inviteId}

LeaderBoardProfilesFull : /leaderBoard/{higiUserId}/full

LeaderBoardProfilesContest : /leaderBoard/Contests/{contestName}

LeaderBoardProfilesFullWithInvites : /leaderBoard/{higiUserId}/fullWithInvites

LeaderBoardProfilesZoom : /leaderBoard/{higiUserId}/zoom?count={count}

AllActivities : /activities/{higiUserId}/all

AwardDefinitions : /award/definitions

AllUserAwards : /awards/{higiUserId}

GetScoreHistograms : /scorehistograms

AllUserAwardsAndDefs : /awards/{higiUserId}/all

GetKioskSettings : /kiosk/settings

GetKioskAdInfo : /kiosk/adInfo

DeleteCheckIn : /user/{higiId}/checkIn/{checkinid}

CreatePhotoActivity : /user/{higiId}/activities/photo/?caption={caption}&share={share}

CreatePhotoActivityMobile : /user/{higiId}/activities/photo/&caption={caption}

CreatePhotoActivityAnalysis : /user/{higiId}/activities/photo/{photoId}/analysis?time={time}

SetActivityAnalysisIncorrect : /user/{higiId}/activities/photo/{photoId}/analysis?incorrect={flag}&caption={caption}

SetActivityAnalysisRating : /user/{higiId}/activities/photo/{photoId}/analysis/{analysisid}?rating={rating}&comment={comment}

GetPhotoInfo : /user/{higiId}/activities/photo/?ids={ids}

PortalRegistrationPersistent : /persistentPortalRegistration

GetPhotoInfoJustPhotoId : /activities/photo/{photoid}?latestOnly={latest}&myid={myid}

GetPhotoShotsRemaining : /user/{higiId}/activities/photo/shotsRemaining

GetPhotoInfoInList : /activities/getPhotoInfos/

DeletePhotoActivity : /user/{higiId}/activities/photo/{id}

GetPublicHigiShot : /higiShot/{id}

CreatePhotoActivityTwitter : /activities/twitterPhoto/{twitterId}

ShareMobileScreen : /user/{higiId}/activities/shareMobileScreen

GetShareMobileScreen : /activities/shareMobileScreen/{screenId}

GetAppData : /user/{userId}/appData/{appName}/{valName}

GetAppDataAll : /user/{userId}/appData/{appName}

GetAppDataAllNoTimes : /user/{userId}/appDataNoTimes/{appName}

PutAppData : /user/{userId}/appData/{appName}/{valName}?value={value}

TokenGetId : /tokens/getId