Needio.Services

<back to all web services

GetTicketListRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/HelpDesk/GetTicketList/
GetTicketListRequest Parameters:
NameParameterData TypeRequiredDescription
StatusqueryTicketStatusesNo
AllYnqueryboolNo
CountqueryintNo
PagequeryintNo
SearchTextquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetTicketListResponse Parameters:
NameParameterData TypeRequiredDescription
TicketListformList<TicketDetailDTO>No
TotalCountformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
TicketDetailDTO Parameters:
NameParameterData TypeRequiredDescription
AssignedToformstringNo
LastUpdateByformstringNo
CurrentStatusSetByformstringNo
OwnerformstringNo
CreatedByformstringNo
CreatedDateformDateTimeOffsetNo
CurrentStatusDateformDateTimeOffsetNo
LastUpdateDateformDateTimeOffsetNo
EventsformList<TicketEventDTO>No
TicketTagsformList<TicketTagDTO>No
ShowAlertformboolNo
TicketDTO Parameters:
NameParameterData TypeRequiredDescription
TicketIdformintNo
TicketTypeformTicketTypesNo
CategoryformTicketCategoriesNo
TitleformstringNo
DetailsformstringNo
IsHtmlformboolNo
TagListformstringNo
StatusformTicketStatusesNo
PriorityformTicketPrioritiesNo
AffectsCustomerformboolNo
PostIdformint?No
TransIdformint?No
StoreIdformint?No
SessionIdformstringNo
UserIdformintNo
ReturnIdformint?No
TicketEventformTicketEventDTONo
TicketTypes Enum:
NameValue
Problem0
Question1
Request2
Proposal3
TicketCategories Enum:
NameValue
General0
Profile1
Post2
Store3
Transaction4
Payment5
Delivery6
Refund7
Chat8
Campaigns9
SSS10
TicketStatuses Enum:
NameValue
Active0
MoreInfo1
Resolved2
Closed3
TicketPriorities Enum:
NameValue
High0
Medium1
Low2
TicketEventDTO Parameters:
NameParameterData TypeRequiredDescription
EventIdformintNo
TicketIdformintNo
EventDescriptionformstringNo
CommentformstringNo
IsHtmlformboolNo
EventByformstringNo
EventByIdformintNo
EventDateformDateTimeNo
MediasformList<MediaDTO>No
MediaDTO Parameters:
NameParameterData TypeRequiredDescription
PostIdformintNo
MediaIdformint?No
MediaTypeformMediaTypesNo
SourceformstringNo
MediaFileNameformstringNo
MediaMimeformstringNo
IsMainformboolNo
RefIdformint?No
OrderNumformintNo
ActionformDBActionNo
IsDeletedformboolNo
FriendlyURLformstringNo
PostVariantA1KeyformstringNo
SourceUrlformstringNo
ActiveYnformboolNo
MediaTypes Enum:
NameValue
icon0
Image1
Video2
Youtube3
Pdf8
File9
ThreeD10
Custom99
DBAction Enum:
NameValue
None0
Insert1
Update2
Delete3
TicketTagDTO Parameters:
NameParameterData TypeRequiredDescription
TicketTagIdformintNo
TagNameformstringNo
TicketIdformintNo
GetTicketListResponse Parameters:
NameParameterData TypeRequiredDescription
TicketListformList<TicketDetailDTO>No
TotalCountformintNo

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

{
	Status: 0,
	AllYn: False,
	Count: 0,
	Page: 0,
	SearchText: String,
	start: 2021-10-25T12:55:39.9168035+03:00,
	DeviceUUID: String,
	APIKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TicketList: 
	[
		{
			AssignedTo: String,
			LastUpdateBy: String,
			CurrentStatusSetBy: String,
			Owner: String,
			CreatedBy: String,
			CreatedDate: 0001-01-01T00:00:00.0000000+00:00,
			CurrentStatusDate: 0001-01-01T00:00:00.0000000+00:00,
			LastUpdateDate: 0001-01-01T00:00:00.0000000+00:00,
			Events: 
			[
				{
					EventId: 0,
					TicketId: 0,
					EventDescription: String,
					Comment: String,
					IsHtml: False,
					EventBy: String,
					EventById: 0,
					EventDate: 0001-01-01,
					Medias: 
					[
						{
							PostId: 0,
							MediaId: 0,
							MediaType: 0,
							Source: String,
							MediaFileName: String,
							MediaMime: String,
							IsMain: False,
							RefId: 0,
							OrderNum: 0,
							Action: 0,
							IsDeleted: False,
							FriendlyURL: String,
							PostVariantA1Key: String,
							SourceUrl: String,
							ActiveYn: False
						}
					]
				}
			],
			TicketTags: 
			[
				{
					TicketTagId: 0,
					TagName: String,
					TicketId: 0
				}
			],
			ShowAlert: False,
			TicketId: 0,
			TicketType: 0,
			Category: 0,
			Title: String,
			Details: String,
			IsHtml: False,
			TagList: String,
			Status: 0,
			Priority: 0,
			AffectsCustomer: False,
			PostId: 0,
			TransId: 0,
			StoreId: 0,
			SessionId: String,
			UserId: 0,
			ReturnId: 0,
			TicketEvent: 
			{
				EventId: 0,
				TicketId: 0,
				EventDescription: String,
				Comment: String,
				IsHtml: False,
				EventBy: String,
				EventById: 0,
				EventDate: 0001-01-01,
				Medias: 
				[
					{
						PostId: 0,
						MediaId: 0,
						MediaType: 0,
						Source: String,
						MediaFileName: String,
						MediaMime: String,
						IsMain: False,
						RefId: 0,
						OrderNum: 0,
						Action: 0,
						IsDeleted: False,
						FriendlyURL: String,
						PostVariantA1Key: String,
						SourceUrl: String,
						ActiveYn: False
					}
				]
			}
		}
	],
	TotalCount: 0,
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	},
	PageInfo: 
	{
		TotalRecordCount: 0,
		TotalPageCount: 0,
		CurrentPage: 0
	}
}