Net3 API Interface for Customer Portal

<back to all web services

CRMMCompanyTicketsBoard

Requires Authentication
The following routes are available for this service:
POST/crm/tickets/company/board/getRetrieve a list of Tickets for a company on a given service board. The Filter can be used to narrow results.
CRMMCompanyTicketsBoard Parameters:
NameParameterData TypeRequiredDescription
CompanyNamebodystringYes
BoardNamebodystringYes
CRMCompanyBase Parameters:
NameParameterData TypeRequiredDescription
FilterformTypeFilterNo
TypeFilter Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
PageSizeformintNo
ConditionsformList<TypeCondition>No
TypeCondition Parameters:
NameParameterData TypeRequiredDescription
OrderformintNo
StatementLeftformstringNo
StatementOperationformstringNo
StatementRightformstringNo
LogicOperatorformstringNo
ConditionTypingformConditionTypingNo
ConditionParameterTypeformConditionParameterTypeNo
ConditionTyping Enum:
STRING
INT
BOOLEAN
DATETIME
ConditionParameterType Enum:
CONDITION
CHILDCONDITION
CUSTOMFIELDCONDITION
ORDERBY
FIELDS
COLUMNS
CRMResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformObjectNo
ResponseStatusformResponseStatusNo

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 /crm/tickets/company/board/get HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	companyName: String,
	boardName: String,
	filter: 
	{
		page: 0,
		pageSize: 0,
		conditions: 
		[
			{
				order: 0,
				statementLeft: String,
				statementOperation: String,
				statementRight: String,
				logicOperator: String,
				conditionTyping: STRING,
				conditionParameterType: CONDITION
			}
		]
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: {},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}