CMS Web Services - v4.0.6521.16602 [cms-b]

<back to all web services

InquiryGet

Returns the specified inquiry record.

The following routes are available for this service:
POST,GET/inquiry/get
InquiryGet Parameters:
NameParameterData TypeRequiredDescription
InquiryIdbodystringYesThe ID of the inquiry record
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
InquiryGetResponse Parameters:
NameParameterData TypeRequiredDescription
InquiryformInquiryRecordNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
InquiryRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
InquiryIdformstringNo
CategoryformstringNo
SubjectformstringNo
ProcessformstringNo
UrlformstringNo
LifetimeformintNo
SizeEstimateformintNo
EnabledformboolNo

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.

POST /inquiry/get HTTP/1.1 
Host: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	InquiryId: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Inquiry: 
	{
		Timestamp: 0001-01-01,
		InquiryId: String,
		Category: String,
		Subject: String,
		Process: String,
		Url: String,
		Lifetime: 0,
		SizeEstimate: 0,
		Enabled: False
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}