DocCloud API

<back to all web services

UpdateInvoiceWarrantyCardCommand

Requires Authentication
The following routes are available for this service:
PUT/invoicewarrantycard/{id}
UpdateInvoiceWarrantyCardCommand Parameters:
NameParameterData TypeRequiredDescription
IdpathuintNo
TownbodystringNo
IssueDatebodyDateTimeNo
PositionsbodyList<InvoiceWarrantyCardPositionDto>No
ProviderbodyShortRecipientDtoNo
ReceiverbodyShortRecipientDtoNo
InvoiceWarrantyCardPositionDto Parameters:
NameParameterData TypeRequiredDescription
WarrantyCardIdformulongNo
DescriptionformstringNo
WeightformdecimalNo
QuantityformintNo
SerialNumberformstringNo
IsDeletedformboolNo
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo
ShortRecipientDto Parameters:
NameParameterData TypeRequiredDescription
IdformuintNo
CatIdformuintNo
NameformstringNo
VatIdformstringNo
StreetNameformstringNo
StreetNumberformstringNo
FlatNumberformstringNo
PostalCodeformstringNo
TownformstringNo
CountryIdformintNo
IsoCountryformstringNo
CountryformstringNo
EmailformstringNo
PhoneformstringNo
BankNameformstringNo
BankAccountNbformstringNo
IsActualformboolNo
DefaultCurrencyIdformuintNo
DefaultCurrencyformstringNo
CategoryIdformuintNo
CategoryNameformstringNo
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 /invoicewarrantycard/{id} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	town: String,
	issueDate: 0001-01-01,
	positions: 
	[
		{
			warrantyCardId: 0,
			description: String,
			weight: 0,
			quantity: 0,
			serialNumber: String,
			isDeleted: False,
			createdById: 0,
			modifiedById: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			id: 0
		}
	],
	provider: 
	{
		id: 0,
		catId: 0,
		name: String,
		vatId: String,
		streetName: String,
		streetNumber: String,
		flatNumber: String,
		postalCode: String,
		town: String,
		countryId: 0,
		isoCountry: String,
		country: String,
		email: String,
		phone: String,
		bankName: String,
		bankAccountNb: String,
		isActual: False,
		defaultCurrencyId: 0,
		defaultCurrency: String,
		categoryId: 0,
		categoryName: String
	},
	receiver: 
	{
		id: 0,
		catId: 0,
		name: String,
		vatId: String,
		streetName: String,
		streetNumber: String,
		flatNumber: String,
		postalCode: String,
		town: String,
		countryId: 0,
		isoCountry: String,
		country: String,
		email: String,
		phone: String,
		bankName: String,
		bankAccountNb: String,
		isActual: False,
		defaultCurrencyId: 0,
		defaultCurrency: String,
		categoryId: 0,
		categoryName: String
	}
}
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
}