DocCloud API

<back to all web services

CostInvoiceCategoryUpdateCommand

Requires Authentication
The following routes are available for this service:
PUT/costinvoicecategoryUpdate Cost Invoice Category
CostInvoiceCategoryUpdateCommand Parameters:
NameParameterData TypeRequiredDescription
IdbodyulongNo
CategoryIdbodyuintNo
CategoryNamebodystringNo
CategoryDescriptionbodystringNo
InvoicePositionbodyList<CostInvoicePositionCategoryDto>No
CostInvoicePositionCategoryDto Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformuintNo
CategoryNameformstringNo
CategoryDescriptionformstringNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo
PostOperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
OperationResult Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ResponseStatusformResponseStatusNo
ResultformObjectNo
IsSuccessformboolNo

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.

PUT /costinvoicecategory HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	categoryId: 0,
	categoryName: String,
	categoryDescription: String,
	invoicePosition: 
	[
		{
			categoryId: 0,
			categoryName: String,
			categoryDescription: String,
			createdById: 0,
			modifiedById: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			id: 0
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	code: FAIL,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	result: {},
	isSuccess: False
}