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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CRMMCompanyTicketsBoard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <Filter xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.CRM">
    <d2p1:Conditions>
      <d2p1:TypeCondition>
        <d2p1:ConditionParameterType>CONDITION</d2p1:ConditionParameterType>
        <d2p1:ConditionTyping>STRING</d2p1:ConditionTyping>
        <d2p1:LogicOperator>String</d2p1:LogicOperator>
        <d2p1:Order>0</d2p1:Order>
        <d2p1:StatementLeft>String</d2p1:StatementLeft>
        <d2p1:StatementOperation>String</d2p1:StatementOperation>
        <d2p1:StatementRight>String</d2p1:StatementRight>
      </d2p1:TypeCondition>
    </d2p1:Conditions>
    <d2p1:Page>0</d2p1:Page>
    <d2p1:PageSize>0</d2p1:PageSize>
  </Filter>
  <BoardName>String</BoardName>
  <CompanyName>String</CompanyName>
</CRMMCompanyTicketsBoard>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CRMResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result />
</CRMResponse>