Needio.Services

<back to all web services

GetOfferRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Service/GetOffer/{OfferId}
GetOfferRequest Parameters:
NameParameterData TypeRequiredDescription
OfferIdpathintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetOfferResponse Parameters:
NameParameterData TypeRequiredDescription
OfferformOfferDtoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
OfferDto Parameters:
NameParameterData TypeRequiredDescription
OfferIdformintNo
ExtensionDataformstringNo
OfferStateformOfferStateNo
OfferPriceformdecimalNo
BuyerNotesformstringNo
SellerNotesformstringNo
PostIdformintNo
KeyManagementIdformint?No
ServiceOfferIdformint?No
BuyerIdformintNo
AssignedToIdformint?No
StoreIdformint?No
ServiceIdformint?No
OfferLogsformList<OfferLogDto>No
TimelineformServiceTimelineNo
AuditedBaseDto Parameters:
NameParameterData TypeRequiredDescription
CreatedOnformDateTimeNo
CreatedByformint?No
ModifiedOnformDateTime?No
ModifiedByformint?No
OfferState Enum:
NameValue
WaitingAssignment1
WaitingApproval2
SalerApproved11
SalerRejected12
BuyerCancelled13
KeyObtained15
OfferTaskStarted17
OfferTaskFinished18
ReportCreated19
ReportApproved20
BuyerApproved21
BuyerRejected22
SalerAdminRejected42
OfferLogDto Parameters:
NameParameterData TypeRequiredDescription
OfferLogIdformintNo
OfferStateformOfferStateNo
NoteformstringNo
OfferIdformintNo
CreationAuditedBaseDto Parameters:
NameParameterData TypeRequiredDescription
CreatedOnformDateTimeNo
CreatedByformint?No
ServiceTimeline Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<ServiceTimelineItem>No
ServiceTimelineItem Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
SubtitleformstringNo
MainColorformstringNo
TintColorformstringNo
GetOfferResponse Parameters:
NameParameterData TypeRequiredDescription
OfferformOfferDtoNo

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 /Service/GetOffer/{OfferId} HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	OfferId: 0,
	start: 2021-11-28T15:01:34.6575615+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offer: 
	{
		OfferId: 0,
		ExtensionData: String,
		OfferState: 1,
		OfferPrice: 0,
		BuyerNotes: String,
		SellerNotes: String,
		PostId: 0,
		KeyManagementId: 0,
		ServiceOfferId: 0,
		BuyerId: 0,
		AssignedToId: 0,
		StoreId: 0,
		ServiceId: 0,
		OfferLogs: 
		[
			{
				OfferLogId: 0,
				OfferState: 1,
				Note: String,
				OfferId: 0,
				CreatedOn: 0001-01-01,
				CreatedBy: 0
			}
		],
		Timeline: 
		{
			Items: 
			[
				{
					
				}
			]
		},
		CreatedOn: 0001-01-01,
		CreatedBy: 0,
		ModifiedOn: 0001-01-01,
		ModifiedBy: 0
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}