> For the complete documentation index, see [llms.txt](https://docs.geosamples.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geosamples.org/api/models.md). # Models ## The AgentRoleType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"AgentRoleType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id"]}}}} ``` ## The AgentRoleTypeListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"AgentRoleTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentRoleType"},"description":"Agent role types."}},"required":["data"]},"AgentRoleType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id"]}}}} ``` ## The Archive object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"Archive":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":36},"parent_institution":{"allOf":[{"$ref":"#/components/schemas/Institution"}],"readOnly":true}},"required":["country","id","label","parent_institution"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The ArchiveCreateSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ArchiveCreateSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Archive"}},"required":["data"]},"Archive":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":36},"parent_institution":{"allOf":[{"$ref":"#/components/schemas/Institution"}],"readOnly":true}},"required":["country","id","label","parent_institution"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The ArchiveInput object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ArchiveInput":{"type":"object","description":"Inline archive payload for create-or-match by label.","properties":{"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":25}},"required":["label"]}}}} ``` ## The ArchiveListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ArchiveListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Archive"},"description":"Matching archives (up to `limit`)."}},"required":["data"]},"Archive":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":36},"parent_institution":{"allOf":[{"$ref":"#/components/schemas/Institution"}],"readOnly":true}},"required":["country","id","label","parent_institution"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The ArchiveWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ArchiveWrite":{"type":"object","properties":{"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":36},"parent_institution":{"type":"integer","nullable":true},"created_by":{"type":"integer","readOnly":true,"nullable":true}},"required":["created_by","label"]}}}} ``` ## The AuthUserDetailsSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"AuthUserDetailsSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AuthUserDetailsSuccessData"}},"required":["data"]},"AuthUserDetailsSuccessData":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/SesarUser"},"jwt_connection":{"type":"string","nullable":true,"description":"JWT `connection` claim when present, else null."}},"required":["jwt_connection","user"]},"SesarUser":{"type":"object","properties":{"individual":{"allOf":[{"$ref":"#/components/schemas/Individual"}],"readOnly":true},"email":{"type":"string","nullable":true,"maxLength":255},"registration_date":{"type":"string","format":"date-time"},"orcid":{"type":"string","nullable":true,"maxLength":19},"doi_prefix":{"type":"string","maxLength":10},"upload_permission_status":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"notification_preferences":{},"is_staff":{"type":"boolean","readOnly":true},"is_admin":{"type":"integer","readOnly":true},"storage_used":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"storage_limit":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"}},"required":["individual","is_admin","is_staff","storage_limit","storage_used"]},"Individual":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"readOnly":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true}},"required":["can_edit","country","id","institutions"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The AuthUserDetailsSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"AuthUserDetailsSuccessData":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/SesarUser"},"jwt_connection":{"type":"string","nullable":true,"description":"JWT `connection` claim when present, else null."}},"required":["jwt_connection","user"]},"SesarUser":{"type":"object","properties":{"individual":{"allOf":[{"$ref":"#/components/schemas/Individual"}],"readOnly":true},"email":{"type":"string","nullable":true,"maxLength":255},"registration_date":{"type":"string","format":"date-time"},"orcid":{"type":"string","nullable":true,"maxLength":19},"doi_prefix":{"type":"string","maxLength":10},"upload_permission_status":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"notification_preferences":{},"is_staff":{"type":"boolean","readOnly":true},"is_admin":{"type":"integer","readOnly":true},"storage_used":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"storage_limit":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"}},"required":["individual","is_admin","is_staff","storage_limit","storage_used"]},"Individual":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"readOnly":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true}},"required":["can_edit","country","id","institutions"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The BackgroundJob object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BackgroundJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"job_type":{"allOf":[{"$ref":"#/components/schemas/JobTypeEnum"}],"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/StatusEnum"}],"readOnly":true},"payload":{"readOnly":true},"result":{"readOnly":true,"nullable":true},"error_message":{"type":"string","readOnly":true,"nullable":true},"total_count":{"type":"integer","readOnly":true,"nullable":true},"processed_count":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"started_at":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"finished_at":{"type":"string","format":"date-time","readOnly":true,"nullable":true}},"required":["created_at","error_message","finished_at","id","job_type","payload","processed_count","result","started_at","status","total_count"]},"JobTypeEnum":{"enum":["batch_registration","sample_export"],"type":"string","description":"* `batch_registration` - Batch registration\n* `sample_export` - Sample export"},"StatusEnum":{"enum":["pending","processing","completed","failed"],"type":"string","description":"* `pending` - Pending\n* `processing` - Processing\n* `completed` - Completed\n* `failed` - Failed"}}}} ``` ## The BackgroundJobCancelBadRequestResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BackgroundJobCancelBadRequestResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{}}},"required":["errors","message"]}}}} ``` ## The BackgroundJobCancelSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BackgroundJobCancelSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}},"required":["data"]},"BackgroundJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"job_type":{"allOf":[{"$ref":"#/components/schemas/JobTypeEnum"}],"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/StatusEnum"}],"readOnly":true},"payload":{"readOnly":true},"result":{"readOnly":true,"nullable":true},"error_message":{"type":"string","readOnly":true,"nullable":true},"total_count":{"type":"integer","readOnly":true,"nullable":true},"processed_count":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"started_at":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"finished_at":{"type":"string","format":"date-time","readOnly":true,"nullable":true}},"required":["created_at","error_message","finished_at","id","job_type","payload","processed_count","result","started_at","status","total_count"]},"JobTypeEnum":{"enum":["batch_registration","sample_export"],"type":"string","description":"* `batch_registration` - Batch registration\n* `sample_export` - Sample export"},"StatusEnum":{"enum":["pending","processing","completed","failed"],"type":"string","description":"* `pending` - Pending\n* `processing` - Processing\n* `completed` - Completed\n* `failed` - Failed"}}}} ``` ## The BackgroundJobDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BackgroundJobDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BackgroundJob"}},"required":["data"]},"BackgroundJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"job_type":{"allOf":[{"$ref":"#/components/schemas/JobTypeEnum"}],"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/StatusEnum"}],"readOnly":true},"payload":{"readOnly":true},"result":{"readOnly":true,"nullable":true},"error_message":{"type":"string","readOnly":true,"nullable":true},"total_count":{"type":"integer","readOnly":true,"nullable":true},"processed_count":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"started_at":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"finished_at":{"type":"string","format":"date-time","readOnly":true,"nullable":true}},"required":["created_at","error_message","finished_at","id","job_type","payload","processed_count","result","started_at","status","total_count"]},"JobTypeEnum":{"enum":["batch_registration","sample_export"],"type":"string","description":"* `batch_registration` - Batch registration\n* `sample_export` - Sample export"},"StatusEnum":{"enum":["pending","processing","completed","failed"],"type":"string","description":"* `pending` - Pending\n* `processing` - Processing\n* `completed` - Completed\n* `failed` - Failed"}}}} ``` ## The BackgroundJobDownloadNotFoundResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BackgroundJobDownloadNotFoundResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{}}},"required":["errors","message"]}}}} ``` ## The BatchCurationAcceptSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationAcceptSuccessData":{"type":"object","properties":{"updated_sample_count":{"type":"integer"},"batch":{"$ref":"#/components/schemas/BatchHistory"}},"required":["batch","updated_sample_count"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchCurationAcceptSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationAcceptSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchCurationAcceptSuccessData"}},"required":["data"]},"BatchCurationAcceptSuccessData":{"type":"object","properties":{"updated_sample_count":{"type":"integer"},"batch":{"$ref":"#/components/schemas/BatchHistory"}},"required":["batch","updated_sample_count"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchCurationColumn object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationColumn":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"]}}}} ``` ## The BatchCurationDeactivateSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationDeactivateSuccessData":{"type":"object","properties":{"deactivated_sample_count":{"type":"integer"},"batch":{"$ref":"#/components/schemas/BatchHistory"}},"required":["batch","deactivated_sample_count"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchCurationDeactivateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationDeactivateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchCurationDeactivateSuccessData"}},"required":["data"]},"BatchCurationDeactivateSuccessData":{"type":"object","properties":{"deactivated_sample_count":{"type":"integer"},"batch":{"$ref":"#/components/schemas/BatchHistory"}},"required":["batch","deactivated_sample_count"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchCurationDetailData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationDetailData":{"type":"object","properties":{"batch":{"$ref":"#/components/schemas/BatchHistory"},"shared_fields":{"type":"array","items":{"$ref":"#/components/schemas/BatchCurationSharedField"}},"columns":{"type":"array","items":{"$ref":"#/components/schemas/BatchCurationColumn"}},"samples":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","nullable":true}}},"sample_count":{"type":"integer"}},"required":["batch","columns","sample_count","samples","shared_fields"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]},"BatchCurationSharedField":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["key","label","value"]},"BatchCurationColumn":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"]}}}} ``` ## The BatchCurationDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchCurationDetailData"}},"required":["data"]},"BatchCurationDetailData":{"type":"object","properties":{"batch":{"$ref":"#/components/schemas/BatchHistory"},"shared_fields":{"type":"array","items":{"$ref":"#/components/schemas/BatchCurationSharedField"}},"columns":{"type":"array","items":{"$ref":"#/components/schemas/BatchCurationColumn"}},"samples":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string","nullable":true}}},"sample_count":{"type":"integer"}},"required":["batch","columns","sample_count","samples","shared_fields"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]},"BatchCurationSharedField":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["key","label","value"]},"BatchCurationColumn":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"}},"required":["key","label"]}}}} ``` ## The BatchCurationFeedback object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationFeedback":{"type":"object","properties":{"general_feedback":{"type":"string","default":"","maxLength":10000},"sample_feedback":{"type":"array","items":{"$ref":"#/components/schemas/SampleFeedbackItem"}}}},"SampleFeedbackItem":{"type":"object","properties":{"igsn":{"type":"string","maxLength":60},"name":{"type":"string","default":""},"comment":{"type":"string","maxLength":5000}},"required":["comment","igsn"]}}}} ``` ## The BatchCurationFeedbackSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationFeedbackSuccessData":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The BatchCurationFeedbackSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationFeedbackSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchCurationFeedbackSuccessData"}},"required":["data"]},"BatchCurationFeedbackSuccessData":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The BatchCurationSharedField object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchCurationSharedField":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"value":{"type":"string"}},"required":["key","label","value"]}}}} ``` ## The BatchHistory object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchHistoryDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchHistoryDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchHistory"}},"required":["data"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchHistoryListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchHistoryListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchHistory"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchHistorySpreadsheetNotFoundResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchHistorySpreadsheetNotFoundResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{}}},"required":["errors","message"]}}}} ``` ## The BatchRegistrationUpload object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchRegistrationUpload":{"type":"object","properties":{"file":{"type":"string","format":"uri","description":"Completed batch registration spreadsheet (.xlsx) from the template creator."},"save_as_draft":{"type":"boolean","default":false,"description":"When true, create samples with metadata_store_status=draft instead of pending-review. Draft validation applies (e.g. latitude/longitude optional)."}},"required":["file"]}}}} ``` ## The BatchRegistrationUploadQueuedData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchRegistrationUploadQueuedData":{"type":"object","properties":{"job_id":{"type":"string","format":"uuid"},"filename":{"type":"string"},"status":{"type":"string"}},"required":["filename","job_id","status"]}}}} ``` ## The BatchRegistrationUploadQueuedResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchRegistrationUploadQueuedResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchRegistrationUploadQueuedData"}},"required":["data"]},"BatchRegistrationUploadQueuedData":{"type":"object","properties":{"job_id":{"type":"string","format":"uuid"},"filename":{"type":"string"},"status":{"type":"string"}},"required":["filename","job_id","status"]}}}} ``` ## The BatchSubmitForReviewSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchSubmitForReviewSuccessData":{"type":"object","properties":{"updated_sample_count":{"type":"integer"},"batch":{"$ref":"#/components/schemas/BatchHistory"}},"required":["batch","updated_sample_count"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchSubmitForReviewSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchSubmitForReviewSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchSubmitForReviewSuccessData"}},"required":["data"]},"BatchSubmitForReviewSuccessData":{"type":"object","properties":{"updated_sample_count":{"type":"integer"},"batch":{"$ref":"#/components/schemas/BatchHistory"}},"required":["batch","updated_sample_count"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The BatchTemplateCreateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchTemplateCreateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchTemplateRead"}},"required":["data"]},"BatchTemplateRead":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"sesar_code":{"type":"string","nullable":true,"readOnly":true},"object_type":{"allOf":[{"$ref":"#/components/schemas/ObjectType"}],"readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_by":{"type":"string","nullable":true,"readOnly":true},"created_date":{"type":"string","format":"date-time"},"is_archived":{"type":"boolean"},"selected_fields":{"readOnly":true},"initiatives":{"type":"string","readOnly":true},"platforms":{"type":"string","readOnly":true},"launch_platforms":{"type":"string","readOnly":true},"current_archives":{"type":"string","readOnly":true},"original_archives":{"type":"string","readOnly":true},"collector_tags":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true}},"required":["collector_tags","created_by","current_archives","id","initiatives","is_archived","label","launch_platforms","object_type","original_archives","platforms","selected_fields","sesar_code","team_owner","user_owner"]},"ObjectType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"parent_type":{"type":"string","readOnly":true},"scheme_name":{"type":"string","nullable":true,"maxLength":50},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["hierarchical_label","id","label","parent_type"]}}}} ``` ## The BatchTemplateDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchTemplateDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchTemplateRead"}},"required":["data"]},"BatchTemplateRead":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"sesar_code":{"type":"string","nullable":true,"readOnly":true},"object_type":{"allOf":[{"$ref":"#/components/schemas/ObjectType"}],"readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_by":{"type":"string","nullable":true,"readOnly":true},"created_date":{"type":"string","format":"date-time"},"is_archived":{"type":"boolean"},"selected_fields":{"readOnly":true},"initiatives":{"type":"string","readOnly":true},"platforms":{"type":"string","readOnly":true},"launch_platforms":{"type":"string","readOnly":true},"current_archives":{"type":"string","readOnly":true},"original_archives":{"type":"string","readOnly":true},"collector_tags":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true}},"required":["collector_tags","created_by","current_archives","id","initiatives","is_archived","label","launch_platforms","object_type","original_archives","platforms","selected_fields","sesar_code","team_owner","user_owner"]},"ObjectType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"parent_type":{"type":"string","readOnly":true},"scheme_name":{"type":"string","nullable":true,"maxLength":50},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["hierarchical_label","id","label","parent_type"]}}}} ``` ## The BatchTemplateList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchTemplateList":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"sesar_code":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_by":{"type":"integer"},"created_date":{"type":"string","format":"date-time"},"is_archived":{"type":"boolean"}},"required":["created_by","id","is_archived","label","object_type","sesar_code","team_owner","user_owner"]}}}} ``` ## The BatchTemplateListSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchTemplateListSuccessResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchTemplateList"}}},"required":["data"]},"BatchTemplateList":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"sesar_code":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_by":{"type":"integer"},"created_date":{"type":"string","format":"date-time"},"is_archived":{"type":"boolean"}},"required":["created_by","id","is_archived","label","object_type","sesar_code","team_owner","user_owner"]}}}} ``` ## The BatchTemplateRead object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchTemplateRead":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"sesar_code":{"type":"string","nullable":true,"readOnly":true},"object_type":{"allOf":[{"$ref":"#/components/schemas/ObjectType"}],"readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_by":{"type":"string","nullable":true,"readOnly":true},"created_date":{"type":"string","format":"date-time"},"is_archived":{"type":"boolean"},"selected_fields":{"readOnly":true},"initiatives":{"type":"string","readOnly":true},"platforms":{"type":"string","readOnly":true},"launch_platforms":{"type":"string","readOnly":true},"current_archives":{"type":"string","readOnly":true},"original_archives":{"type":"string","readOnly":true},"collector_tags":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true}},"required":["collector_tags","created_by","current_archives","id","initiatives","is_archived","label","launch_platforms","object_type","original_archives","platforms","selected_fields","sesar_code","team_owner","user_owner"]},"ObjectType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"parent_type":{"type":"string","readOnly":true},"scheme_name":{"type":"string","nullable":true,"maxLength":50},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["hierarchical_label","id","label","parent_type"]}}}} ``` ## The BatchTemplateUpdateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchTemplateUpdateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchTemplateRead"}},"required":["data"]},"BatchTemplateRead":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"sesar_code":{"type":"string","nullable":true,"readOnly":true},"object_type":{"allOf":[{"$ref":"#/components/schemas/ObjectType"}],"readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_by":{"type":"string","nullable":true,"readOnly":true},"created_date":{"type":"string","format":"date-time"},"is_archived":{"type":"boolean"},"selected_fields":{"readOnly":true},"initiatives":{"type":"string","readOnly":true},"platforms":{"type":"string","readOnly":true},"launch_platforms":{"type":"string","readOnly":true},"current_archives":{"type":"string","readOnly":true},"original_archives":{"type":"string","readOnly":true},"collector_tags":{"type":"array","items":{"type":"object","additionalProperties":{}},"readOnly":true}},"required":["collector_tags","created_by","current_archives","id","initiatives","is_archived","label","launch_platforms","object_type","original_archives","platforms","selected_fields","sesar_code","team_owner","user_owner"]},"ObjectType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"parent_type":{"type":"string","readOnly":true},"scheme_name":{"type":"string","nullable":true,"maxLength":50},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["hierarchical_label","id","label","parent_type"]}}}} ``` ## The BatchTemplateWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BatchTemplateWrite":{"type":"object","properties":{"label":{"type":"string","maxLength":255},"sesar_code":{"type":"string","nullable":true},"object_type":{"type":"integer","nullable":true},"is_archived":{"type":"boolean","default":false},"selected_fields":{},"cruise_field_prgrms":{},"platforms":{},"launch_platforms":{},"current_archives":{},"original_archives":{},"collectors":{}},"required":["label"]}}}} ``` ## The BlankEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"BlankEnum":{"enum":[""]}}}} ``` ## The CollectorIndividualInput object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"CollectorIndividualInput":{"type":"object","description":"Inline individual payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"individual_uri":{"type":"string","nullable":true,"maxLength":255}}}}}} ``` ## The CollectorInput object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"CollectorInput":{"type":"object","description":"Collector reference (id or inline individual/institution payload).","properties":{"description":{"type":"string","nullable":true},"individual":{"allOf":[{"$ref":"#/components/schemas/CollectorIndividualInput"}],"nullable":true},"institution":{"allOf":[{"$ref":"#/components/schemas/CollectorInstitutionInput"}],"nullable":true}}},"CollectorIndividualInput":{"type":"object","description":"Inline individual payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"individual_uri":{"type":"string","nullable":true,"maxLength":255}}},"CollectorInstitutionInput":{"type":"object","description":"Inline institution payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"ror":{"type":"string","nullable":true,"maxLength":25},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true}}}}}} ``` ## The CollectorInstitutionInput object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"CollectorInstitutionInput":{"type":"object","description":"Inline institution payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"ror":{"type":"string","nullable":true,"maxLength":25},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true}}}}}} ``` ## The CompletedBatchHistoryListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"CompletedBatchHistoryListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchHistory"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The Country object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","readOnly":true},"iso3166code":{"type":"string","readOnly":true,"nullable":true}},"required":["id","iso3166code","label"]}}}} ``` ## The CountrySearchSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"CountrySearchSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Country"},"description":"Matching active countries."}},"required":["data"]},"Country":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","readOnly":true},"iso3166code":{"type":"string","readOnly":true,"nullable":true}},"required":["id","iso3166code","label"]}}}} ``` ## The DeactivateReasonEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"DeactivateReasonEnum":{"enum":["this was a test sample","this sample does not exist","duplicate igsn","other"],"type":"string","description":"* `this was a test sample` - this was a test sample\n* `this sample does not exist` - this sample does not exist\n* `duplicate igsn` - duplicate igsn\n* `other` - other"}}}} ``` ## The ElevationUnitEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"}}}} ``` ## The GeologicTimeScale object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"GeologicTimeScale":{"type":"object","properties":{"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"geologic_time_interval_uri":{"type":"string","nullable":true,"maxLength":255},"source":{"type":"string","nullable":true,"maxLength":255},"scheme_uri":{"type":"string","nullable":true,"maxLength":255},"numeric_older_bound":{"type":"number","format":"double","nullable":true},"numeric_younger_bound":{"type":"number","format":"double","nullable":true},"notation":{"type":"string","nullable":true,"maxLength":32}},"required":["label"]}}}} ``` ## The Individual object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"Individual":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"readOnly":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true}},"required":["can_edit","country","id","institutions"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The IndividualCreateSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualCreateSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Individual"}},"required":["data"]},"Individual":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"readOnly":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true}},"required":["can_edit","country","id","institutions"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The IndividualDeleteSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualDeleteSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IndividualDeleteSuccessData"}},"required":["data"]},"IndividualDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The IndividualDeleteSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The IndividualDetailSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualDetailSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Individual"}},"required":["data"]},"Individual":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"readOnly":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true}},"required":["can_edit","country","id","institutions"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The IndividualListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Individual"},"description":"Matching individuals (up to `limit`)."}},"required":["data"]},"Individual":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"readOnly":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true}},"required":["can_edit","country","id","institutions"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The IndividualOrcidLookupData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualOrcidLookupData":{"type":"object","properties":{"individual_uri":{"type":"string"},"fname":{"type":"string","nullable":true},"lname":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"has_public_name":{"type":"boolean"},"has_public_email":{"type":"boolean"}},"required":["email","fname","has_public_email","has_public_name","individual_uri","label","lname"]}}}} ``` ## The IndividualOrcidLookupSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualOrcidLookupSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IndividualOrcidLookupData"}},"required":["data"]},"IndividualOrcidLookupData":{"type":"object","properties":{"individual_uri":{"type":"string"},"fname":{"type":"string","nullable":true},"lname":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"has_public_name":{"type":"boolean"},"has_public_email":{"type":"boolean"}},"required":["email","fname","has_public_email","has_public_name","individual_uri","label","lname"]}}}} ``` ## The IndividualUpdate object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualUpdate":{"type":"object","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","readOnly":true},"country":{"type":"string","nullable":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"type":"integer"}}},"required":["individual_uri"]}}}} ``` ## The IndividualUpdateSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualUpdateSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Individual"}},"required":["data"]},"Individual":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"readOnly":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true}},"required":["can_edit","country","id","institutions"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The IndividualWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"IndividualWrite":{"type":"object","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The Initiative object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"Initiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}},"required":["id","label"]}}}} ``` ## The InitiativeCreateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InitiativeCreateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Initiative"}},"required":["data"]},"Initiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}},"required":["id","label"]}}}} ``` ## The InitiativeDeleteSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InitiativeDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The InitiativeDeleteSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InitiativeDeleteSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InitiativeDeleteSuccessData"}},"required":["data"]},"InitiativeDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The InitiativeDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InitiativeDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Initiative"}},"required":["data"]},"Initiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}},"required":["id","label"]}}}} ``` ## The InitiativeListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InitiativeListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/Initiative"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"Initiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}},"required":["id","label"]}}}} ``` ## The InitiativeLookupLabel object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InitiativeLookupLabel":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}}}} ``` ## The InitiativeLookupSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InitiativeLookupSuccessResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InitiativeLookupLabel"}}},"required":["data"]},"InitiativeLookupLabel":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}}}} ``` ## The InitiativeUpdateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InitiativeUpdateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Initiative"}},"required":["data"]},"Initiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}},"required":["id","label"]}}}} ``` ## The Institution object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The InstitutionCreateSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionCreateSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Institution"}},"required":["data"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The InstitutionDeleteSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionDeleteSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InstitutionDeleteSuccessData"}},"required":["data"]},"InstitutionDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The InstitutionDeleteSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The InstitutionDetailSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionDetailSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Institution"}},"required":["data"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The InstitutionListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"description":"Matching institutions (up to `limit`)."}},"required":["data"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The InstitutionType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","readOnly":true,"nullable":true},"description":{"type":"string","readOnly":true,"nullable":true},"source":{"type":"string","readOnly":true,"nullable":true}},"required":["description","id","label","source"]}}}} ``` ## The InstitutionTypeListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InstitutionType"},"description":"Selectable institution types."}},"required":["data"]},"InstitutionType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","readOnly":true,"nullable":true},"description":{"type":"string","readOnly":true,"nullable":true},"source":{"type":"string","readOnly":true,"nullable":true}},"required":["description","id","label","source"]}}}} ``` ## The InstitutionUpdateSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionUpdateSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Institution"}},"required":["data"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The InstitutionWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"InstitutionWrite":{"type":"object","properties":{"institution_type":{"type":"string","nullable":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"array","items":{"type":"integer","writeOnly":true},"writeOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["label"]}}}} ``` ## The JobTypeEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JobTypeEnum":{"enum":["batch_registration","sample_export"],"type":"string","description":"* `batch_registration` - Batch registration\n* `sample_export` - Sample export"}}}} ``` ## The JwtConnectionPairSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JwtConnectionPairSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JwtConnectionPairSuccessData"}},"required":["data"]},"JwtConnectionPairSuccessData":{"type":"object","properties":{"refresh":{"type":"string","description":"JWT refresh token"},"access":{"type":"string","description":"JWT access token"}},"required":["access","refresh"]}}}} ``` ## The JwtConnectionPairSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JwtConnectionPairSuccessData":{"type":"object","properties":{"refresh":{"type":"string","description":"JWT refresh token"},"access":{"type":"string","description":"JWT access token"}},"required":["access","refresh"]}}}} ``` ## The JwtObtainPairSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JwtObtainPairSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JwtObtainPairSuccessData"}},"required":["data"]},"JwtObtainPairSuccessData":{"type":"object","properties":{"refresh":{"type":"string","description":"JWT refresh token"},"access":{"type":"string","description":"JWT access token"}},"required":["access","refresh"]}}}} ``` ## The JwtObtainPairSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JwtObtainPairSuccessData":{"type":"object","properties":{"refresh":{"type":"string","description":"JWT refresh token"},"access":{"type":"string","description":"JWT access token"}},"required":["access","refresh"]}}}} ``` ## The JwtRefreshPairSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JwtRefreshPairSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JwtRefreshPairSuccessData"}},"required":["data"]},"JwtRefreshPairSuccessData":{"type":"object","properties":{"refresh":{"type":"string","description":"New JWT refresh token"},"access":{"type":"string","description":"New JWT access token"}},"required":["access","refresh"]}}}} ``` ## The JwtRefreshPairSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JwtRefreshPairSuccessData":{"type":"object","properties":{"refresh":{"type":"string","description":"New JWT refresh token"},"access":{"type":"string","description":"New JWT access token"}},"required":["access","refresh"]}}}} ``` ## The JwtRevokeAllSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JwtRevokeAllSuccess":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JwtRevokeAllSuccessData"}},"required":["data"]},"JwtRevokeAllSuccessData":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable count of tokens revoked"}},"required":["message"]}}}} ``` ## The JwtRevokeAllSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"JwtRevokeAllSuccessData":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable count of tokens revoked"}},"required":["message"]}}}} ``` ## The LaunchPlatform object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","launch_type","operator","team_owner","user_owner"]}}}} ``` ## The LaunchPlatformCreateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformCreateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LaunchPlatform"}},"required":["data"]},"LaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","launch_type","operator","team_owner","user_owner"]}}}} ``` ## The LaunchPlatformDeleteSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The LaunchPlatformDeleteSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformDeleteSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LaunchPlatformDeleteSuccessData"}},"required":["data"]},"LaunchPlatformDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The LaunchPlatformDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LaunchPlatform"}},"required":["data"]},"LaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","launch_type","operator","team_owner","user_owner"]}}}} ``` ## The LaunchPlatformInput object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformInput":{"type":"object","description":"Nested input for launch platform: label + type.","properties":{"label":{"type":"string","nullable":true,"maxLength":100},"launch_type":{"type":"string","nullable":true,"maxLength":50}}}}}} ``` ## The LaunchPlatformListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/LaunchPlatform"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"LaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","launch_type","operator","team_owner","user_owner"]}}}} ``` ## The LaunchPlatformLookupLabel object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformLookupLabel":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}}}} ``` ## The LaunchPlatformLookupSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformLookupSuccessResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LaunchPlatformLookupLabel"}}},"required":["data"]},"LaunchPlatformLookupLabel":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}}}} ``` ## The LaunchPlatformUpdateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchPlatformUpdateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LaunchPlatform"}},"required":["data"]},"LaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","launch_type","operator","team_owner","user_owner"]}}}} ``` ## The LaunchType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}}} ``` ## The LaunchTypeListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LaunchTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LaunchType"},"description":"Launch types."}},"required":["data"]},"LaunchType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}}} ``` ## The LocationClustersResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LocationClustersResponse":{"type":"object","properties":{"status":{"type":"string"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"required":["count","data","status"]}}}} ``` ## The LocationMethod object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LocationMethod":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}}} ``` ## The LocationMethodListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LocationMethodListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LocationMethod"},"description":"Location methods."}},"required":["data"]},"LocationMethod":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}}} ``` ## The LocationPointResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LocationPointResponse":{"type":"object","properties":{"status":{"type":"string"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"required":["count","data","status"]}}}} ``` ## The LocationSamplesResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"LocationSamplesResponse":{"type":"object","properties":{"status":{"type":"string"},"count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"required":["count","data","status"]}}}} ``` ## The MaterialRoleType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"MaterialRoleType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"material_role_uri":{"type":"string","nullable":true,"maxLength":255},"scheme_name":{"type":"string","nullable":true,"maxLength":50},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["id","label"]}}}} ``` ## The MaterialStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"MaterialStatisticsResponse":{"type":"object","properties":{"scope":{"type":"string"},"total_samples":{"type":"integer"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/MaterialStatisticsRow"}}},"required":["scope","statistics","total_samples"]},"MaterialStatisticsRow":{"type":"object","properties":{"material_type_id":{"type":"integer","nullable":true},"material_type":{"type":"string"},"count":{"type":"integer"}},"required":["count","material_type","material_type_id"]}}}} ``` ## The MaterialStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"MaterialStatisticsRow":{"type":"object","properties":{"material_type_id":{"type":"integer","nullable":true},"material_type":{"type":"string"},"count":{"type":"integer"}},"required":["count","material_type","material_type_id"]}}}} ``` ## The MaterialType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"MaterialType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"material_type_uri":{"type":"string","nullable":true,"maxLength":255},"parent_material_types":{"type":"array","items":{"type":"string"},"readOnly":true},"source":{"type":"string","nullable":true},"scheme_uri":{"type":"string","nullable":true,"maxLength":255},"for_registration":{"type":"boolean"},"suppress_from_search":{"type":"boolean"}},"required":["for_registration","id","label","parent_material_types","suppress_from_search"]}}}} ``` ## The MaterialTypeHierarchical object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"MaterialTypeHierarchical":{"type":"object","description":"OpenAPI / docs shape for nested material types. Prefer util.build_material_type_tree for responses.","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"material_type_uri":{"type":"string","nullable":true,"maxLength":255},"for_registration":{"type":"boolean"},"suppress_from_search":{"type":"boolean"},"children":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Child material types (same shape, recursive)."}},"required":["children","for_registration","id","label","suppress_from_search"]}}}} ``` ## The MaterialTypeHierarchicalListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"MaterialTypeHierarchicalListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MaterialTypeHierarchical"},"description":"Root material types with nested children."}},"required":["data"]},"MaterialTypeHierarchical":{"type":"object","description":"OpenAPI / docs shape for nested material types. Prefer util.build_material_type_tree for responses.","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"material_type_uri":{"type":"string","nullable":true,"maxLength":255},"for_registration":{"type":"boolean"},"suppress_from_search":{"type":"boolean"},"children":{"type":"array","items":{"type":"object","additionalProperties":{}},"description":"Child material types (same shape, recursive)."}},"required":["children","for_registration","id","label","suppress_from_search"]}}}} ``` ## The MaterialTypeListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"MaterialTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MaterialType"},"description":"Material types."}},"required":["data"]},"MaterialType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"material_type_uri":{"type":"string","nullable":true,"maxLength":255},"parent_material_types":{"type":"array","items":{"type":"string"},"readOnly":true},"source":{"type":"string","nullable":true},"scheme_uri":{"type":"string","nullable":true,"maxLength":255},"for_registration":{"type":"boolean"},"suppress_from_search":{"type":"boolean"}},"required":["for_registration","id","label","parent_material_types","suppress_from_search"]}}}} ``` ## The MetadataStoreStatusEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"MetadataStoreStatusEnum":{"enum":["deactivated-datacite","do-not-register","registered","registered-datacite","registered-datacite-v2","registered-datacite-v3","draft","pending-review","pending-batch-review"],"type":"string","description":"* `deactivated-datacite` - Deactivated (DataCite)\n* `do-not-register` - Do Not Register\n* `registered` - Registered\n* `registered-datacite` - Registered (DataCite)\n* `registered-datacite-v2` - Registered (DataCite v2)\n* `registered-datacite-v3` - Registered (DataCite v3)\n* `draft` - Draft\n* `pending-review` - Pending Review\n* `pending-batch-review` - Pending Batch Review"}}}} ``` ## The NullEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"NullEnum":{"enum":[null]}}}} ``` ## The NumericAgeUnitEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"}}}} ``` ## The ObjectType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ObjectType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"parent_type":{"type":"string","readOnly":true},"scheme_name":{"type":"string","nullable":true,"maxLength":50},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["hierarchical_label","id","label","parent_type"]}}}} ``` ## The ObjectTypeHierarchical object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ObjectTypeHierarchical":{"type":"object","properties":{"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"children":{"type":"string","readOnly":true}},"required":["children","hierarchical_label","label"]}}}} ``` ## The ObjectTypeHierarchicalListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ObjectTypeHierarchicalListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectTypeHierarchical"},"description":"Root object types with nested children."}},"required":["data"]},"ObjectTypeHierarchical":{"type":"object","properties":{"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"children":{"type":"string","readOnly":true}},"required":["children","hierarchical_label","label"]}}}} ``` ## The ObjectTypeListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"ObjectTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ObjectType"},"description":"Object types."}},"required":["data"]},"ObjectType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"hierarchical_label":{"type":"string","readOnly":true},"description":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true,"maxLength":255},"parent_type":{"type":"string","readOnly":true},"scheme_name":{"type":"string","nullable":true,"maxLength":50},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["hierarchical_label","id","label","parent_type"]}}}} ``` ## The PaginatedBatchHistoryListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedBatchHistoryListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BatchHistoryListPagination"}}}},"BatchHistoryListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchHistory"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The PaginatedCompletedBatchHistoryListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedCompletedBatchHistoryListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CompletedBatchHistoryListPagination"}}}},"CompletedBatchHistoryListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchHistory"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The PaginatedInitiativeListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedInitiativeListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/InitiativeListPagination"}}}},"InitiativeListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/Initiative"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"Initiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}},"required":["id","label"]}}}} ``` ## The PaginatedLaunchPlatformListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedLaunchPlatformListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/LaunchPlatformListPagination"}}}},"LaunchPlatformListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/LaunchPlatform"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"LaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","launch_type","operator","team_owner","user_owner"]}}}} ``` ## The PaginatedPendingBatchHistoryListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedPendingBatchHistoryListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PendingBatchHistoryListPagination"}}}},"PendingBatchHistoryListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchHistory"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The PaginatedPendingSampleCurationListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedPendingSampleCurationListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PendingSampleCurationListPagination"}}}},"PendingSampleCurationListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PendingSampleCurationList"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"PendingSampleCurationList":{"type":"object","properties":{"igsn":{"type":"string"},"name":{"type":"string","nullable":true},"sesar_code":{"type":"string","nullable":true},"object_type":{"type":"string","nullable":true},"registration_date":{"type":"string","format":"date-time","nullable":true},"registrant_name":{"type":"string","nullable":true},"team_owner_name":{"type":"string","nullable":true}},"required":["igsn","name","object_type","registrant_name","registration_date","sesar_code","team_owner_name"]}}}} ``` ## The PaginatedPendingSampleDeactivateRequestListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedPendingSampleDeactivateRequestListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PendingSampleDeactivateRequestListPagination"}}}},"PendingSampleDeactivateRequestListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PendingSampleDeactivateRequestList"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"PendingSampleDeactivateRequestList":{"type":"object","properties":{"id":{"type":"integer"},"igsn":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"sesar_code":{"type":"string","nullable":true},"object_type":{"type":"string","nullable":true},"deactivate_reason":{"type":"string","nullable":true},"duplicate_igsns":{"type":"string","nullable":true},"other_reason":{"type":"string","nullable":true},"requested_date":{"type":"string","format":"date-time","nullable":true},"requested_by_name":{"type":"string","nullable":true},"requested_by_email":{"type":"string","nullable":true},"status":{"type":"string"}},"required":["deactivate_reason","duplicate_igsns","id","igsn","name","object_type","other_reason","requested_by_email","requested_by_name","requested_date","sesar_code","status"]}}}} ``` ## The PaginatedPlatformListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedPlatformListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PlatformListPagination"}}}},"PlatformListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/Platform"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}}} ``` ## The PaginatedRelatedResourceListPaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedRelatedResourceListPaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RelatedResourceListPagination"}}}},"RelatedResourceListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/RelatedResource"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"RelatedResource":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","readOnly":true},"uri":{"type":"string","maxLength":255},"uri_type":{"type":"string","maxLength":24},"file_type":{"type":"string","nullable":true,"maxLength":128},"uploaded_date":{"type":"string","format":"date-time"}},"required":["id","label","related_resource_type","uri","uri_type"]}}}} ``` ## The PaginatedSampleListList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedSampleListList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SampleList"}}}},"SampleList":{"type":"object","description":"Map model VariablePrecisionDecimalField columns to serializers that do not\nquantize values to a fixed decimal scale.","properties":{"sample_id":{"type":"integer","readOnly":true},"igsn":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"external_sample_id":{"type":"string","readOnly":true,"nullable":true},"sesar_code":{"type":"string","readOnly":true},"parent_sample":{"type":"string"},"object_type":{"type":"string","readOnly":true},"publish_date":{"type":"string","format":"date-time","readOnly":true},"last_update_date":{"type":"string","format":"date-time","readOnly":true},"size":{"type":"string","readOnly":true,"nullable":true},"general_material_type":{"type":"string","readOnly":true},"sample_material":{"type":"array","items":{"type":"string"},"readOnly":true},"field_name":{"type":"string","readOnly":true},"sample_description":{"type":"string","readOnly":true,"nullable":true},"purpose":{"type":"string","readOnly":true,"nullable":true},"geologic_age_verbatim":{"type":"string","readOnly":true,"nullable":true},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","readOnly":true,"nullable":true},"geologic_age_younger":{"type":"string","readOnly":true},"geologic_age_older":{"type":"string","readOnly":true},"geologic_unit":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"northing":{"type":"string","readOnly":true},"easting":{"type":"string","readOnly":true},"zone":{"type":"string","readOnly":true},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_scale":{"type":"string","readOnly":true,"nullable":true},"vertical_datum":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","readOnly":true},"primary_location_type":{"type":"string","readOnly":true,"nullable":true},"primary_location_name":{"type":"string","readOnly":true,"nullable":true},"location_description":{"type":"string","readOnly":true,"nullable":true},"locality":{"type":"string","readOnly":true,"nullable":true},"locality_description":{"type":"string","readOnly":true,"nullable":true},"country":{"type":"string"},"province":{"type":"string","readOnly":true,"nullable":true},"county":{"type":"string","readOnly":true,"nullable":true},"city":{"type":"string","readOnly":true,"nullable":true},"sampling_method":{"type":"string","readOnly":true},"sampling_method_detail":{"type":"string","readOnly":true,"nullable":true},"cruise_field_prgrm":{"type":"string","readOnly":true},"collectors":{"type":"string","readOnly":true},"platform":{"type":"string","nullable":true,"readOnly":true},"launch_platform":{"type":"string","nullable":true,"readOnly":true},"launch_label":{"type":"string","readOnly":true,"nullable":true},"sampling_start_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_end_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_date_precision":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"other_names":{"type":"string","readOnly":true},"registration_date":{"type":"string","format":"date-time","readOnly":true},"current_archive":{"type":"string","readOnly":true},"original_archive":{"type":"string","readOnly":true},"current_archive_contact":{"type":"string","readOnly":true,"nullable":true},"original_archive_contact":{"type":"string","readOnly":true,"nullable":true},"is_linked":{"type":"boolean","readOnly":true,"default":false},"is_draft":{"type":"string","readOnly":true},"is_pending_review":{"type":"string","readOnly":true}},"required":["age_description","city","collectors","country","county","cruise_field_prgrm","current_archive","current_archive_contact","depth_max","depth_min","depth_scale","easting","elevation","elevation_unit","external_sample_id","field_name","general_material_type","geologic_age_older","geologic_age_verbatim","geologic_age_younger","geologic_unit","igsn","is_draft","is_linked","is_pending_review","last_update_date","latitude","latitude_end","launch_label","launch_platform","locality","locality_description","location_description","location_method","longitude","longitude_end","name","northing","numeric_age_max","numeric_age_min","numeric_age_unit","object_type","original_archive","original_archive_contact","other_names","parent_sample","platform","primary_location_name","primary_location_type","province","publish_date","purpose","registration_date","sample_description","sample_id","sample_material","sampling_date_precision","sampling_end_date","sampling_method","sampling_method_detail","sampling_start_date","sesar_code","size","vertical_datum","zone"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"}}}} ``` ## The PaginatedSampleTablePaginationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PaginatedSampleTablePaginationList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SampleTablePagination"}}}},"SampleTablePagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"rows":{"type":"array","items":{"$ref":"#/components/schemas/SampleList"}},"columns":{"type":"array","items":{"$ref":"#/components/schemas/SampleTablePaginationColumn"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["columns","count","rows"]},"SampleList":{"type":"object","description":"Map model VariablePrecisionDecimalField columns to serializers that do not\nquantize values to a fixed decimal scale.","properties":{"sample_id":{"type":"integer","readOnly":true},"igsn":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"external_sample_id":{"type":"string","readOnly":true,"nullable":true},"sesar_code":{"type":"string","readOnly":true},"parent_sample":{"type":"string"},"object_type":{"type":"string","readOnly":true},"publish_date":{"type":"string","format":"date-time","readOnly":true},"last_update_date":{"type":"string","format":"date-time","readOnly":true},"size":{"type":"string","readOnly":true,"nullable":true},"general_material_type":{"type":"string","readOnly":true},"sample_material":{"type":"array","items":{"type":"string"},"readOnly":true},"field_name":{"type":"string","readOnly":true},"sample_description":{"type":"string","readOnly":true,"nullable":true},"purpose":{"type":"string","readOnly":true,"nullable":true},"geologic_age_verbatim":{"type":"string","readOnly":true,"nullable":true},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","readOnly":true,"nullable":true},"geologic_age_younger":{"type":"string","readOnly":true},"geologic_age_older":{"type":"string","readOnly":true},"geologic_unit":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"northing":{"type":"string","readOnly":true},"easting":{"type":"string","readOnly":true},"zone":{"type":"string","readOnly":true},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_scale":{"type":"string","readOnly":true,"nullable":true},"vertical_datum":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","readOnly":true},"primary_location_type":{"type":"string","readOnly":true,"nullable":true},"primary_location_name":{"type":"string","readOnly":true,"nullable":true},"location_description":{"type":"string","readOnly":true,"nullable":true},"locality":{"type":"string","readOnly":true,"nullable":true},"locality_description":{"type":"string","readOnly":true,"nullable":true},"country":{"type":"string"},"province":{"type":"string","readOnly":true,"nullable":true},"county":{"type":"string","readOnly":true,"nullable":true},"city":{"type":"string","readOnly":true,"nullable":true},"sampling_method":{"type":"string","readOnly":true},"sampling_method_detail":{"type":"string","readOnly":true,"nullable":true},"cruise_field_prgrm":{"type":"string","readOnly":true},"collectors":{"type":"string","readOnly":true},"platform":{"type":"string","nullable":true,"readOnly":true},"launch_platform":{"type":"string","nullable":true,"readOnly":true},"launch_label":{"type":"string","readOnly":true,"nullable":true},"sampling_start_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_end_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_date_precision":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"other_names":{"type":"string","readOnly":true},"registration_date":{"type":"string","format":"date-time","readOnly":true},"current_archive":{"type":"string","readOnly":true},"original_archive":{"type":"string","readOnly":true},"current_archive_contact":{"type":"string","readOnly":true,"nullable":true},"original_archive_contact":{"type":"string","readOnly":true,"nullable":true},"is_linked":{"type":"boolean","readOnly":true,"default":false},"is_draft":{"type":"string","readOnly":true},"is_pending_review":{"type":"string","readOnly":true}},"required":["age_description","city","collectors","country","county","cruise_field_prgrm","current_archive","current_archive_contact","depth_max","depth_min","depth_scale","easting","elevation","elevation_unit","external_sample_id","field_name","general_material_type","geologic_age_older","geologic_age_verbatim","geologic_age_younger","geologic_unit","igsn","is_draft","is_linked","is_pending_review","last_update_date","latitude","latitude_end","launch_label","launch_platform","locality","locality_description","location_description","location_method","longitude","longitude_end","name","northing","numeric_age_max","numeric_age_min","numeric_age_unit","object_type","original_archive","original_archive_contact","other_names","parent_sample","platform","primary_location_name","primary_location_type","province","publish_date","purpose","registration_date","sample_description","sample_id","sample_material","sampling_date_precision","sampling_end_date","sampling_method","sampling_method_detail","sampling_start_date","sesar_code","size","vertical_datum","zone"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"},"SampleTablePaginationColumn":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"}},"required":["field","type"]}}}} ``` ## The PatchedBatchTemplateWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedBatchTemplateWrite":{"type":"object","properties":{"label":{"type":"string","maxLength":255},"sesar_code":{"type":"string","nullable":true},"object_type":{"type":"integer","nullable":true},"is_archived":{"type":"boolean","default":false},"selected_fields":{},"cruise_field_prgrms":{},"platforms":{},"launch_platforms":{},"current_archives":{},"original_archives":{},"collectors":{}}}}}} ``` ## The PatchedIndividualUpdate object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedIndividualUpdate":{"type":"object","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","readOnly":true},"country":{"type":"string","nullable":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The PatchedInitiative object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedInitiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}}}}}} ``` ## The PatchedInstitutionWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedInstitutionWrite":{"type":"object","properties":{"institution_type":{"type":"string","nullable":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"array","items":{"type":"integer","writeOnly":true},"writeOnly":true},"created_by":{"type":"integer","nullable":true}}}}}} ``` ## The PatchedLaunchPlatform object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedLaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}}}}}} ``` ## The PatchedPlatform object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}}}}}} ``` ## The PatchedRelatedResourceWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedRelatedResourceWrite":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true},"uri_type":{"type":"string","nullable":true},"file_type":{"type":"string","nullable":true,"maxLength":128},"file_size":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"uploaded_date":{"type":"string","format":"date-time"},"uploaded_by":{"type":"integer","readOnly":true,"nullable":true},"uploaded_by_team":{"type":"integer","nullable":true},"file":{"type":"string","format":"uri","writeOnly":true,"nullable":true}}}}}} ``` ## The PatchedSampleGroupWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedSampleGroupWrite":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","nullable":true},"group_type":{"type":"string"},"user_owner":{"type":"string","nullable":true},"team_owner":{"type":"string","nullable":true},"created_date":{"type":"string","format":"date-time"},"is_private":{"type":"boolean"}}}}}} ``` ## The PatchedSampleUpdate object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedSampleUpdate":{"type":"object","description":"Sample registration payload. Prefer nested label-based objects (e.g. platform, launch_platform, collectors with individual/institution) over optional internal primary-key shortcuts, which remain accepted by the API.","properties":{"igsn":{"type":"string","readOnly":true},"name":{"type":"string","maxLength":255},"external_sample_id":{"type":"string","nullable":true,"maxLength":100},"sesar_code":{"type":"string","readOnly":true},"team":{"type":"string","readOnly":true},"object_type":{"type":"string"},"general_material_type":{"type":"string","nullable":true},"field_name":{"type":"string","nullable":true,"maxLength":255},"sample_description":{"type":"string","nullable":true},"size":{"type":"string","nullable":true,"maxLength":255},"size_unit":{"type":"string","nullable":true,"maxLength":255},"purpose":{"type":"string","nullable":true,"maxLength":500},"parent_sample":{"type":"string","nullable":true},"external_parent_name":{"type":"string","nullable":true,"maxLength":1000},"external_parent_object_type":{"type":"string","nullable":true},"geologic_age_verbatim":{"type":"string","nullable":true,"maxLength":500},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"numeric_age_unit":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","nullable":true,"maxLength":1000},"geologic_unit":{"type":"string","nullable":true,"maxLength":500},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"northing":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","writeOnly":true,"nullable":true},"easting":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","writeOnly":true,"nullable":true},"zone":{"type":"string","writeOnly":true,"nullable":true,"maxLength":32},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"depth_scale":{"type":"string","nullable":true,"maxLength":255},"vertical_datum":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"elevation_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"elevation_unit":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","nullable":true},"primary_location_type":{"type":"string","nullable":true,"maxLength":255},"primary_location_name":{"type":"string","nullable":true,"maxLength":1000},"location_description":{"type":"string","nullable":true,"maxLength":2000},"locality":{"type":"string","nullable":true,"maxLength":255},"locality_description":{"type":"string","nullable":true,"maxLength":2000},"country":{"type":"string","nullable":true},"province":{"type":"string","nullable":true,"maxLength":255},"county":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"sampling_method":{"type":"string","nullable":true,"description":"Sampling method label. Matched case-insensitively against existing vocabulary."},"sampling_method_detail":{"type":"string","nullable":true,"maxLength":1000},"cruise_field_prgrm":{"type":"string","nullable":true,"description":"Initiative label. Matched against owner's existing initiatives, created if new."},"platform":{"allOf":[{"$ref":"#/components/schemas/PlatformInput"}],"writeOnly":true,"nullable":true},"launch_platform":{"allOf":[{"$ref":"#/components/schemas/LaunchPlatformInput"}],"writeOnly":true,"nullable":true},"launch_label":{"type":"string","nullable":true,"maxLength":100},"sampling_start_date":{"type":"string","format":"date-time","nullable":true},"sampling_end_date":{"type":"string","format":"date-time","nullable":true},"sampling_date_precision":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"publish_date":{"type":"string","format":"date-time"},"registration_date":{"type":"string","format":"date-time","readOnly":true},"availability":{"type":"boolean","nullable":true},"storage_location":{"type":"string","nullable":true,"maxLength":255},"personal_collection_storage_location":{"type":"string","writeOnly":true,"nullable":true,"description":"Personal collection / storage location (alias for storage_location).","maxLength":255},"is_draft":{"type":"boolean","writeOnly":true,"description":"Set true to save as draft. Internal status is derived automatically."},"batch_history":{"type":"integer","writeOnly":true,"nullable":true,"description":"Optional batch history to add the created sample to (e.g. mint child from a batch detail page)."},"other_names":{"type":"array","items":{"type":"string","maxLength":255},"writeOnly":true},"material_types":{"type":"array","items":{"type":"string","maxLength":50},"writeOnly":true,"description":"List of material type labels"},"collectors":{"type":"array","items":{"$ref":"#/components/schemas/CollectorInput"},"writeOnly":true},"current_archive":{"allOf":[{"$ref":"#/components/schemas/ArchiveInput"}],"writeOnly":true,"nullable":true},"original_archive":{"allOf":[{"$ref":"#/components/schemas/ArchiveInput"}],"writeOnly":true,"nullable":true},"current_archive_id":{"type":"integer","writeOnly":true,"nullable":true},"original_archive_id":{"type":"integer","writeOnly":true,"nullable":true},"current_archive_contact":{"type":"string","nullable":true,"maxLength":1000},"original_archive_contact":{"type":"string","nullable":true,"maxLength":1000},"related_resources":{"type":"array","items":{"type":"integer","writeOnly":true},"writeOnly":true,"description":"IDs of publications, datasets, and other related resources to link. On update, replaces non-Image links; Image links are preserved. Omit on update to leave links unchanged."}}},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"BlankEnum":{"enum":[""]},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"PlatformInput":{"type":"object","description":"Nested input for platform: label + type.","properties":{"label":{"type":"string","nullable":true,"maxLength":100},"platform_type":{"type":"string","nullable":true,"maxLength":50},"description":{"type":"string","nullable":true}}},"LaunchPlatformInput":{"type":"object","description":"Nested input for launch platform: label + type.","properties":{"label":{"type":"string","nullable":true,"maxLength":100},"launch_type":{"type":"string","nullable":true,"maxLength":50}}},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"},"CollectorInput":{"type":"object","description":"Collector reference (id or inline individual/institution payload).","properties":{"description":{"type":"string","nullable":true},"individual":{"allOf":[{"$ref":"#/components/schemas/CollectorIndividualInput"}],"nullable":true},"institution":{"allOf":[{"$ref":"#/components/schemas/CollectorInstitutionInput"}],"nullable":true}}},"CollectorIndividualInput":{"type":"object","description":"Inline individual payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"individual_uri":{"type":"string","nullable":true,"maxLength":255}}},"CollectorInstitutionInput":{"type":"object","description":"Inline institution payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"ror":{"type":"string","nullable":true,"maxLength":25},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true}}},"ArchiveInput":{"type":"object","description":"Inline archive payload for create-or-match by label.","properties":{"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":25}},"required":["label"]}}}} ``` ## The PatchedSesarUserWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PatchedSesarUserWrite":{"type":"object","properties":{"individual":{"$ref":"#/components/schemas/IndividualUpdate"},"email":{"type":"string"},"notification_preferences":{}}},"IndividualUpdate":{"type":"object","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","readOnly":true},"country":{"type":"string","nullable":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"type":"integer"}}},"required":["individual_uri"]}}}} ``` ## The PendingBatchHistoryListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PendingBatchHistoryListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchHistory"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"BatchHistory":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"batch_type":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"sample_count":{"type":"integer","readOnly":true,"nullable":true},"upload_time":{"type":"string","format":"date-time","readOnly":true},"processed_time":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"filename":{"type":"string","nullable":true,"readOnly":true},"object_type":{"type":"string","nullable":true,"description":"Resolve object type only from already-prefetched samples.\n\nList endpoints intentionally skip this (M2M lookup is expensive). Detail\nviews prefetch samples when they need the value.","readOnly":true},"uploaded_by_name":{"type":"string","nullable":true,"readOnly":true},"team_owner_name":{"type":"string","nullable":true,"readOnly":true},"owner_name":{"type":"string","nullable":true,"readOnly":true},"user_owner_id":{"type":"integer","nullable":true,"readOnly":true},"team_owner_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["batch_type","filename","id","object_type","owner_name","processed_time","sample_count","sesar_code","team_owner_id","team_owner_name","upload_time","uploaded_by_name","user_owner_id"]}}}} ``` ## The PendingSampleCurationList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PendingSampleCurationList":{"type":"object","properties":{"igsn":{"type":"string"},"name":{"type":"string","nullable":true},"sesar_code":{"type":"string","nullable":true},"object_type":{"type":"string","nullable":true},"registration_date":{"type":"string","format":"date-time","nullable":true},"registrant_name":{"type":"string","nullable":true},"team_owner_name":{"type":"string","nullable":true}},"required":["igsn","name","object_type","registrant_name","registration_date","sesar_code","team_owner_name"]}}}} ``` ## The PendingSampleCurationListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PendingSampleCurationListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PendingSampleCurationList"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"PendingSampleCurationList":{"type":"object","properties":{"igsn":{"type":"string"},"name":{"type":"string","nullable":true},"sesar_code":{"type":"string","nullable":true},"object_type":{"type":"string","nullable":true},"registration_date":{"type":"string","format":"date-time","nullable":true},"registrant_name":{"type":"string","nullable":true},"team_owner_name":{"type":"string","nullable":true}},"required":["igsn","name","object_type","registrant_name","registration_date","sesar_code","team_owner_name"]}}}} ``` ## The PendingSampleDeactivateRequestList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PendingSampleDeactivateRequestList":{"type":"object","properties":{"id":{"type":"integer"},"igsn":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"sesar_code":{"type":"string","nullable":true},"object_type":{"type":"string","nullable":true},"deactivate_reason":{"type":"string","nullable":true},"duplicate_igsns":{"type":"string","nullable":true},"other_reason":{"type":"string","nullable":true},"requested_date":{"type":"string","format":"date-time","nullable":true},"requested_by_name":{"type":"string","nullable":true},"requested_by_email":{"type":"string","nullable":true},"status":{"type":"string"}},"required":["deactivate_reason","duplicate_igsns","id","igsn","name","object_type","other_reason","requested_by_email","requested_by_name","requested_date","sesar_code","status"]}}}} ``` ## The PendingSampleDeactivateRequestListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PendingSampleDeactivateRequestListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PendingSampleDeactivateRequestList"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"PendingSampleDeactivateRequestList":{"type":"object","properties":{"id":{"type":"integer"},"igsn":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"sesar_code":{"type":"string","nullable":true},"object_type":{"type":"string","nullable":true},"deactivate_reason":{"type":"string","nullable":true},"duplicate_igsns":{"type":"string","nullable":true},"other_reason":{"type":"string","nullable":true},"requested_date":{"type":"string","format":"date-time","nullable":true},"requested_by_name":{"type":"string","nullable":true},"requested_by_email":{"type":"string","nullable":true},"status":{"type":"string"}},"required":["deactivate_reason","duplicate_igsns","id","igsn","name","object_type","other_reason","requested_by_email","requested_by_name","requested_date","sesar_code","status"]}}}} ``` ## The Platform object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}}} ``` ## The PlatformCreateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformCreateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Platform"}},"required":["data"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}}} ``` ## The PlatformDeleteSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The PlatformDeleteSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformDeleteSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PlatformDeleteSuccessData"}},"required":["data"]},"PlatformDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The PlatformDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Platform"}},"required":["data"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}}} ``` ## The PlatformInput object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformInput":{"type":"object","description":"Nested input for platform: label + type.","properties":{"label":{"type":"string","nullable":true,"maxLength":100},"platform_type":{"type":"string","nullable":true,"maxLength":50},"description":{"type":"string","nullable":true}}}}}} ``` ## The PlatformListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/Platform"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}}} ``` ## The PlatformLookupLabel object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformLookupLabel":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}}}} ``` ## The PlatformLookupSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformLookupSuccessResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PlatformLookupLabel"}}},"required":["data"]},"PlatformLookupLabel":{"type":"object","properties":{"label":{"type":"string"}},"required":["label"]}}}} ``` ## The PlatformType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}}} ``` ## The PlatformTypeListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PlatformType"},"description":"Platform types."}},"required":["data"]},"PlatformType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]}}}} ``` ## The PlatformUpdateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PlatformUpdateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Platform"}},"required":["data"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]}}}} ``` ## The PropertyType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"PropertyType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"property_uri":{"type":"string","nullable":true,"maxLength":255},"source":{"type":"string","nullable":true},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["id","label"]}}}} ``` ## The RelatedResource object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResource":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","readOnly":true},"uri":{"type":"string","maxLength":255},"uri_type":{"type":"string","maxLength":24},"file_type":{"type":"string","nullable":true,"maxLength":128},"uploaded_date":{"type":"string","format":"date-time"}},"required":["id","label","related_resource_type","uri","uri_type"]}}}} ``` ## The RelatedResourceCreateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceCreateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RelatedResource"}},"required":["data"]},"RelatedResource":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","readOnly":true},"uri":{"type":"string","maxLength":255},"uri_type":{"type":"string","maxLength":24},"file_type":{"type":"string","nullable":true,"maxLength":128},"uploaded_date":{"type":"string","format":"date-time"}},"required":["id","label","related_resource_type","uri","uri_type"]}}}} ``` ## The RelatedResourceDeleteSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The RelatedResourceDeleteSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceDeleteSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RelatedResourceDeleteSuccessData"}},"required":["data"]},"RelatedResourceDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The RelatedResourceDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RelatedResource"}},"required":["data"]},"RelatedResource":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","readOnly":true},"uri":{"type":"string","maxLength":255},"uri_type":{"type":"string","maxLength":24},"file_type":{"type":"string","nullable":true,"maxLength":128},"uploaded_date":{"type":"string","format":"date-time"}},"required":["id","label","related_resource_type","uri","uri_type"]}}}} ``` ## The RelatedResourceListPagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceListPagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/RelatedResource"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["count","data"]},"RelatedResource":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","readOnly":true},"uri":{"type":"string","maxLength":255},"uri_type":{"type":"string","maxLength":24},"file_type":{"type":"string","nullable":true,"maxLength":128},"uploaded_date":{"type":"string","format":"date-time"}},"required":["id","label","related_resource_type","uri","uri_type"]}}}} ``` ## The RelatedResourceSampleActionRequest object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceSampleActionRequest":{"type":"object","properties":{"sample_ids":{"type":"array","items":{"type":"integer"},"description":"Sample primary keys to link or unlink."},"select_all":{"type":"boolean","default":false,"description":"When true, apply `filters` to resolve samples instead of `sample_ids`."},"filters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sample list filters (same as sample list API) when `select_all` is true."}}}}}} ``` ## The RelatedResourceSampleActionSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceSampleActionSuccessData":{"type":"object","properties":{"message":{"type":"string"},"count":{"type":"integer"}},"required":["count","message"]}}}} ``` ## The RelatedResourceSampleActionSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceSampleActionSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RelatedResourceSampleActionSuccessData"}},"required":["data"]},"RelatedResourceSampleActionSuccessData":{"type":"object","properties":{"message":{"type":"string"},"count":{"type":"integer"}},"required":["count","message"]}}}} ``` ## The RelatedResourceType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":100},"description":{"type":"string","nullable":true},"resource_type_uri":{"type":"string","nullable":true,"maxLength":255},"broader_type":{"type":"integer","nullable":true},"broader_type_label":{"type":"string","readOnly":true,"description":"Label of the broader resource type"},"source":{"type":"string","nullable":true},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["broader_type_label","id","label"]}}}} ``` ## The RelatedResourceTypeListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceTypeListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RelatedResourceType"},"description":"Related resource types."}},"required":["data"]},"RelatedResourceType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":100},"description":{"type":"string","nullable":true},"resource_type_uri":{"type":"string","nullable":true,"maxLength":255},"broader_type":{"type":"integer","nullable":true},"broader_type_label":{"type":"string","readOnly":true,"description":"Label of the broader resource type"},"source":{"type":"string","nullable":true},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["broader_type_label","id","label"]}}}} ``` ## The RelatedResourceUpdateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceUpdateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RelatedResource"}},"required":["data"]},"RelatedResource":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","readOnly":true},"uri":{"type":"string","maxLength":255},"uri_type":{"type":"string","maxLength":24},"file_type":{"type":"string","nullable":true,"maxLength":128},"uploaded_date":{"type":"string","format":"date-time"}},"required":["id","label","related_resource_type","uri","uri_type"]}}}} ``` ## The RelatedResourceWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RelatedResourceWrite":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true},"uri_type":{"type":"string","nullable":true},"file_type":{"type":"string","nullable":true,"maxLength":128},"file_size":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"uploaded_date":{"type":"string","format":"date-time"},"uploaded_by":{"type":"integer","readOnly":true,"nullable":true},"uploaded_by_team":{"type":"integer","nullable":true},"file":{"type":"string","format":"uri","writeOnly":true,"nullable":true}},"required":["id","label","uploaded_by"]}}}} ``` ## The RockMaterialStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RockMaterialStatisticsResponse":{"type":"object","properties":{"scope":{"type":"string"},"total_samples":{"type":"integer"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/RockMaterialStatisticsRow"}}},"required":["scope","statistics","total_samples"]},"RockMaterialStatisticsRow":{"type":"object","properties":{"material_type":{"type":"string"},"count":{"type":"integer"}},"required":["count","material_type"]}}}} ``` ## The RockMaterialStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"RockMaterialStatisticsRow":{"type":"object","properties":{"material_type":{"type":"string"},"count":{"type":"integer"}},"required":["count","material_type"]}}}} ``` ## The SampleBulkUpdateApplyRequest object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleBulkUpdateApplyRequest":{"type":"object","properties":{"value":{"nullable":true,"description":"New value for the field. Use null (or omit with clear=true) to clear. For linked entities, send the entity primary key. For vocab slug fields (country, object_type, etc.), send the label string."},"clear":{"type":"boolean","default":false,"description":"When true, clear the field (value treated as null)."}}}}}} ``` ## The SampleBulkUpdatePreviewRequest object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleBulkUpdatePreviewRequest":{"type":"object","properties":{"sample_ids":{"type":"array","items":{"type":"integer"},"description":"Sample primary keys when select_all is false."},"select_all":{"type":"boolean","default":false,"description":"When true, apply filters instead of sample_ids."},"filters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sample list filters when select_all is true."},"field":{"type":"string","description":"Bulk-updatable field key (see GET fields list)."}},"required":["field"]}}}} ``` ## The SampleCreate object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleCreate":{"type":"object","description":"Sample registration payload. Prefer nested label-based objects (e.g. platform, launch_platform, collectors with individual/institution) over optional internal primary-key shortcuts, which remain accepted by the API.","properties":{"igsn":{"type":"string","maxLength":60},"name":{"type":"string","maxLength":255},"external_sample_id":{"type":"string","nullable":true,"maxLength":100},"sesar_code":{"type":"string","nullable":true},"team":{"type":"string","writeOnly":true,"nullable":true,"description":"Team name for custom DOI prefix registration (no sesar_code needed)."},"object_type":{"type":"string"},"general_material_type":{"type":"string","nullable":true},"field_name":{"type":"string","nullable":true,"maxLength":255},"sample_description":{"type":"string","nullable":true},"size":{"type":"string","nullable":true,"maxLength":255},"size_unit":{"type":"string","nullable":true,"maxLength":255},"purpose":{"type":"string","nullable":true,"maxLength":500},"parent_sample":{"type":"string","nullable":true},"external_parent_name":{"type":"string","nullable":true,"maxLength":1000},"external_parent_object_type":{"type":"string","nullable":true},"geologic_age_verbatim":{"type":"string","nullable":true,"maxLength":500},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"numeric_age_unit":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","nullable":true,"maxLength":1000},"geologic_unit":{"type":"string","nullable":true,"maxLength":500},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"northing":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","writeOnly":true,"nullable":true},"easting":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","writeOnly":true,"nullable":true},"zone":{"type":"string","writeOnly":true,"nullable":true,"maxLength":32},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"depth_scale":{"type":"string","nullable":true,"maxLength":255},"vertical_datum":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"elevation_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"elevation_unit":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","nullable":true},"primary_location_type":{"type":"string","nullable":true,"maxLength":255},"primary_location_name":{"type":"string","nullable":true,"maxLength":1000},"location_description":{"type":"string","nullable":true,"maxLength":2000},"locality":{"type":"string","nullable":true,"maxLength":255},"locality_description":{"type":"string","nullable":true,"maxLength":2000},"country":{"type":"string","nullable":true},"province":{"type":"string","nullable":true,"maxLength":255},"county":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"sampling_method":{"type":"string","nullable":true,"description":"Sampling method label. Matched case-insensitively against existing vocabulary."},"sampling_method_detail":{"type":"string","nullable":true,"maxLength":1000},"cruise_field_prgrm":{"type":"string","nullable":true,"description":"Initiative label. Matched against owner's existing initiatives, created if new."},"platform":{"allOf":[{"$ref":"#/components/schemas/PlatformInput"}],"writeOnly":true,"nullable":true},"launch_platform":{"allOf":[{"$ref":"#/components/schemas/LaunchPlatformInput"}],"writeOnly":true,"nullable":true},"launch_label":{"type":"string","nullable":true,"maxLength":100},"sampling_start_date":{"type":"string","format":"date-time","nullable":true},"sampling_end_date":{"type":"string","format":"date-time","nullable":true},"sampling_date_precision":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"publish_date":{"type":"string","format":"date-time"},"registration_date":{"type":"string","format":"date-time","readOnly":true},"availability":{"type":"boolean","nullable":true},"storage_location":{"type":"string","nullable":true,"maxLength":255},"personal_collection_storage_location":{"type":"string","writeOnly":true,"nullable":true,"description":"Personal collection / storage location (alias for storage_location).","maxLength":255},"is_draft":{"type":"boolean","writeOnly":true,"description":"Set true to save as draft. Internal status is derived automatically."},"batch_history":{"type":"integer","writeOnly":true,"nullable":true,"description":"Optional batch history to add the created sample to (e.g. mint child from a batch detail page)."},"other_names":{"type":"array","items":{"type":"string","maxLength":255},"writeOnly":true},"material_types":{"type":"array","items":{"type":"string","maxLength":50},"writeOnly":true,"description":"List of material type labels"},"collectors":{"type":"array","items":{"$ref":"#/components/schemas/CollectorInput"},"writeOnly":true},"current_archive":{"allOf":[{"$ref":"#/components/schemas/ArchiveInput"}],"writeOnly":true,"nullable":true},"original_archive":{"allOf":[{"$ref":"#/components/schemas/ArchiveInput"}],"writeOnly":true,"nullable":true},"current_archive_id":{"type":"integer","writeOnly":true,"nullable":true},"original_archive_id":{"type":"integer","writeOnly":true,"nullable":true},"current_archive_contact":{"type":"string","nullable":true,"maxLength":1000},"original_archive_contact":{"type":"string","nullable":true,"maxLength":1000},"related_resources":{"type":"array","items":{"type":"integer","writeOnly":true},"writeOnly":true,"description":"IDs of publications, datasets, and other related resources to link. On update, replaces non-Image links; Image links are preserved. Omit on update to leave links unchanged."}},"required":["name","object_type","registration_date"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"BlankEnum":{"enum":[""]},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"PlatformInput":{"type":"object","description":"Nested input for platform: label + type.","properties":{"label":{"type":"string","nullable":true,"maxLength":100},"platform_type":{"type":"string","nullable":true,"maxLength":50},"description":{"type":"string","nullable":true}}},"LaunchPlatformInput":{"type":"object","description":"Nested input for launch platform: label + type.","properties":{"label":{"type":"string","nullable":true,"maxLength":100},"launch_type":{"type":"string","nullable":true,"maxLength":50}}},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"},"CollectorInput":{"type":"object","description":"Collector reference (id or inline individual/institution payload).","properties":{"description":{"type":"string","nullable":true},"individual":{"allOf":[{"$ref":"#/components/schemas/CollectorIndividualInput"}],"nullable":true},"institution":{"allOf":[{"$ref":"#/components/schemas/CollectorInstitutionInput"}],"nullable":true}}},"CollectorIndividualInput":{"type":"object","description":"Inline individual payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"individual_uri":{"type":"string","nullable":true,"maxLength":255}}},"CollectorInstitutionInput":{"type":"object","description":"Inline institution payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"ror":{"type":"string","nullable":true,"maxLength":25},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true}}},"ArchiveInput":{"type":"object","description":"Inline archive payload for create-or-match by label.","properties":{"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":25}},"required":["label"]}}}} ``` ## The SampleCurationAcceptSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleCurationAcceptSuccessData":{"type":"object","properties":{"igsn":{"type":"string"}},"required":["igsn"]}}}} ``` ## The SampleCurationAcceptSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleCurationAcceptSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleCurationAcceptSuccessData"}},"required":["data"]},"SampleCurationAcceptSuccessData":{"type":"object","properties":{"igsn":{"type":"string"}},"required":["igsn"]}}}} ``` ## The SampleCurationDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleCurationDetailSuccessResponse":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{}}},"required":["data"]}}}} ``` ## The SampleCurationFeedback object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleCurationFeedback":{"type":"object","properties":{"feedback":{"type":"string","maxLength":10000}},"required":["feedback"]}}}} ``` ## The SampleCurationFeedbackSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleCurationFeedbackSuccessData":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The SampleCurationFeedbackSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleCurationFeedbackSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleCurationFeedbackSuccessData"}},"required":["data"]},"SampleCurationFeedbackSuccessData":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The SampleDeactivate object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDeactivate":{"type":"object","properties":{"deactivate_reason":{"$ref":"#/components/schemas/DeactivateReasonEnum"},"duplicate_igsns":{"type":"string","maxLength":1000},"other_reason":{"type":"string","maxLength":250}},"required":["deactivate_reason"]},"DeactivateReasonEnum":{"enum":["this was a test sample","this sample does not exist","duplicate igsn","other"],"type":"string","description":"* `this was a test sample` - this was a test sample\n* `this sample does not exist` - this sample does not exist\n* `duplicate igsn` - duplicate igsn\n* `other` - other"}}}} ``` ## The SampleDeactivateApproveSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDeactivateApproveSuccessData":{"type":"object","properties":{"id":{"type":"integer"},"igsn":{"type":"string"},"status":{"type":"string"}},"required":["id","igsn","status"]}}}} ``` ## The SampleDeactivateApproveSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDeactivateApproveSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleDeactivateApproveSuccessData"}},"required":["data"]},"SampleDeactivateApproveSuccessData":{"type":"object","properties":{"id":{"type":"integer"},"igsn":{"type":"string"},"status":{"type":"string"}},"required":["id","igsn","status"]}}}} ``` ## The SampleDeactivateDeny object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDeactivateDeny":{"type":"object","properties":{"denial_reason":{"type":"string","maxLength":2000}},"required":["denial_reason"]}}}} ``` ## The SampleDeactivateDenySuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDeactivateDenySuccessData":{"type":"object","properties":{"id":{"type":"integer"},"igsn":{"type":"string"},"status":{"type":"string"}},"required":["id","igsn","status"]}}}} ``` ## The SampleDeactivateDenySuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDeactivateDenySuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleDeactivateDenySuccessData"}},"required":["data"]},"SampleDeactivateDenySuccessData":{"type":"object","properties":{"id":{"type":"integer"},"igsn":{"type":"string"},"status":{"type":"string"}},"required":["id","igsn","status"]}}}} ``` ## The SampleDeactivateSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDeactivateSuccessData":{"type":"object","properties":{"igsn":{"type":"string"}},"required":["igsn"]}}}} ``` ## The SampleDeactivateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDeactivateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleDeactivateSuccessData"}},"required":["data"]},"SampleDeactivateSuccessData":{"type":"object","properties":{"igsn":{"type":"string"}},"required":["igsn"]}}}} ``` ## The SampleDetail object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDetail":{"type":"object","description":"Read-only sample metadata aligned with registration/create payload shape\n(labels for vocabulary FKs, IDs where the create API accepts *_id fields).","properties":{"igsn":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"team_id":{"type":"integer","readOnly":true,"nullable":true},"owner_display":{"type":"string","readOnly":true},"object_type":{"type":"string","readOnly":true},"general_material_type":{"type":"string","readOnly":true},"field_name":{"type":"string","readOnly":true},"sample_description":{"type":"string","readOnly":true,"nullable":true},"size":{"type":"string","readOnly":true,"nullable":true},"size_unit":{"type":"string","readOnly":true,"nullable":true},"purpose":{"type":"string","readOnly":true,"nullable":true},"parent_sample":{"type":"string","readOnly":true},"external_parent_name":{"type":"string","readOnly":true,"nullable":true},"external_parent_object_type":{"type":"string","readOnly":true},"geologic_age_verbatim":{"type":"string","readOnly":true,"nullable":true},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","readOnly":true,"nullable":true},"geologic_unit":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"northing":{"type":"string","readOnly":true},"easting":{"type":"string","readOnly":true},"zone":{"type":"string","readOnly":true},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_scale":{"type":"string","readOnly":true,"nullable":true},"vertical_datum":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","readOnly":true},"primary_location_type":{"type":"string","readOnly":true,"nullable":true},"primary_location_name":{"type":"string","readOnly":true,"nullable":true},"location_description":{"type":"string","readOnly":true,"nullable":true},"locality":{"type":"string","readOnly":true,"nullable":true},"locality_description":{"type":"string","readOnly":true,"nullable":true},"country":{"type":"string","readOnly":true},"province":{"type":"string","readOnly":true,"nullable":true},"county":{"type":"string","readOnly":true,"nullable":true},"city":{"type":"string","readOnly":true,"nullable":true},"sampling_method":{"type":"string","readOnly":true},"sampling_method_detail":{"type":"string","readOnly":true,"nullable":true},"cruise_field_prgrm":{"type":"string","readOnly":true},"cruise_field_prgrm_id":{"type":"integer","readOnly":true,"nullable":true},"platform":{"allOf":[{"$ref":"#/components/schemas/Platform"}],"readOnly":true},"platform_id":{"type":"integer","readOnly":true,"nullable":true},"launch_platform":{"allOf":[{"$ref":"#/components/schemas/LaunchPlatform"}],"readOnly":true},"launch_platform_id":{"type":"integer","readOnly":true,"nullable":true},"launch_label":{"type":"string","readOnly":true,"nullable":true},"sampling_start_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_end_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_date_precision":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"publish_date":{"type":"string","format":"date-time","readOnly":true},"registration_date":{"type":"string","format":"date-time","readOnly":true},"availability":{"type":"boolean","readOnly":true,"nullable":true},"storage_location":{"type":"string","readOnly":true,"nullable":true},"metadata_store_status":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/MetadataStoreStatusEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"is_draft":{"type":"string","readOnly":true},"is_pending_review":{"type":"string","readOnly":true},"batch_history_id":{"type":"string","readOnly":true},"other_names":{"type":"string","readOnly":true},"material_types":{"type":"string","readOnly":true},"collectors":{"type":"string","readOnly":true},"current_archive":{"allOf":[{"$ref":"#/components/schemas/Archive"}],"readOnly":true},"original_archive":{"allOf":[{"$ref":"#/components/schemas/Archive"}],"readOnly":true},"current_archive_contact":{"type":"string","readOnly":true,"nullable":true},"original_archive_contact":{"type":"string","readOnly":true,"nullable":true},"initiative":{"allOf":[{"$ref":"#/components/schemas/Initiative"}],"readOnly":true},"related_resources":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"can_deactivate":{"type":"string","readOnly":true}},"required":["age_description","availability","batch_history_id","can_deactivate","can_edit","city","collectors","country","county","cruise_field_prgrm","cruise_field_prgrm_id","current_archive","current_archive_contact","depth_max","depth_min","depth_scale","easting","elevation","elevation_end","elevation_unit","external_parent_name","external_parent_object_type","field_name","general_material_type","geologic_age_verbatim","geologic_unit","igsn","initiative","is_draft","is_pending_review","latitude","latitude_end","launch_label","launch_platform","launch_platform_id","locality","locality_description","location_description","location_method","longitude","longitude_end","material_types","metadata_store_status","name","northing","numeric_age_max","numeric_age_min","numeric_age_unit","object_type","original_archive","original_archive_contact","other_names","owner_display","parent_sample","platform","platform_id","primary_location_name","primary_location_type","province","publish_date","purpose","registration_date","related_resources","sample_description","sampling_date_precision","sampling_end_date","sampling_method","sampling_method_detail","sampling_start_date","sesar_code","size","size_unit","storage_location","team_id","vertical_datum","zone"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]},"LaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","launch_type","operator","team_owner","user_owner"]},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"},"MetadataStoreStatusEnum":{"enum":["deactivated-datacite","do-not-register","registered","registered-datacite","registered-datacite-v2","registered-datacite-v3","draft","pending-review","pending-batch-review"],"type":"string","description":"* `deactivated-datacite` - Deactivated (DataCite)\n* `do-not-register` - Do Not Register\n* `registered` - Registered\n* `registered-datacite` - Registered (DataCite)\n* `registered-datacite-v2` - Registered (DataCite v2)\n* `registered-datacite-v3` - Registered (DataCite v3)\n* `draft` - Draft\n* `pending-review` - Pending Review\n* `pending-batch-review` - Pending Batch Review"},"Archive":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":36},"parent_institution":{"allOf":[{"$ref":"#/components/schemas/Institution"}],"readOnly":true}},"required":["country","id","label","parent_institution"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]},"Initiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}},"required":["id","label"]}}}} ``` ## The SampleDownload object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleDownload":{"type":"object","description":"Sample metadata for download/export.\n\nRelated entities are nested objects for JSON. CSV export flattens these\ninto separate columns via ``flatten_download_row_for_csv``.","properties":{"igsn":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"other_names":{"type":"string","readOnly":true},"parent_sample":{"type":"string"},"object_type":{"type":"string"},"general_material_type":{"type":"string","readOnly":true},"sample_material":{"type":"array","items":{"type":"string"},"readOnly":true},"field_name":{"type":"string","readOnly":true},"sample_description":{"type":"string","readOnly":true,"nullable":true},"size":{"type":"string","readOnly":true,"nullable":true},"size_unit":{"type":"string","readOnly":true,"nullable":true},"purpose":{"type":"string","readOnly":true,"nullable":true},"geologic_age_verbatim":{"type":"string","readOnly":true,"nullable":true},"geologic_unit":{"type":"string","readOnly":true,"nullable":true},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"northing":{"type":"string","readOnly":true},"easting":{"type":"string","readOnly":true},"zone":{"type":"string","readOnly":true},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_scale":{"type":"string","readOnly":true,"nullable":true},"vertical_datum":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","readOnly":true},"primary_location_name":{"type":"string","readOnly":true,"nullable":true},"primary_location_type":{"type":"string","readOnly":true,"nullable":true},"location_description":{"type":"string","readOnly":true,"nullable":true},"locality":{"type":"string","readOnly":true,"nullable":true},"locality_description":{"type":"string","readOnly":true,"nullable":true},"country":{"type":"string"},"province":{"type":"string","readOnly":true,"nullable":true},"county":{"type":"string","readOnly":true,"nullable":true},"city":{"type":"string","readOnly":true,"nullable":true},"sampling_method":{"type":"string","readOnly":true},"sampling_method_detail":{"type":"string","readOnly":true,"nullable":true},"collectors":{"type":"string","readOnly":true},"cruise_field_prgrm":{"type":"string","readOnly":true},"platform":{"type":"string","readOnly":true},"launch_platform":{"type":"string","readOnly":true},"sampling_start_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_end_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_date_precision":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"availability":{"type":"boolean","readOnly":true,"nullable":true},"personal_collection_storage_location":{"type":"string","readOnly":true,"nullable":true},"current_archive":{"type":"string","readOnly":true},"original_archive":{"type":"string","readOnly":true},"related_resources":{"type":"string","readOnly":true},"publish_date":{"type":"string","format":"date-time","readOnly":true}},"required":["age_description","availability","city","collectors","country","county","cruise_field_prgrm","current_archive","depth_max","depth_min","depth_scale","easting","elevation","elevation_end","elevation_unit","field_name","general_material_type","geologic_age_verbatim","geologic_unit","igsn","latitude","latitude_end","launch_platform","locality","locality_description","location_description","location_method","longitude","longitude_end","name","northing","numeric_age_max","numeric_age_min","numeric_age_unit","object_type","original_archive","other_names","parent_sample","personal_collection_storage_location","platform","primary_location_name","primary_location_type","province","publish_date","purpose","related_resources","sample_description","sample_material","sampling_date_precision","sampling_end_date","sampling_method","sampling_method_detail","sampling_start_date","size","size_unit","vertical_datum","zone"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"}}}} ``` ## The SampleExportJobQueuedData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleExportJobQueuedData":{"type":"object","properties":{"job_id":{"type":"string","format":"uuid"},"status":{"type":"string"},"output_format":{"type":"string"},"sample_count":{"type":"integer"}},"required":["job_id","output_format","sample_count","status"]}}}} ``` ## The SampleExportJobQueuedResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleExportJobQueuedResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleExportJobQueuedData"}},"required":["data"]},"SampleExportJobQueuedData":{"type":"object","properties":{"job_id":{"type":"string","format":"uuid"},"status":{"type":"string"},"output_format":{"type":"string"},"sample_count":{"type":"integer"}},"required":["job_id","output_format","sample_count","status"]}}}} ``` ## The SampleFeedbackItem object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleFeedbackItem":{"type":"object","properties":{"igsn":{"type":"string","maxLength":60},"name":{"type":"string","default":""},"comment":{"type":"string","maxLength":5000}},"required":["comment","igsn"]}}}} ``` ## The SampleGroup object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroup":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true,"nullable":true},"group_type":{"type":"string","readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"is_private":{"type":"boolean","readOnly":true},"sample_count":{"type":"integer","readOnly":true},"resolved_image":{"type":"string","readOnly":true}},"required":["created_date","description","group_type","id","is_private","name","resolved_image","sample_count","team_owner","user_owner"]}}}} ``` ## The SampleGroupAddMembershipsSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupAddMembershipsSuccessData":{"type":"object","properties":{"added_count":{"type":"integer"},"skipped_existing_count":{"type":"integer"},"skipped_private_sample_count":{"type":"integer"},"total_matched":{"type":"integer"},"sample_added_ids_sample":{"type":"array","items":{"type":"integer"}},"message":{"type":"string"}},"required":["added_count","message","sample_added_ids_sample","skipped_existing_count","skipped_private_sample_count","total_matched"]}}}} ``` ## The SampleGroupAddMembershipsSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupAddMembershipsSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleGroupAddMembershipsSuccessData"}},"required":["data"]},"SampleGroupAddMembershipsSuccessData":{"type":"object","properties":{"added_count":{"type":"integer"},"skipped_existing_count":{"type":"integer"},"skipped_private_sample_count":{"type":"integer"},"total_matched":{"type":"integer"},"sample_added_ids_sample":{"type":"array","items":{"type":"integer"}},"message":{"type":"string"}},"required":["added_count","message","sample_added_ids_sample","skipped_existing_count","skipped_private_sample_count","total_matched"]}}}} ``` ## The SampleGroupCreateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupCreateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleGroup"}},"required":["data"]},"SampleGroup":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true,"nullable":true},"group_type":{"type":"string","readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"is_private":{"type":"boolean","readOnly":true},"sample_count":{"type":"integer","readOnly":true},"resolved_image":{"type":"string","readOnly":true}},"required":["created_date","description","group_type","id","is_private","name","resolved_image","sample_count","team_owner","user_owner"]}}}} ``` ## The SampleGroupDeleteSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The SampleGroupDeleteSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupDeleteSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleGroupDeleteSuccessData"}},"required":["data"]},"SampleGroupDeleteSuccessData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}} ``` ## The SampleGroupDetailSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupDetailSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleGroup"}},"required":["data"]},"SampleGroup":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true,"nullable":true},"group_type":{"type":"string","readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"is_private":{"type":"boolean","readOnly":true},"sample_count":{"type":"integer","readOnly":true},"resolved_image":{"type":"string","readOnly":true}},"required":["created_date","description","group_type","id","is_private","name","resolved_image","sample_count","team_owner","user_owner"]}}}} ``` ## The SampleGroupListAllSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupListAllSuccessResponse":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/SampleGroup"}},"description":"Keys are `personal` and team names; values are sample group lists."}},"required":["data"]},"SampleGroup":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true,"nullable":true},"group_type":{"type":"string","readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"is_private":{"type":"boolean","readOnly":true},"sample_count":{"type":"integer","readOnly":true},"resolved_image":{"type":"string","readOnly":true}},"required":["created_date","description","group_type","id","is_private","name","resolved_image","sample_count","team_owner","user_owner"]}}}} ``` ## The SampleGroupListSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupListSuccessResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SampleGroup"}}},"required":["data"]},"SampleGroup":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true,"nullable":true},"group_type":{"type":"string","readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"is_private":{"type":"boolean","readOnly":true},"sample_count":{"type":"integer","readOnly":true},"resolved_image":{"type":"string","readOnly":true}},"required":["created_date","description","group_type","id","is_private","name","resolved_image","sample_count","team_owner","user_owner"]}}}} ``` ## The SampleGroupMembershipRequest object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupMembershipRequest":{"type":"object","properties":{"sample_ids":{"type":"array","items":{"type":"integer"},"description":"Sample primary keys to add or remove (int or list)."},"select_all":{"type":"boolean","default":false,"description":"When true, apply `filters` instead of `sample_ids`."},"filters":{"type":"object","additionalProperties":{"type":"string"},"description":"Sample list filters when `select_all` is true."}}}}}} ``` ## The SampleGroupRemoveMembershipsSuccessData object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupRemoveMembershipsSuccessData":{"type":"object","properties":{"removed_count":{"type":"integer"},"total_matched":{"type":"integer"},"message":{"type":"string"}},"required":["message","removed_count","total_matched"]}}}} ``` ## The SampleGroupRemoveMembershipsSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupRemoveMembershipsSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleGroupRemoveMembershipsSuccessData"}},"required":["data"]},"SampleGroupRemoveMembershipsSuccessData":{"type":"object","properties":{"removed_count":{"type":"integer"},"total_matched":{"type":"integer"},"message":{"type":"string"}},"required":["message","removed_count","total_matched"]}}}} ``` ## The SampleGroupType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true,"maxLength":255},"source":{"type":"string","nullable":true,"maxLength":255}},"required":["id","label"]}}}} ``` ## The SampleGroupUpdateSuccessResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupUpdateSuccessResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SampleGroup"}},"required":["data"]},"SampleGroup":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true,"nullable":true},"group_type":{"type":"string","readOnly":true},"user_owner":{"type":"string","nullable":true,"readOnly":true},"team_owner":{"type":"string","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"is_private":{"type":"boolean","readOnly":true},"sample_count":{"type":"integer","readOnly":true},"resolved_image":{"type":"string","readOnly":true}},"required":["created_date","description","group_type","id","is_private","name","resolved_image","sample_count","team_owner","user_owner"]}}}} ``` ## The SampleGroupWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleGroupWrite":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","nullable":true},"group_type":{"type":"string"},"user_owner":{"type":"string","nullable":true},"team_owner":{"type":"string","nullable":true},"created_date":{"type":"string","format":"date-time"},"is_private":{"type":"boolean"}},"required":["group_type","id","is_private","name"]}}}} ``` ## The SampleLandingPage object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleLandingPage":{"type":"object","description":"Map model VariablePrecisionDecimalField columns to serializers that do not\nquantize values to a fixed decimal scale.","properties":{"igsn":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"parent_sample":{"type":"string"},"external_parent_name":{"type":"string","readOnly":true,"nullable":true},"external_parent_object_type":{"type":"string","readOnly":true},"object_type":{"type":"string","readOnly":true},"legacy_sample_type":{"type":"string","nullable":true,"readOnly":true},"publish_date":{"type":"string","format":"date-time","readOnly":true},"last_update_date":{"type":"string","format":"date-time","readOnly":true},"size":{"type":"string","readOnly":true,"nullable":true},"size_unit":{"type":"string","readOnly":true,"nullable":true},"general_material_type":{"$ref":"#/components/schemas/MaterialType"},"legacy_top_level_classification":{"type":"string","nullable":true,"readOnly":true},"sample_material":{"type":"array","items":{"$ref":"#/components/schemas/MaterialType"}},"legacy_classification":{"type":"string","nullable":true,"readOnly":true},"field_name":{"type":"string","readOnly":true},"sample_description":{"type":"string","readOnly":true,"nullable":true},"purpose":{"type":"string","readOnly":true,"nullable":true},"geologic_age_verbatim":{"type":"string","readOnly":true,"nullable":true},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","readOnly":true,"nullable":true},"geologic_age_younger":{"$ref":"#/components/schemas/GeologicTimeScale"},"geologic_age_older":{"$ref":"#/components/schemas/GeologicTimeScale"},"geologic_unit":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"northing":{"type":"string","readOnly":true},"easting":{"type":"string","readOnly":true},"zone":{"type":"string","readOnly":true},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_scale":{"type":"string","readOnly":true,"nullable":true},"vertical_datum":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"$ref":"#/components/schemas/LocationMethod"},"primary_location_type":{"type":"string","readOnly":true,"nullable":true},"primary_location_name":{"type":"string","readOnly":true,"nullable":true},"location_description":{"type":"string","readOnly":true,"nullable":true},"locality":{"type":"string","readOnly":true,"nullable":true},"locality_description":{"type":"string","readOnly":true,"nullable":true},"country":{"type":"string"},"province":{"type":"string","readOnly":true,"nullable":true},"county":{"type":"string","readOnly":true,"nullable":true},"city":{"type":"string","readOnly":true,"nullable":true},"sampling_method":{"$ref":"#/components/schemas/SamplingMethod"},"sampling_method_detail":{"type":"string","readOnly":true,"nullable":true},"cruise_field_prgrm":{"$ref":"#/components/schemas/Initiative"},"collectors":{"type":"string","readOnly":true},"platform":{"$ref":"#/components/schemas/Platform"},"launch_platform":{"$ref":"#/components/schemas/LaunchPlatform"},"launch_label":{"type":"string","readOnly":true,"nullable":true},"sampling_start_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_end_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_date_precision":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"children_igsns":{"type":"string","readOnly":true},"sibling_igsns":{"type":"string","readOnly":true},"other_names":{"type":"string","readOnly":true},"registration_date":{"type":"string","format":"date-time","readOnly":true},"current_archive":{"allOf":[{"$ref":"#/components/schemas/Archive"}],"readOnly":true},"original_archive":{"allOf":[{"$ref":"#/components/schemas/Archive"}],"readOnly":true},"current_archive_contact":{"type":"string","readOnly":true,"nullable":true},"original_archive_contact":{"type":"string","readOnly":true,"nullable":true},"storage_location":{"type":"string","readOnly":true,"nullable":true},"related_resources":{"type":"array","items":{"$ref":"#/components/schemas/RelatedResource"},"readOnly":true},"availability":{"type":"boolean","readOnly":true,"nullable":true}},"required":["age_description","availability","children_igsns","city","collectors","country","county","cruise_field_prgrm","current_archive","current_archive_contact","depth_max","depth_min","depth_scale","easting","elevation","elevation_end","elevation_unit","external_parent_name","external_parent_object_type","field_name","general_material_type","geologic_age_older","geologic_age_verbatim","geologic_age_younger","geologic_unit","igsn","last_update_date","latitude","latitude_end","launch_label","launch_platform","legacy_classification","legacy_sample_type","legacy_top_level_classification","locality","locality_description","location_description","location_method","longitude","longitude_end","name","northing","numeric_age_max","numeric_age_min","numeric_age_unit","object_type","original_archive","original_archive_contact","other_names","parent_sample","platform","primary_location_name","primary_location_type","province","publish_date","purpose","registration_date","related_resources","sample_description","sample_material","sampling_date_precision","sampling_end_date","sampling_method","sampling_method_detail","sampling_start_date","sesar_code","sibling_igsns","size","size_unit","storage_location","vertical_datum","zone"]},"MaterialType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"material_type_uri":{"type":"string","nullable":true,"maxLength":255},"parent_material_types":{"type":"array","items":{"type":"string"},"readOnly":true},"source":{"type":"string","nullable":true},"scheme_uri":{"type":"string","nullable":true,"maxLength":255},"for_registration":{"type":"boolean"},"suppress_from_search":{"type":"boolean"}},"required":["for_registration","id","label","parent_material_types","suppress_from_search"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"NullEnum":{"enum":[null]},"GeologicTimeScale":{"type":"object","properties":{"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"geologic_time_interval_uri":{"type":"string","nullable":true,"maxLength":255},"source":{"type":"string","nullable":true,"maxLength":255},"scheme_uri":{"type":"string","nullable":true,"maxLength":255},"numeric_older_bound":{"type":"number","format":"double","nullable":true},"numeric_younger_bound":{"type":"number","format":"double","nullable":true},"notation":{"type":"string","nullable":true,"maxLength":32}},"required":["label"]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"LocationMethod":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"required":["id","label"]},"SamplingMethod":{"type":"object","properties":{"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":1000},"method_uri":{"type":"string","nullable":true,"maxLength":255},"source":{"type":"string","nullable":true,"maxLength":255},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["label"]},"Initiative":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"funding":{"type":"string","nullable":true,"maxLength":50},"begin_date":{"type":"string","format":"date-time","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"initiative_uri":{"type":"string","nullable":true,"maxLength":255},"user_owner":{"type":"integer","nullable":true},"team_owner":{"type":"integer","nullable":true}},"required":["id","label"]},"Platform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"platform_type_name":{"type":"string","writeOnly":true,"nullable":true},"platform_type_id":{"type":"integer","nullable":true},"platform_type_description":{"type":"string","writeOnly":true,"nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","operator","team_owner","user_owner"]},"LaunchPlatform":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":100},"norm_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"host_platform_id":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"launch_type":{"type":"string","readOnly":true},"launch_type_id":{"type":"integer","nullable":true},"operator":{"type":"string","readOnly":true},"operator_id":{"type":"integer","nullable":true},"date_commissioned":{"type":"string","format":"date","nullable":true},"user_owner":{"type":"integer","readOnly":true,"nullable":true},"team_owner":{"type":"integer","readOnly":true,"nullable":true}},"required":["id","launch_type","operator","team_owner","user_owner"]},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"},"Archive":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":36},"parent_institution":{"allOf":[{"$ref":"#/components/schemas/Institution"}],"readOnly":true}},"required":["country","id","label","parent_institution"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]},"RelatedResource":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"related_resource_type":{"type":"string","readOnly":true},"uri":{"type":"string","maxLength":255},"uri_type":{"type":"string","maxLength":24},"file_type":{"type":"string","nullable":true,"maxLength":128},"uploaded_date":{"type":"string","format":"date-time"}},"required":["id","label","related_resource_type","uri","uri_type"]}}}} ``` ## The SampleList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleList":{"type":"object","description":"Map model VariablePrecisionDecimalField columns to serializers that do not\nquantize values to a fixed decimal scale.","properties":{"sample_id":{"type":"integer","readOnly":true},"igsn":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"external_sample_id":{"type":"string","readOnly":true,"nullable":true},"sesar_code":{"type":"string","readOnly":true},"parent_sample":{"type":"string"},"object_type":{"type":"string","readOnly":true},"publish_date":{"type":"string","format":"date-time","readOnly":true},"last_update_date":{"type":"string","format":"date-time","readOnly":true},"size":{"type":"string","readOnly":true,"nullable":true},"general_material_type":{"type":"string","readOnly":true},"sample_material":{"type":"array","items":{"type":"string"},"readOnly":true},"field_name":{"type":"string","readOnly":true},"sample_description":{"type":"string","readOnly":true,"nullable":true},"purpose":{"type":"string","readOnly":true,"nullable":true},"geologic_age_verbatim":{"type":"string","readOnly":true,"nullable":true},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","readOnly":true,"nullable":true},"geologic_age_younger":{"type":"string","readOnly":true},"geologic_age_older":{"type":"string","readOnly":true},"geologic_unit":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"northing":{"type":"string","readOnly":true},"easting":{"type":"string","readOnly":true},"zone":{"type":"string","readOnly":true},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_scale":{"type":"string","readOnly":true,"nullable":true},"vertical_datum":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","readOnly":true},"primary_location_type":{"type":"string","readOnly":true,"nullable":true},"primary_location_name":{"type":"string","readOnly":true,"nullable":true},"location_description":{"type":"string","readOnly":true,"nullable":true},"locality":{"type":"string","readOnly":true,"nullable":true},"locality_description":{"type":"string","readOnly":true,"nullable":true},"country":{"type":"string"},"province":{"type":"string","readOnly":true,"nullable":true},"county":{"type":"string","readOnly":true,"nullable":true},"city":{"type":"string","readOnly":true,"nullable":true},"sampling_method":{"type":"string","readOnly":true},"sampling_method_detail":{"type":"string","readOnly":true,"nullable":true},"cruise_field_prgrm":{"type":"string","readOnly":true},"collectors":{"type":"string","readOnly":true},"platform":{"type":"string","nullable":true,"readOnly":true},"launch_platform":{"type":"string","nullable":true,"readOnly":true},"launch_label":{"type":"string","readOnly":true,"nullable":true},"sampling_start_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_end_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_date_precision":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"other_names":{"type":"string","readOnly":true},"registration_date":{"type":"string","format":"date-time","readOnly":true},"current_archive":{"type":"string","readOnly":true},"original_archive":{"type":"string","readOnly":true},"current_archive_contact":{"type":"string","readOnly":true,"nullable":true},"original_archive_contact":{"type":"string","readOnly":true,"nullable":true},"is_linked":{"type":"boolean","readOnly":true,"default":false},"is_draft":{"type":"string","readOnly":true},"is_pending_review":{"type":"string","readOnly":true}},"required":["age_description","city","collectors","country","county","cruise_field_prgrm","current_archive","current_archive_contact","depth_max","depth_min","depth_scale","easting","elevation","elevation_unit","external_sample_id","field_name","general_material_type","geologic_age_older","geologic_age_verbatim","geologic_age_younger","geologic_unit","igsn","is_draft","is_linked","is_pending_review","last_update_date","latitude","latitude_end","launch_label","launch_platform","locality","locality_description","location_description","location_method","longitude","longitude_end","name","northing","numeric_age_max","numeric_age_min","numeric_age_unit","object_type","original_archive","original_archive_contact","other_names","parent_sample","platform","primary_location_name","primary_location_type","province","publish_date","purpose","registration_date","sample_description","sample_id","sample_material","sampling_date_precision","sampling_end_date","sampling_method","sampling_method_detail","sampling_start_date","sesar_code","size","vertical_datum","zone"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"}}}} ``` ## The SampleMapExtentResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleMapExtentResponse":{"type":"object","properties":{"extent":{"type":"object","additionalProperties":{},"nullable":true},"count":{"type":"integer"}},"required":["count","extent"]}}}} ``` ## The SampleMetadataDownloadError object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleMetadataDownloadError":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}} ``` ## The SampleMetadataStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleMetadataStatisticsResponse":{"type":"object","properties":{"time":{"type":"string","description":"YYYY-MM"},"stats":{"type":"object","additionalProperties":{}}},"required":["stats","time"]}}}} ``` ## The SampleRegistrationMethodStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleRegistrationMethodStatisticsResponse":{"type":"object","properties":{"total":{"type":"integer"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/SampleRegistrationMethodStatisticsRow"}}},"required":["statistics","total"]},"SampleRegistrationMethodStatisticsRow":{"type":"object","properties":{"method":{"type":"string"},"count":{"type":"integer"}},"required":["count","method"]}}}} ``` ## The SampleRegistrationMethodStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleRegistrationMethodStatisticsRow":{"type":"object","properties":{"method":{"type":"string"},"count":{"type":"integer"}},"required":["count","method"]}}}} ``` ## The SampleRegistrationMonthlyStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleRegistrationMonthlyStatisticsResponse":{"type":"object","properties":{"statistics":{"type":"array","items":{"$ref":"#/components/schemas/SampleRegistrationMonthlyStatisticsRow"}}},"required":["statistics"]},"SampleRegistrationMonthlyStatisticsRow":{"type":"object","properties":{"month":{"type":"string","description":"YYYY-MM"},"samples_registered":{"type":"integer"},"samples_updated":{"type":"integer"}},"required":["month","samples_registered","samples_updated"]}}}} ``` ## The SampleRegistrationMonthlyStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleRegistrationMonthlyStatisticsRow":{"type":"object","properties":{"month":{"type":"string","description":"YYYY-MM"},"samples_registered":{"type":"integer"},"samples_updated":{"type":"integer"}},"required":["month","samples_registered","samples_updated"]}}}} ``` ## The SampleTablePagination object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleTablePagination":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"rows":{"type":"array","items":{"$ref":"#/components/schemas/SampleList"}},"columns":{"type":"array","items":{"$ref":"#/components/schemas/SampleTablePaginationColumn"}},"page_size":{"type":"integer"},"current_page":{"type":"integer"},"total_pages":{"type":"integer","nullable":true}},"required":["columns","count","rows"]},"SampleList":{"type":"object","description":"Map model VariablePrecisionDecimalField columns to serializers that do not\nquantize values to a fixed decimal scale.","properties":{"sample_id":{"type":"integer","readOnly":true},"igsn":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"external_sample_id":{"type":"string","readOnly":true,"nullable":true},"sesar_code":{"type":"string","readOnly":true},"parent_sample":{"type":"string"},"object_type":{"type":"string","readOnly":true},"publish_date":{"type":"string","format":"date-time","readOnly":true},"last_update_date":{"type":"string","format":"date-time","readOnly":true},"size":{"type":"string","readOnly":true,"nullable":true},"general_material_type":{"type":"string","readOnly":true},"sample_material":{"type":"array","items":{"type":"string"},"readOnly":true},"field_name":{"type":"string","readOnly":true},"sample_description":{"type":"string","readOnly":true,"nullable":true},"purpose":{"type":"string","readOnly":true,"nullable":true},"geologic_age_verbatim":{"type":"string","readOnly":true,"nullable":true},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"numeric_age_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","readOnly":true,"nullable":true},"geologic_age_younger":{"type":"string","readOnly":true},"geologic_age_older":{"type":"string","readOnly":true},"geologic_unit":{"type":"string","readOnly":true,"nullable":true},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"northing":{"type":"string","readOnly":true},"easting":{"type":"string","readOnly":true},"zone":{"type":"string","readOnly":true},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"depth_scale":{"type":"string","readOnly":true,"nullable":true},"vertical_datum":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","readOnly":true,"nullable":true},"elevation_unit":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","readOnly":true},"primary_location_type":{"type":"string","readOnly":true,"nullable":true},"primary_location_name":{"type":"string","readOnly":true,"nullable":true},"location_description":{"type":"string","readOnly":true,"nullable":true},"locality":{"type":"string","readOnly":true,"nullable":true},"locality_description":{"type":"string","readOnly":true,"nullable":true},"country":{"type":"string"},"province":{"type":"string","readOnly":true,"nullable":true},"county":{"type":"string","readOnly":true,"nullable":true},"city":{"type":"string","readOnly":true,"nullable":true},"sampling_method":{"type":"string","readOnly":true},"sampling_method_detail":{"type":"string","readOnly":true,"nullable":true},"cruise_field_prgrm":{"type":"string","readOnly":true},"collectors":{"type":"string","readOnly":true},"platform":{"type":"string","nullable":true,"readOnly":true},"launch_platform":{"type":"string","nullable":true,"readOnly":true},"launch_label":{"type":"string","readOnly":true,"nullable":true},"sampling_start_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_end_date":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"sampling_date_precision":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"other_names":{"type":"string","readOnly":true},"registration_date":{"type":"string","format":"date-time","readOnly":true},"current_archive":{"type":"string","readOnly":true},"original_archive":{"type":"string","readOnly":true},"current_archive_contact":{"type":"string","readOnly":true,"nullable":true},"original_archive_contact":{"type":"string","readOnly":true,"nullable":true},"is_linked":{"type":"boolean","readOnly":true,"default":false},"is_draft":{"type":"string","readOnly":true},"is_pending_review":{"type":"string","readOnly":true}},"required":["age_description","city","collectors","country","county","cruise_field_prgrm","current_archive","current_archive_contact","depth_max","depth_min","depth_scale","easting","elevation","elevation_unit","external_sample_id","field_name","general_material_type","geologic_age_older","geologic_age_verbatim","geologic_age_younger","geologic_unit","igsn","is_draft","is_linked","is_pending_review","last_update_date","latitude","latitude_end","launch_label","launch_platform","locality","locality_description","location_description","location_method","longitude","longitude_end","name","northing","numeric_age_max","numeric_age_min","numeric_age_unit","object_type","original_archive","original_archive_contact","other_names","parent_sample","platform","primary_location_name","primary_location_type","province","publish_date","purpose","registration_date","sample_description","sample_id","sample_material","sampling_date_precision","sampling_end_date","sampling_method","sampling_method_detail","sampling_start_date","sesar_code","size","vertical_datum","zone"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"},"SampleTablePaginationColumn":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"}},"required":["field","type"]}}}} ``` ## The SampleTablePaginationColumn object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleTablePaginationColumn":{"type":"object","properties":{"field":{"type":"string"},"type":{"type":"string"}},"required":["field","type"]}}}} ``` ## The SampleUpdate object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampleUpdate":{"type":"object","description":"Sample registration payload. Prefer nested label-based objects (e.g. platform, launch_platform, collectors with individual/institution) over optional internal primary-key shortcuts, which remain accepted by the API.","properties":{"igsn":{"type":"string","readOnly":true},"name":{"type":"string","maxLength":255},"external_sample_id":{"type":"string","nullable":true,"maxLength":100},"sesar_code":{"type":"string","readOnly":true},"team":{"type":"string","readOnly":true},"object_type":{"type":"string"},"general_material_type":{"type":"string","nullable":true},"field_name":{"type":"string","nullable":true,"maxLength":255},"sample_description":{"type":"string","nullable":true},"size":{"type":"string","nullable":true,"maxLength":255},"size_unit":{"type":"string","nullable":true,"maxLength":255},"purpose":{"type":"string","nullable":true,"maxLength":500},"parent_sample":{"type":"string","nullable":true},"external_parent_name":{"type":"string","nullable":true,"maxLength":1000},"external_parent_object_type":{"type":"string","nullable":true},"geologic_age_verbatim":{"type":"string","nullable":true,"maxLength":500},"numeric_age_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"numeric_age_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"numeric_age_unit":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NumericAgeUnitEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"age_description":{"type":"string","nullable":true,"maxLength":1000},"geologic_unit":{"type":"string","nullable":true,"maxLength":500},"latitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"longitude":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"latitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"longitude_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"northing":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","writeOnly":true,"nullable":true},"easting":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","writeOnly":true,"nullable":true},"zone":{"type":"string","writeOnly":true,"nullable":true,"maxLength":32},"depth_min":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"depth_max":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"depth_scale":{"type":"string","nullable":true,"maxLength":255},"vertical_datum":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/VerticalDatumEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"elevation":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"elevation_end":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,20})?$","nullable":true},"elevation_unit":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElevationUnitEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"location_method":{"type":"string","nullable":true},"primary_location_type":{"type":"string","nullable":true,"maxLength":255},"primary_location_name":{"type":"string","nullable":true,"maxLength":1000},"location_description":{"type":"string","nullable":true,"maxLength":2000},"locality":{"type":"string","nullable":true,"maxLength":255},"locality_description":{"type":"string","nullable":true,"maxLength":2000},"country":{"type":"string","nullable":true},"province":{"type":"string","nullable":true,"maxLength":255},"county":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"sampling_method":{"type":"string","nullable":true,"description":"Sampling method label. Matched case-insensitively against existing vocabulary."},"sampling_method_detail":{"type":"string","nullable":true,"maxLength":1000},"cruise_field_prgrm":{"type":"string","nullable":true,"description":"Initiative label. Matched against owner's existing initiatives, created if new."},"platform":{"allOf":[{"$ref":"#/components/schemas/PlatformInput"}],"writeOnly":true,"nullable":true},"launch_platform":{"allOf":[{"$ref":"#/components/schemas/LaunchPlatformInput"}],"writeOnly":true,"nullable":true},"launch_label":{"type":"string","nullable":true,"maxLength":100},"sampling_start_date":{"type":"string","format":"date-time","nullable":true},"sampling_end_date":{"type":"string","format":"date-time","nullable":true},"sampling_date_precision":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SamplingDatePrecisionEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"publish_date":{"type":"string","format":"date-time"},"registration_date":{"type":"string","format":"date-time","readOnly":true},"availability":{"type":"boolean","nullable":true},"storage_location":{"type":"string","nullable":true,"maxLength":255},"personal_collection_storage_location":{"type":"string","writeOnly":true,"nullable":true,"description":"Personal collection / storage location (alias for storage_location).","maxLength":255},"is_draft":{"type":"boolean","writeOnly":true,"description":"Set true to save as draft. Internal status is derived automatically."},"batch_history":{"type":"integer","writeOnly":true,"nullable":true,"description":"Optional batch history to add the created sample to (e.g. mint child from a batch detail page)."},"other_names":{"type":"array","items":{"type":"string","maxLength":255},"writeOnly":true},"material_types":{"type":"array","items":{"type":"string","maxLength":50},"writeOnly":true,"description":"List of material type labels"},"collectors":{"type":"array","items":{"$ref":"#/components/schemas/CollectorInput"},"writeOnly":true},"current_archive":{"allOf":[{"$ref":"#/components/schemas/ArchiveInput"}],"writeOnly":true,"nullable":true},"original_archive":{"allOf":[{"$ref":"#/components/schemas/ArchiveInput"}],"writeOnly":true,"nullable":true},"current_archive_id":{"type":"integer","writeOnly":true,"nullable":true},"original_archive_id":{"type":"integer","writeOnly":true,"nullable":true},"current_archive_contact":{"type":"string","nullable":true,"maxLength":1000},"original_archive_contact":{"type":"string","nullable":true,"maxLength":1000},"related_resources":{"type":"array","items":{"type":"integer","writeOnly":true},"writeOnly":true,"description":"IDs of publications, datasets, and other related resources to link. On update, replaces non-Image links; Image links are preserved. Omit on update to leave links unchanged."}},"required":["igsn","name","object_type","registration_date","sesar_code","team"]},"NumericAgeUnitEnum":{"enum":["years (yr)","thousand years (Ka)","million years (Ma)","billion years (Ga)","Before Present, 1950 (BP)","Anno Domini (AD)","Common Era (CE)","Before Common Era (BCE)"],"type":"string","description":"* `years (yr)` - years (yr)\n* `thousand years (Ka)` - thousand years (Ka)\n* `million years (Ma)` - million years (Ma)\n* `billion years (Ga)` - billion years (Ga)\n* `Before Present, 1950 (BP)` - Before Present, 1950 (BP)\n* `Anno Domini (AD)` - Anno Domini (AD)\n* `Common Era (CE)` - Common Era (CE)\n* `Before Common Era (BCE)` - Before Common Era (BCE)"},"BlankEnum":{"enum":[""]},"NullEnum":{"enum":[null]},"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"},"ElevationUnitEnum":{"enum":["meters","kilometers","feet","miles"],"type":"string","description":"* `meters` - Meters\n* `kilometers` - Kilometers\n* `feet` - Feet\n* `miles` - Miles"},"PlatformInput":{"type":"object","description":"Nested input for platform: label + type.","properties":{"label":{"type":"string","nullable":true,"maxLength":100},"platform_type":{"type":"string","nullable":true,"maxLength":50},"description":{"type":"string","nullable":true}}},"LaunchPlatformInput":{"type":"object","description":"Nested input for launch platform: label + type.","properties":{"label":{"type":"string","nullable":true,"maxLength":100},"launch_type":{"type":"string","nullable":true,"maxLength":50}}},"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"},"CollectorInput":{"type":"object","description":"Collector reference (id or inline individual/institution payload).","properties":{"description":{"type":"string","nullable":true},"individual":{"allOf":[{"$ref":"#/components/schemas/CollectorIndividualInput"}],"nullable":true},"institution":{"allOf":[{"$ref":"#/components/schemas/CollectorInstitutionInput"}],"nullable":true}}},"CollectorIndividualInput":{"type":"object","description":"Inline individual payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"individual_uri":{"type":"string","nullable":true,"maxLength":255}}},"CollectorInstitutionInput":{"type":"object","description":"Inline institution payload for collector resolution/create.","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"ror":{"type":"string","nullable":true,"maxLength":25},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true}}},"ArchiveInput":{"type":"object","description":"Inline archive payload for create-or-match by label.","properties":{"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"city":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"url":{"type":"string","nullable":true,"maxLength":200},"uri":{"type":"string","nullable":true,"maxLength":25}},"required":["label"]}}}} ``` ## The SampledFeatureType object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SampledFeatureType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"feature_type_uri":{"type":"string","nullable":true,"maxLength":255},"parent_feature_type":{"type":"integer","nullable":true},"source":{"type":"string","nullable":true},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["id","label"]}}}} ``` ## The SamplesPerYearStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SamplesPerYearStatisticsResponse":{"type":"object","properties":{"scope":{"type":"string"},"total_samples":{"type":"integer"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/SamplesPerYearStatisticsRow"}}},"required":["scope","statistics","total_samples"]},"SamplesPerYearStatisticsRow":{"type":"object","properties":{"year":{"type":"integer"},"count":{"type":"integer"}},"required":["count","year"]}}}} ``` ## The SamplesPerYearStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SamplesPerYearStatisticsRow":{"type":"object","properties":{"year":{"type":"integer"},"count":{"type":"integer"}},"required":["count","year"]}}}} ``` ## The SamplingDatePrecisionEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SamplingDatePrecisionEnum":{"enum":["year","month","day","hour","minute","time"],"type":"string","description":"* `year` - Year\n* `month` - Month\n* `day` - Day\n* `hour` - Hour\n* `minute` - Minute\n* `time` - Time"}}}} ``` ## The SamplingMethod object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SamplingMethod":{"type":"object","properties":{"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":1000},"method_uri":{"type":"string","nullable":true,"maxLength":255},"source":{"type":"string","nullable":true,"maxLength":255},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["label"]}}}} ``` ## The SamplingMethodListSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SamplingMethodListSuccess":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SamplingMethod"},"description":"Sampling methods."}},"required":["data"]},"SamplingMethod":{"type":"object","properties":{"label":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":1000},"method_uri":{"type":"string","nullable":true,"maxLength":255},"source":{"type":"string","nullable":true,"maxLength":255},"scheme_uri":{"type":"string","nullable":true,"maxLength":255}},"required":["label"]}}}} ``` ## The SesarCodeCreateForbidden object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarCodeCreateForbidden":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}} ``` ## The SesarCodeDeleteProtected object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarCodeDeleteProtected":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}} ``` ## The SesarCodeDeleteSuccess object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarCodeDeleteSuccess":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The SesarCodeDetail object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarCodeDetail":{"type":"object","properties":{"sesar_user":{"type":"string","readOnly":true},"team":{"type":"string"},"sesar_code":{"type":"string","readOnly":true},"doi_prefix":{"type":"string","readOnly":true},"igsn_count":{"type":"integer","readOnly":true,"nullable":true}},"required":["doi_prefix","igsn_count","sesar_code","sesar_user","team"]}}}} ``` ## The SesarCodeList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarCodeList":{"type":"object","properties":{"sesar_user":{"type":"string","nullable":true,"readOnly":true},"sesar_user_display":{"type":"string","readOnly":true},"team":{"type":"string","readOnly":true},"sesar_code":{"type":"string","readOnly":true},"doi_prefix":{"type":"string","readOnly":true},"igsn_count":{"type":"integer","readOnly":true,"nullable":true}},"required":["doi_prefix","igsn_count","sesar_code","sesar_user","sesar_user_display","team"]}}}} ``` ## The SesarCodeListNotFound object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarCodeListNotFound":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}} ``` ## The SesarCodeWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarCodeWrite":{"type":"object","properties":{"sesar_user":{"type":"string","nullable":true},"team":{"type":"string"},"sesar_code":{"type":"string","maxLength":5}},"required":["sesar_code"]}}}} ``` ## The SesarUser object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarUser":{"type":"object","properties":{"individual":{"allOf":[{"$ref":"#/components/schemas/Individual"}],"readOnly":true},"email":{"type":"string","nullable":true,"maxLength":255},"registration_date":{"type":"string","format":"date-time"},"orcid":{"type":"string","nullable":true,"maxLength":19},"doi_prefix":{"type":"string","maxLength":10},"upload_permission_status":{"type":"integer","maximum":2147483647,"minimum":-2147483648,"nullable":true},"notification_preferences":{},"is_staff":{"type":"boolean","readOnly":true},"is_admin":{"type":"integer","readOnly":true},"storage_used":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"storage_limit":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"}},"required":["individual","is_admin","is_staff","storage_limit","storage_used"]},"Individual":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"$ref":"#/components/schemas/Institution"},"readOnly":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"country":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true}},"required":["can_edit","country","id","institutions"]},"Institution":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"institution_type":{"type":"string","readOnly":true},"label":{"type":"string","maxLength":200},"alt_label":{"type":"string","nullable":true,"maxLength":200},"description":{"type":"string","nullable":true},"country":{"type":"string","readOnly":true},"country_subdivision":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"ror":{"type":"string","nullable":true,"maxLength":25},"parent_institutions":{"type":"string","readOnly":true},"can_edit":{"type":"string","readOnly":true},"created_by":{"type":"integer","nullable":true}},"required":["can_edit","country","id","institution_type","label","parent_institutions"]}}}} ``` ## The SesarUserSearch object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarUserSearch":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"sesar_user":{"type":"string","readOnly":true},"orcid":{"type":"string","nullable":true,"maxLength":19}},"required":["id","sesar_user"]}}}} ``` ## The SesarUserWrite object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"SesarUserWrite":{"type":"object","properties":{"individual":{"$ref":"#/components/schemas/IndividualUpdate"},"email":{"type":"string"},"notification_preferences":{}},"required":["email","individual"]},"IndividualUpdate":{"type":"object","properties":{"label":{"type":"string","nullable":true,"maxLength":200},"fname":{"type":"string","nullable":true,"maxLength":100},"lname":{"type":"string","nullable":true,"maxLength":100},"alt_label":{"type":"string","nullable":true,"maxLength":100},"description":{"type":"string","nullable":true},"address":{"type":"string","nullable":true,"maxLength":500},"email":{"type":"string","nullable":true,"maxLength":255},"phone":{"type":"string","nullable":true,"maxLength":255},"fax":{"type":"string","nullable":true,"maxLength":255},"individual_uri":{"type":"string","readOnly":true},"country":{"type":"string","nullable":true},"institution_detail":{"type":"string","nullable":true,"maxLength":255},"institutions":{"type":"array","items":{"type":"integer"}}},"required":["individual_uri"]}}}} ``` ## The StatusEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"StatusEnum":{"enum":["pending","processing","completed","failed"],"type":"string","description":"* `pending` - Pending\n* `processing` - Processing\n* `completed` - Completed\n* `failed` - Failed"}}}} ``` ## The TeamList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TeamList":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","readOnly":true},"display_name":{"type":"string","readOnly":true},"team_type":{"type":"string","readOnly":true},"auth_group_name":{"type":"string","readOnly":true}},"required":["auth_group_name","display_name","id","name","team_type"]}}}} ``` ## The TokenBlacklist object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TokenBlacklist":{"type":"object","properties":{"refresh":{"type":"string","writeOnly":true}},"required":["refresh"]}}}} ``` ## The TokenRefresh object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TokenRefresh":{"type":"object","properties":{"access":{"type":"string","readOnly":true},"refresh":{"type":"string"}},"required":["access","refresh"]}}}} ``` ## The TopArchivesStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TopArchivesStatisticsResponse":{"type":"object","properties":{"scope":{"type":"string"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/TopArchivesStatisticsRow"}}},"required":["scope","statistics"]},"TopArchivesStatisticsRow":{"type":"object","properties":{"archive_id":{"type":"integer"},"archive":{"type":"string"},"count":{"type":"integer"}},"required":["archive","archive_id","count"]}}}} ``` ## The TopArchivesStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TopArchivesStatisticsRow":{"type":"object","properties":{"archive_id":{"type":"integer"},"archive":{"type":"string"},"count":{"type":"integer"}},"required":["archive","archive_id","count"]}}}} ``` ## The TopInstitutionsStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TopInstitutionsStatisticsResponse":{"type":"object","properties":{"year":{"type":"integer"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/TopInstitutionsStatisticsRow"}}},"required":["statistics","year"]},"TopInstitutionsStatisticsRow":{"type":"object","properties":{"institution":{"type":"string"},"count":{"type":"integer"}},"required":["count","institution"]}}}} ``` ## The TopInstitutionsStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TopInstitutionsStatisticsRow":{"type":"object","properties":{"institution":{"type":"string"},"count":{"type":"integer"}},"required":["count","institution"]}}}} ``` ## The TotalSampleStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TotalSampleStatisticsResponse":{"type":"object","properties":{"scope":{"type":"string"},"total_samples":{"type":"integer"},"published_samples":{"type":"integer"},"countries_with_published_samples":{"type":"integer"}},"required":["countries_with_published_samples","published_samples","scope","total_samples"]}}}} ``` ## The TransferHistoryList object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"TransferHistoryList":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"status":{"type":"string","readOnly":true},"transfer_time":{"type":"string","format":"date-time","readOnly":true},"transfer_by":{"type":"string","readOnly":true},"from_name":{"type":"string","readOnly":true},"to_name":{"type":"string","readOnly":true},"resource_summary":{"type":"string","readOnly":true},"items_count":{"type":"integer","readOnly":true},"direction":{"type":"string","readOnly":true}},"required":["direction","from_name","id","items_count","resource_summary","status","to_name","transfer_by","transfer_time"]}}}} ``` ## The UsersPerCountryStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"UsersPerCountryStatisticsResponse":{"type":"object","properties":{"total_users":{"type":"integer"},"statistics":{"type":"array","items":{"$ref":"#/components/schemas/UsersPerCountryStatisticsRow"}}},"required":["statistics","total_users"]},"UsersPerCountryStatisticsRow":{"type":"object","properties":{"country":{"type":"string"},"iso_code":{"type":"string","nullable":true},"count":{"type":"integer"}},"required":["count","country","iso_code"]}}}} ``` ## The UsersPerCountryStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"UsersPerCountryStatisticsRow":{"type":"object","properties":{"country":{"type":"string"},"iso_code":{"type":"string","nullable":true},"count":{"type":"integer"}},"required":["count","country","iso_code"]}}}} ``` ## The UsersPerYearStatisticsResponse object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"UsersPerYearStatisticsResponse":{"type":"object","properties":{"statistics":{"type":"array","items":{"$ref":"#/components/schemas/UsersPerYearStatisticsRow"}}},"required":["statistics"]},"UsersPerYearStatisticsRow":{"type":"object","properties":{"year":{"type":"integer"},"new_users":{"type":"integer"},"active_users":{"type":"integer"}},"required":["active_users","new_users","year"]}}}} ``` ## The UsersPerYearStatisticsRow object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"UsersPerYearStatisticsRow":{"type":"object","properties":{"year":{"type":"integer"},"new_users":{"type":"integer"},"active_users":{"type":"integer"}},"required":["active_users","new_users","year"]}}}} ``` ## The VerticalDatumEnum object ```json {"openapi":"3.0.3","info":{"title":"SESAR API","version":"1.0.0"},"components":{"schemas":{"VerticalDatumEnum":{"enum":["NAVD88","MSL"],"type":"string","description":"* `NAVD88` - NAVD88\n* `MSL` - Mean Sea Level (MSL)"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.geosamples.org/api/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.