Click or drag to resize
DocumentsControllerGetByType Method

[This is preliminary documentation and is subject to change.]

Retrieves all docuements of a given type in a paged format.

Namespace: WebServiceKit.Controllers
Assembly: WebServiceKit (in WebServiceKit.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public IHttpActionResult GetByType(
	Guid guid,
	int pageIndex = 0,
	int pageSize = 100,
	string sortField = "LastModifiedDateTime",
	string sortOrder = "ASC",
	bool update = false
)

Parameters

guid
Type: SystemGuid
Target document type guid.
pageIndex (Optional)
Type: SystemInt32
Which page index you wish to retrieve.
pageSize (Optional)
Type: SystemInt32
Size of the pages you wish to retrieve. This is optional and defaults to 100.
sortField (Optional)
Type: SystemString
The field by which to sort the query
sortOrder (Optional)
Type: SystemString
The order by which to sort the query
update (Optional)
Type: SystemBoolean
Flag to determine if the document should be updated to include any possible model changes that might have occurred since the document was last saved

Return Value

Type: IHttpActionResult
200 OK and the serialized documents instances will be returned if the document type guid is found, otherwise 404.
Remarks
The document instances are formatted using XML or JSON depending on the client request. Call requires a valid login token. Page size must between 1 and 1000. Supported sort fields are LastModifiedDateTime and CreatedDateTime. Accepted sort order format is ASC or DESC. HTTP Method: GET
[Route("api/documents/types/{guid}")]
Sample: api/documents/types/<guid>?pageIndex=0&pageSize=100&sortField=LastModifiedDateTime&sortOrder=ASC&update=false
See Also