DocCloud API

<back to all web services

GetSupplyDemandQuery

Requires Authentication
The following routes are available for this service:
GET/supplydemand/{id}
GetSupplyDemandQuery Parameters:
NameParameterData TypeRequiredDescription
IdpathulongNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
SupplyDemandDto Parameters:
NameParameterData TypeRequiredDescription
ProviderCompanyIdformuintNo
ClientCompanyIdformuintNo
StatusformintNo
CurrencyIdformuintNo
CurrencyformstringNo
ClientNameformstringNo
ClientVatIdformstringNo
ClientStreetNameformstringNo
ClientStreetNumberformstringNo
ClientFlatNumberformstringNo
ClientPostalCodeformstringNo
ClientTownformstringNo
ClientCountryIdformintNo
ClientCountryformstringNo
ClientEmailformstringNo
ClientPhoneformstringNo
IsReceiverDiffrentformboolNo
ReceiverNameformstringNo
ReceiverVatIdformstringNo
ReceiverStreetNameformstringNo
ReceiverStreetNumberformstringNo
ReceiverFlatNumberformstringNo
ReceiverPostalCodeformstringNo
ReceiverTownformstringNo
ReceiverCountryIdformint?No
ReceiverCountryformstringNo
ReceiverEmailformstringNo
ReceiverPhoneformstringNo
PositionsformList<SupplyDemandPositionDto>No
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo
SupplyDemandPositionDto Parameters:
NameParameterData TypeRequiredDescription
SupplyDemandIdformulongNo
ProductIdformulongNo
CodeformstringNo
DescriptionformstringNo
QuantityformuintNo
IsDeletedformboolNo

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

{
	result: 
	{
		providerCompanyId: 0,
		clientCompanyId: 0,
		status: 0,
		currencyId: 0,
		currency: String,
		clientName: String,
		clientVatId: String,
		clientStreetName: String,
		clientStreetNumber: String,
		clientFlatNumber: String,
		clientPostalCode: String,
		clientTown: String,
		clientCountryId: 0,
		clientCountry: String,
		clientEmail: String,
		clientPhone: String,
		isReceiverDiffrent: False,
		receiverName: String,
		receiverVatId: String,
		receiverStreetName: String,
		receiverStreetNumber: String,
		receiverFlatNumber: String,
		receiverPostalCode: String,
		receiverTown: String,
		receiverCountryId: 0,
		receiverCountry: String,
		receiverEmail: String,
		receiverPhone: String,
		positions: 
		[
			{
				supplyDemandId: 0,
				productId: 0,
				code: String,
				description: String,
				quantity: 0,
				isDeleted: False,
				createdById: 0,
				modifiedById: 0,
				createdDate: 0001-01-01,
				modifiedDate: 0001-01-01,
				id: 0
			}
		],
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}