DocCloud API

<back to all web services

ListUserAssignmentsQuery

Requires Authentication
The following routes are available for this service:
GET/assignmentList user's assignments
AssignmentFilterQuery Parameters:
NameParameterData TypeRequiredDescription
IsAssignedToMeformbool?No
IsDefaultAssignmentformbool?No
IsDoneformbool?No
DueDateFromformDateTime?No
DueDateToformDateTime?No
StatusformList<int>No
TitleformstringNo
DescriptionformstringNo
PaginatedOrderedRequestBase Parameters:
NameParameterData TypeRequiredDescription
OrderByformstringNo
SortTypeformstringNo
PagesformintNo
AmountformintNo
BaseResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MultipleResultformIList<T>No
TotalformintNo
OffsetformintNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
AssignmentDto Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
DescriptionformstringNo
StatusformintNo
DueDateformDateTimeNo
AssignedToformuint?No
RoleIdformuintNo
TemplateIdformulong?No
CompanyDbConfigIdformuintNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo

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 /assignment HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	total: 0,
	offset: 0,
	result: 
	{
		title: String,
		description: String,
		status: 0,
		dueDate: 0001-01-01,
		assignedTo: 0,
		roleId: 0,
		templateId: 0,
		companyDbConfigId: 0,
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}