BctNotification

<back to all web services

GetIncompleteResubmittableFormData

OpenClinica
Requires Authentication
The following routes are available for this service:
GET/notification/incomplete-resubmittable-form/
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IncompleteResubmittableFormData:
    study_name: Optional[str] = None
    institution_name: Optional[str] = None
    patient_study_number: Optional[str] = None
    event_name: Optional[str] = None
    form_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetIncompleteResubmittableFormDataResponse:
    response_status: Optional[ResponseStatus] = None
    incomplete_resubmittable_form_data: Optional[List[IncompleteResubmittableFormData]] = None


# @ApiResponse(Description="Unauthorized.", StatusCode=401)
# @ApiResponse(Description="Forbidden.", StatusCode=403)
# @ApiResponse(Description="Bad Request.", StatusCode=400)
# @ApiResponse(Description="Internal Server Error.", StatusCode=500)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetIncompleteResubmittableFormData(IGet):
    study_name: Optional[str] = None
    event_name: Optional[str] = None
    form_name: Optional[str] = None

Python GetIncompleteResubmittableFormData DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /notification/incomplete-resubmittable-form/ HTTP/1.1 
Host: notifications.breastcancertrials.org.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	incompleteResubmittableFormData: 
	[
		{
			studyName: String,
			institutionName: String,
			patientStudyNumber: String,
			eventName: String,
			formName: String
		}
	]
}