Package: lamp-core
Python API client for the LAMP Platform.OverviewThis API client is used to connect to the LAMP Platform from the Python programming language.Visit our documentation for more information about the LAMP Platform.InstallationPrerequisitesPython 3.4+ andpip.You may need root permissions, usingsudo.Alternatively, to install locally, usepip --user.Ifpipis not recognized as a command, usepython3 -m pip.InstallationpipinstallLAMP-coreConfigurationEnsure yourserver_addressis set correctly. If using the default server, it will beapi.lamp.digital. Keep youraccess_key(sometimes an email address) andsecret_key(sometimes a password) private and do not share them with others.importLAMPLAMP.connect(access_key,secret_key,server_address)API EndpointsClassMethodHTTP requestDescriptionLAMP.APIqueryPOST/Query the LAMP Database.LAMP.APIschemaGET/View the API schema document.LAMP.ActivityallGET/activityGet the set of all activities.LAMP.Activityall_by_participantGET/participant/{participant_id}/activityGet all activities for a participant.LAMP.Activityall_by_researcherGET/researcher/{researcher_id}/activityGet all activities for a researcher.LAMP.Activityall_by_studyGET/study/{study_id}/activityGet all activities in a study.LAMP.ActivitycreatePOST/study/{study_id}/activityCreate a new Activity under the given Study.LAMP.ActivitydeleteDELETE/activity/{activity_id}Delete an Activity.LAMP.ActivityupdatePUT/activity/{activity_id}Update an Activity's settings.LAMP.ActivityviewGET/activity/{activity_id}Get a single activity, by identifier.LAMP.ActivityEventall_by_participantGET/participant/{participant_id}/activity_eventGet all activity events for a participant.LAMP.ActivityEventall_by_researcherGET/researcher/{researcher_id}/activity_eventGet all activity events for a researcher by participant.LAMP.ActivityEventall_by_studyGET/study/{study_id}/activity_eventGet all activity events for a study by participant.LAMP.ActivityEventcreatePOST/participant/{participant_id}/activity_eventCreate a new ActivityEvent for the given Participant.LAMP.ActivityEventdeleteDELETE/participant/{participant_id}/activity_eventDelete a ActivityEvent.LAMP.ActivitySpecallGET/activity_specGet all ActivitySpecs registered.LAMP.ActivitySpeccreatePOST/activity_specCreate a new ActivitySpec.LAMP.ActivitySpecdeleteDELETE/activity_spec/{activity_spec_name}Delete an ActivitySpec.LAMP.ActivitySpecupdatePUT/activity_spec/{activity_spec_name}Update an ActivitySpec.LAMP.ActivitySpecviewGET/activity_spec/{activity_spec_name}View an ActivitySpec.LAMP.CredentialcreatePOST/type/{type_id}/credentialLAMP.CredentialdeleteDELETE/type/{type_id}/credential/{access_key}LAMP.CredentiallistGET/type/{type_id}/credentialLAMP.CredentialupdatePUT/type/{type_id}/credential/{access_key}LAMP.ParticipantallGET/participantGet the set of all participants.LAMP.Participantall_by_researcherGET/researcher/{researcher_id}/participantGet the set of all participants under a single researcher.LAMP.Participantall_by_studyGET/study/{study_id}/participantGet the set of all participants in a single study.LAMP.ParticipantcreatePOST/study/{study_id}/participantCreate a new Participant for the given Study.LAMP.ParticipantdeleteDELETE/participant/{participant_id}Delete a participant AND all owned data or event streams.LAMP.ParticipantupdatePUT/participant/{participant_id}Update a Participant's settings.LAMP.ParticipantviewGET/participant/{participant_id}Get a single participant, by identifier.LAMP.ResearcherallGET/researcherGet the set of all researchers.LAMP.ResearchercreatePOST/researcherCreate a new Researcher.LAMP.ResearcherdeleteDELETE/researcher/{researcher_id}Delete a researcher.LAMP.ResearcherupdatePUT/researcher/{researcher_id}Update a Researcher's settings.LAMP.ResearcherviewGET/researcher/{researcher_id}Get a single researcher, by identifier.LAMP.SensorallGET/sensorGet the set of all sensors.LAMP.Sensorall_by_participantGET/participant/{participant_id}/sensorGet all sensors for a participant.LAMP.Sensorall_by_researcherGET/researcher/{researcher_id}/sensorGet all sensors for a researcher.LAMP.Sensorall_by_studyGET/study/{study_id}/sensorView all sensors in a study.LAMP.SensorcreatePOST/study/{study_id}/sensorCreate a new Sensor under the given Study.LAMP.SensordeleteDELETE/sensor/{sensor_id}Delete a Sensor.LAMP.SensorupdatePUT/sensor/{sensor_id}Update an Sensor's settings.LAMP.SensorviewGET/sensor/{sensor_id}Get a single sensor, by identifier.LAMP.SensorEventall_by_participantGET/participant/{participant_id}/sensor_eventGet all sensor events for a participant.LAMP.SensorEventall_by_researcherGET/researcher/{researcher_id}/sensor_eventGet all sensor events for a researcher by participant.LAMP.SensorEventall_by_studyGET/study/{study_id}/sensor_eventGet all sensor events for a study by participant.LAMP.SensorEventcreatePOST/participant/{participant_id}/sensor_eventCreate a new SensorEvent for the given Participant.LAMP.SensorEventdeleteDELETE/participant/{participant_id}/sensor_eventDelete a sensor event.LAMP.SensorSpecallGET/sensor_specGet all SensorSpecs registered.LAMP.SensorSpeccreatePOST/sensor_specCreate a new SensorSpec.LAMP.SensorSpecdeleteDELETE/sensor_spec/{sensor_spec_name}Delete an SensorSpec.LAMP.SensorSpecupdatePUT/sensor_spec/{sensor_spec_name}Update an SensorSpec.LAMP.SensorSpecviewGET/sensor_spec/{sensor_spec_name}Get a SensorSpec.LAMP.StudyallGET/studyGet the set of all studies.LAMP.Studyall_by_researcherGET/researcher/{researcher_id}/studyGet the set of studies for a single researcher.LAMP.StudycreatePOST/researcher/{researcher_id}/studyCreate a new Study for the given Researcher.LAMP.StudydeleteDELETE/study/{study_id}Delete a study.LAMP.StudyupdatePUT/study/{study_id}Update the study.LAMP.StudyviewGET/study/{study_id}Get a single study, by identifier.LAMP.Typeget_attachmentGET/type/{type_id}/attachment/{attachment_key}LAMP.Typeget_dynamic_attachmentGET/type/{type_id}/attachment/dynamic/{attachment_key}LAMP.Typelist_attachmentsGET/type/{type_id}/attachmentLAMP.TypeparentGET/type/{type_id}/parentFind the owner(s) of the resource.LAMP.Typeset_attachmentPUT/type/{type_id}/attachment/{attachment_key}/{target}LAMP.Typeset_dynamic_attachmentPUT/type/{type_id}/attachment/dynamic/{attachment_key}/{target}Documentation For ModelsAccessCitationActivityActivityEventActivitySpecCredentialDocumentDurationIntervalDurationIntervalLegacyDynamicAttachmentErrorMetadataParticipantResearcherSensorSensorEventSensorSpecStudyTemporalSlice