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

<back to all web services

InquiriesCatalog

Returns a list of inquiry records for use in updating the Winlink catalog.

The following routes are available for this service:
POST,GET/inquiries/catalog
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
InquiriesCatalogResponse Parameters:
NameParameterData TypeRequiredDescription
InquiriesformList<InquiryRecord>No
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /inquiries/catalog HTTP/1.1 
Host: perth.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Inquiries":[{"Timestamp":"\/Date(-62135596800000-0000)\/","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"}}}