Needio.Services

<back to all web services

GetServiceRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Service/GetService/{ServiceId}
GetServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ServiceIdpathintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ServiceformServiceDtoNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
ServiceDto Parameters:
NameParameterData TypeRequiredDescription
ServiceIdformintNo
DateRangeformstringNo
StartDateformDateTimeNo
EndDateformDateTimeNo
ServiceStateformServiceStateNo
NotesformstringNo
PostIdformintNo
PostVariantIdformint?No
OfferIdformint?No
ServiceOfferIdformint?No
BuyerIdformintNo
TransIdformint?No
KeyManagementIdformint?No
ServiceOffersformList<ServiceOfferDto>No
ServiceLogsformList<ServiceLogDto>No
ServiceReportsformList<ServiceReportDto>No
TimelineformServiceTimelineNo
AuditedBaseDto Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformint?No
ModifiedDateformDateTime?No
ModifiedByformint?No
ServiceState Enum:
NameValue
WaitingAssignment1
WaitingSalerApproval2
SalerApproved11
SalerRejected12
BuyerCancelled13
KeyObtained15
ServiceStarted17
ServiceFinished18
ReportCreated19
ReportApproved20
BuyerApproved21
SalerAdminRejected42
ServiceOfferDto Parameters:
NameParameterData TypeRequiredDescription
ServiceOfferIdformintNo
PriceformdecimalNo
PriceMinformdecimalNo
PriceMaxformdecimalNo
PriceTypeformServicePriceTypeNo
OfferNotesformstringNo
PostIdformintNo
PostVarianttIdformint?No
ServiceIdformintNo
AlwActformServiceOfferAlwActNo
StateformServiceOfferStateNo
ServicePriceType Enum:
NameValue
Variant0
Fixed1
ServiceOfferAlwAct Enum:
NameValue
RequestOfferButtonVisible1
AddToBasketButtonVisible2
InBasketLabelVisible4
RequestRenewOfferButtonVisible8
ServiceOfferState Enum:
NameValue
New1
BuyerApproved2
BuyerRejected3
Expired4
ServiceLogDto Parameters:
NameParameterData TypeRequiredDescription
ServiceLogIdformintNo
ServiceStateformServiceStateNo
ServiceNoteformstringNo
ServiceIdformintNo
CreationAuditedBaseDto Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformint?No
ServiceReportDto Parameters:
NameParameterData TypeRequiredDescription
ServiceReportIdformintNo
ReportNotesformstringNo
ReportRatingformintNo
ServiceIdformintNo
ServiceTaskIdformintNo
ReportMediasformList<ServiceReportMediaDto>No
SmServiceTaskTitleformstringNo
SmServiceTaskDescriptionformstringNo
ServiceReportMediaDto Parameters:
NameParameterData TypeRequiredDescription
ServiceReportMediaIdformintNo
TitleformstringNo
DescriptionformstringNo
UrlformstringNo
ReportMediaTypeformServiceReportMediaTypeNo
ServiceReportIdformintNo
ServiceReportMediaType Enum:
NameValue
Image0
Video1
ServiceTimeline Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<ServiceTimelineItem>No
ServiceTimelineItem Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
SubtitleformstringNo
MainColorformstringNo
TintColorformstringNo
GetServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ServiceformServiceDtoNo

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

{
	ServiceId: 0,
	start: 2021-10-28T07:54:23.6404106+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Service: 
	{
		ServiceId: 0,
		DateRange: 0001-01-01_0001-01-01,
		StartDate: 0001-01-01,
		EndDate: 0001-01-01,
		ServiceState: 1,
		Notes: String,
		PostId: 0,
		PostVariantId: 0,
		OfferId: 0,
		ServiceOfferId: 0,
		BuyerId: 0,
		TransId: 0,
		KeyManagementId: 0,
		ServiceOffers: 
		[
			{
				ServiceOfferId: 0,
				Price: 0,
				PriceMin: 0,
				PriceMax: 0,
				PriceType: 0,
				OfferNotes: String,
				PostId: 0,
				PostVarianttId: 0,
				ServiceId: 0,
				AlwAct: 1,
				State: 1,
				CreatedDate: 0001-01-01,
				CreatedBy: 0,
				ModifiedDate: 0001-01-01,
				ModifiedBy: 0
			}
		],
		ServiceLogs: 
		[
			{
				ServiceLogId: 0,
				ServiceState: 1,
				ServiceNote: String,
				ServiceId: 0,
				CreatedDate: 0001-01-01,
				CreatedBy: 0
			}
		],
		ServiceReports: 
		[
			{
				ServiceReportId: 0,
				ReportNotes: String,
				ReportRating: 0,
				ServiceId: 0,
				ServiceTaskId: 0,
				ReportMedias: 
				[
					{
						ServiceReportMediaId: 0,
						Title: String,
						Description: String,
						Url: String,
						ReportMediaType: 0,
						ServiceReportId: 0
					}
				],
				SmServiceTaskTitle: String,
				SmServiceTaskDescription: String,
				CreatedDate: 0001-01-01,
				CreatedBy: 0
			}
		],
		Timeline: 
		{
			Items: 
			[
				{
					
				}
			]
		},
		CreatedDate: 0001-01-01,
		CreatedBy: 0,
		ModifiedDate: 0001-01-01,
		ModifiedBy: 0
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}