POST api/forms/fullStructure

Gets the full structure of each of the forms provided in the list (If a form has more than one version it gets the structure of the active one).

Request Information

URI Parameters

None.

Body Parameters

The list of form Ids.

FormIdListHolder

Name	Description	Type	Additional information
FormIdList		Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "FormIdList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<FormIdListHolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CWI.Mobile.Domain.DTO">
  <FormIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:short>1</d2p1:short>
    <d2p1:short>2</d2p1:short>
  </FormIdList>
</FormIdListHolder>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FormIdListHolder'.

Response Information

Resource Description

An Http response message with the folliwing status codes: 200 = success (always includes a list of full structures), 400 = bad request (the request is malformed or with invalid data), 404 = not found (this is returned when none of the form id provided is found), 500 = something went wrong (the request was not processed)

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.