TeleportService

<back to all web services

OfferGetById

The following routes are available for this service:
GET, POST/OfferGetById/{Id}
OfferGetById Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYes
OfferGetByIdResponse Parameters:
NameParameterData TypeRequiredDescription
ErrCodeformintNo
OfferformOfferDocumentNo
ResponseStatusformResponseStatusNo
OfferDocument Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
UserNameformstringNo
TeamformstringNo
NumformstringNo
CreateDateformDateTimeNo
UpdateDateformDateTimeNo
CompanyformOfferCompanyNo
ContractformOfferContractNo
SumformdecimalNo
CommentformstringNo
TableformOfferTableNo
OfferCompany Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
OfferContract Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DateformDateTimeNo
NumberformstringNo
NameformstringNo
OfferTable Parameters:
NameParameterData TypeRequiredDescription
ColumnsformOfferTableColumnsNo
RowsformList<OfferTableRow>No
OfferTableColumns Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringNo
IdformstringNo
UidformstringNo
CodeformstringNo
ArticleformstringNo
NameformstringNo
UnitformstringNo
QuantityformstringNo
ConfirmedformstringNo
PriceformstringNo
SumformstringNo
TrademarkformstringNo
AdditionalColumnsformList<OfferTableColumn>No
OfferTableColumn Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
HeaderformstringNo
TypeformstringNo
RequiredformboolNo
ValueformstringNo
EnumValuesformList<string>No
OfferTableRow Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringNo
IdformstringNo
UidformstringNo
CodeformstringNo
ArticleformstringNo
NameformstringNo
UnitformstringNo
QuantityformdecimalNo
ConfirmedformdecimalNo
PriceformdecimalNo
SumformdecimalNo
TrademarkformstringNo
AdditionalColumnsValuesformList<OfferTableRowValue>No
OfferTableRowValue Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo

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.

POST /OfferGetById/{Id} HTTP/1.1 
Host: wbs.e-teleport.ru 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrCode: 0,
	Offer: 
	{
		Id: String,
		UserName: String,
		Team: String,
		Num: String,
		CreateDate: 0001-01-01,
		UpdateDate: 0001-01-01,
		Company: 
		{
			Id: String,
			Name: String
		},
		Contract: 
		{
			Id: String,
			Date: 0001-01-01,
			Number: String,
			Name: String
		},
		Sum: 0,
		Comment: String,
		Table: 
		{
			Columns: 
			{
				UserName: String,
				Id: String,
				Uid: String,
				Code: String,
				Article: String,
				Name: String,
				Unit: String,
				Quantity: String,
				Confirmed: String,
				Price: String,
				Sum: String,
				Trademark: String,
				AdditionalColumns: 
				[
					{
						Name: String,
						Header: String,
						Type: String,
						Required: False,
						Value: String,
						EnumValues: 
						[
							String
						]
					}
				]
			},
			Rows: 
			[
				{
					UserName: String,
					Id: String,
					Uid: String,
					Code: String,
					Article: String,
					Name: String,
					Unit: String,
					Quantity: 0,
					Confirmed: 0,
					Price: 0,
					Sum: 0,
					Trademark: String,
					AdditionalColumnsValues: 
					[
						{
							Name: String,
							Value: String
						}
					]
				}
			]
		}
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}