Needio.Services

<back to all web services

GetServiceListRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Service/GetServiceList
GetServiceListRequest Parameters:
NameParameterData TypeRequiredDescription
ServiceIdqueryint?No
KeyStatequeryServiceKeyState?No
ActiveYnquerybool?No
UserAddressIdqueryint?No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetServiceListResponse Parameters:
NameParameterData TypeRequiredDescription
ServicesformList<ServiceDto>No
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
CreatedOnformDateTimeNo
CreatedByformint?No
ModifiedOnformDateTime?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
CreatedOnformDateTimeNo
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
ServiceKeyState Enum:
NameValue
AtHome110
Waiting111
NotSent113
Shipped116
AtOffice121
AtService122
WaitingReturn131
Returning136
Returned141
GetServiceListResponse Parameters:
NameParameterData TypeRequiredDescription
ServicesformList<ServiceDto>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Service/GetServiceList HTTP/1.1 
Host: baseservices.needion.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ServiceId":0,"KeyState":0,"ActiveYn":false,"UserAddressId":0,"start":"\/Date(1638623656672+0300)\/","DeviceUUID":"String","APIKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Services":[{"ServiceId":0,"DateRange":"0001-01-01_0001-01-01","StartDate":"\/Date(-62135596800000-0000)\/","EndDate":"\/Date(-62135596800000-0000)\/","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,"CreatedOn":"\/Date(-62135596800000-0000)\/","CreatedBy":0,"ModifiedOn":"\/Date(-62135596800000-0000)\/","ModifiedBy":0}],"ServiceLogs":[{"ServiceLogId":0,"ServiceState":1,"ServiceNote":"String","ServiceId":0,"CreatedOn":"\/Date(-62135596800000-0000)\/","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","CreatedOn":"\/Date(-62135596800000-0000)\/","CreatedBy":0}],"Timeline":{"Items":[{}]},"CreatedOn":"\/Date(-62135596800000-0000)\/","CreatedBy":0,"ModifiedOn":"\/Date(-62135596800000-0000)\/","ModifiedBy":0}],"Result":false,"ResMessage":"String","Error":{"ErrorYn":false,"ErrorCode":"String","ErrorDescription":"String"},"PageInfo":{"TotalRecordCount":0,"TotalPageCount":0,"CurrentPage":0}}