BctNotification

<back to all web services

GetIncompleteResubmittableFormData

OpenClinica
Requires Authentication
The following routes are available for this service:
GET/notification/incomplete-resubmittable-form/
namespace BctNotification.ServiceModel.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type IncompleteResubmittableFormData() = 
        member val StudyName:String = null with get,set
        member val InstitutionName:String = null with get,set
        member val PatientStudyNumber:String = null with get,set
        member val EventName:String = null with get,set
        member val FormName:String = null with get,set

    [<AllowNullLiteral>]
    type GetIncompleteResubmittableFormDataResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val IncompleteResubmittableFormData:ResizeArray<IncompleteResubmittableFormData> = new ResizeArray<IncompleteResubmittableFormData>() with get,set

    [<ApiResponse(Description="Unauthorized.", StatusCode=401)>]
    [<ApiResponse(Description="Forbidden.", StatusCode=403)>]
    [<ApiResponse(Description="Bad Request.", StatusCode=400)>]
    [<ApiResponse(Description="Internal Server Error.", StatusCode=500)>]
    [<AllowNullLiteral>]
    type GetIncompleteResubmittableFormData() = 
        interface IGet
        member val StudyName:String = null with get,set
        member val EventName:String = null with get,set
        member val FormName:String = null with get,set

F# 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
		}
	]
}