Get All Issues With Filter
Get All Issues With Filter

This method returns all issues for the specified company and the business channel. The client makes a PUT request providing input parameters CompanyId, BusinessChannelID and LanguageID. The output will be either in json or xml format depending on the request type.

Name Value
REST-API METHOD GET ALL ISSUES WITH FILTER
HTTP METHOD PUT
RESPONSE TYPE XML
URL https://api.csm.next4biz.net/services/IssueService/{CompanyID}/issueswithfilter.json/{businessChannelID}/{langID}https://api.csm.next4biz.net/services/IssueService/{CompanyID}/issueswithfilter.xml/{businessChannelID}/{langID}
REQUEST HEAD Authorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+json,application/json;q=0.9,*/*;q=0.8 Content-Type: application/jsonAuthorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Content-Type: application/xml
  • XML
  • JSON
ENDPOINT DEFINITION
PUT
REQUEST BODY
                                    
                                        <IssueFilter>
	<StartDate>{StartDate}</StartDate>
	<EndDate>{EndDate}</EndDate>
	<PageIndex>{PageIndex}</PageIndex>
	<IssueCountForPage>{IssueCountForPage}</IssueCountForPage>
</IssueFilter>                                    
                                
                                                                        
                                        {
    "StartDate": "{StartDate}",
    "EndDate": "{EndDate}",
    "PageIndex": "{PageIndex}",
    "IssueCountForPage": "{IssueCountForPage}"
}                                    
                                                                    
RESPONSE BODY
                                    
                                        <IssueList>
<IssueCount>{IssueCount}</IssueCount>
<Issues>
    <Issue>
        <BusinessChannelID>{BusinessChannelID}</BusinessChannelID>
        <Category>
                <CategoryID>{CategoryID}</CategoryID>
                <CategoryName>{CategoryName}</CategoryName>
                <ParentCategoryID>{ParentCategoryID}</ParentCategoryID>
                <CustomFields/>
            </Category>
        <ClosureDate xsi:nil="true"/>
        <CreationDate>{CreationDate}</CreationDate>
        <CustomerFields>
                <CustomerField>
                    <CustomerFieldID>{CustomerFieldID}</CustomerFieldID>
                    <CustomerFieldName>{CustomerFieldName}</CustomerFieldName>
                    <CustomerFieldValueID>{CustomerFieldValueID}</CustomerFieldValueID>
                    <CustomerFieldValues/>
                    <CustomerFieldValueText>{CustomerFieldValueText}</CustomerFieldValueText>
                    <FieldType>{FieldType}</FieldType>
                    <IssueID>{IssueID}</IssueID>
                </CustomerField>
            </CustomerFields>
        <CustomFields>
                <CustomField CustomFieldID="{Value}">
                    <CustomFieldName>{CustomFieldName}</CustomFieldName>
                    <CustomFieldType>{CustomFieldType}</CustomFieldType>
                    <CustomFieldValue>{CustomFieldValue}</CustomFieldValue>
                    <CustomFieldValueID>{CustomFieldValueID}</CustomFieldValueID>
                    <CustomFieldValues/>
                    <CustomFieldValueText>{CustomFieldValueText}</CustomFieldValueText>
                    <IssueID>{IssueID}</IssueID>
                    <IsRequiredOnIssueEntry xsi:nil="true"/>
                    <IsRequiredOnIssueForward xsi:nil="true"/>
                    <IsRequiredOnIssueResolve xsi:nil="true"/>
                    <IsRequiredOnIssueRespond xsi:nil="true"/>
                    <IsRequiredOnIssueClose xsi:nil="true"/>
                    <IsRequiredOnIssueCancel xsi:nil="true"/>
                </CustomField>
            </CustomFields>
        <IssueDate>{IssueDate}</IssueDate>
        <IssueID>{IssueID}</IssueID>
        <IssueLifeCycleList>
                <IssueLifeCycleItem>
                    <ActionEndDate>{ActionEndDate}</ActionEndDate>
                    <ActionStartDate>{ActionStartDate}</ActionStartDate>
                    <EscalationTime>{EscalationTime}</EscalationTime>
                    <EndDate/>
                    <IssueID>{IssueID}</IssueID>
                    <IssueLifeCycleID>{IssueLifeCycleID}</IssueLifeCycleID>
                    <ResolutionStatus>
                        <ResolutionStatusID>{ResolutionStatusID}</ResolutionStatusID>
                        <ResolutionStatusName>{ResolutionStatusName}</ResolutionStatusName>
                        <StatusID>{StatusID}</StatusID>
                        <CustomerResolutionStatusID>{CustomerResolutionStatusID}</CustomerResolutionStatusID>
                    </ResolutionStatus>
                    <StartDate>{StartDate}</StartDate>
                    <UserID>{UserID}</UserID>
            </IssueLifeCycleItem>
        </IssueLifeCycleList>
        <IssueNotes/>
        <Issuer>
            <UserID>{UserID}</UserID>
            <Name>{Name}</Name>
            <Surname>{Surname}</Surname>
            <UserBusinessChannelID>{UserBusinessChannelID}</UserBusinessChannelID>
            <UserName/>
            <IsBuiltIn>{IsBuiltIn}</IsBuiltIn>
            <Roles/>
            <UserGroups/>
            <UserType>{UserType}</UserType>
        </Issuer>
        <IssuerDescription/>
        <IssueReasonID>{IssueReasonID}</IssueReasonID>
        <IssueType>
            <IssueTypeID>{IssueTypeID}</IssueTypeID>
            <IssueTypeName>{IssueTypeName}</IssueTypeName>
        </IssueType>
        <PreferredReturnMethods/>
        <RelatedInventory/>
        <ResolutionDate/>
        <ResolutionStatus>
            <ResolutionStatusID>{ResolutionStatusID}</ResolutionStatusID>
            <ResolutionStatusName>{ResolutionStatusName}</ResolutionStatusName>
            <StatusID>{StatusID}</StatusID>
            <CustomerResolutionStatusID>{CustomerResolutionStatusID}</CustomerResolutionStatusID>
        </ResolutionStatus>
        <ResolutionTypeID>{ResolutionTypeID}</ResolutionTypeID>
        <UsedResponseContactMethods/>
        <User>
            <UserID>{UserID}</UserID>
            <Name>{Name}</Name>
            <Surname>{Surname}</Surname>
            <UserBusinessChannelID>{UserBusinessChannelID}</UserBusinessChannelID>
            <UserName>{UserName}</UserName>
            <IsBuiltIn>{IsBuiltIn}</IsBuiltIn>
            <Roles/>
            <UserGroups/>
            <UserType>{UserType}</UserType>
        </User>
        <CompanyId>{CompanyId}</CompanyId>
        <LastActionDate/>
    </Issue>
</Issues>
<PageCount>{PageCount}</PageCount>
<PageIndex>{PageIndex}</PageIndex>
<PageIssueCount>{PageIssueCount}</PageIssueCount>
</IssueList>                                    
                                
                                                                        
                                        {
    "IssueCount": "{IssueCount}",
    "Issues": {
        "Issue": {
            "BusinessChannelID": "{BusinessChannelID}",
            "Category": {
                "CategoryID": "{CategoryID}",
                "CategoryName": "{CategoryName}",
                "ParentCategoryID": "{ParentCategoryID}",
                "CustomFields": {}
            },
            "ClosureDate": {},
            "CreationDate": "{CreationDate}",
            "CustomerFields": {
                "CustomerField": {
                    "CustomerFieldID": "{CustomerFieldID}",
                    "CustomerFieldName": "{CustomerFieldName}",
                    "CustomerFieldValueID": "{CustomerFieldValueID}",
                    "CustomerFieldValues": {},
                    "CustomerFieldValueText": "{CustomerFieldValueText}",
                    "FieldType": "{FieldType}",
                    "IssueID": "{IssueID}"
                }
            },
            "CustomFields": {
                "CustomField": {
                    "CustomFieldID": "{Value}",
                    "CustomFieldName": "{CustomFieldName}",
                    "CustomFieldType": "{CustomFieldType}",
                    "CustomFieldValue": "{CustomFieldValue}",
                    "CustomFieldValueID": "{CustomFieldValueID}",
                    "CustomFieldValues": {},
                    "CustomFieldValueText": "{CustomFieldValueText}",
                    "IssueID": "{IssueID}",
                    "IsRequiredOnIssueEntry": {},
                    "IsRequiredOnIssueForward": {},
                    "IsRequiredOnIssueResolve": {},
                    "IsRequiredOnIssueRespond": {},
                    "IsRequiredOnIssueClose": {},
                    "IsRequiredOnIssueCancel": {}
                }
            },
            "IssueDate": "{IssueDate}",
            "IssueID": "{IssueID}",
            "IssueLifeCycleList": {
                "IssueLifeCycleItem": {
                    "ActionEndDate": "{ActionEndDate}",
                    "ActionStartDate": "{ActionStartDate}",
                    "EscalationTime": "{EscalationTime}",
                    "EndDate": {},
                    "IssueID": "{IssueID}",
                    "IssueLifeCycleID": "{IssueLifeCycleID}",
                    "ResolutionStatus": {
                        "ResolutionStatusID": "{ResolutionStatusID}",
                        "ResolutionStatusName": "{ResolutionStatusName}",
                        "StatusID": "{StatusID}",
                        "CustomerResolutionStatusID": "{CustomerResolutionStatusID}"
                    },
                    "StartDate": "{StartDate}",
                    "UserID": "{UserID}"
                }
            },
            "IssueNotes": {},
            "Issuer": {
                "UserID": "{UserID}",
                "Name": "{Name}",
                "Surname": "{Surname}",
                "UserBusinessChannelID": "{UserBusinessChannelID}",
                "UserName": {},
                "IsBuiltIn": "{IsBuiltIn}",
                "Roles": {},
                "UserGroups": {},
                "UserType": "{UserType}"
            },
            "IssuerDescription": {},
            "IssueReasonID": "{IssueReasonID}",
            "IssueType": {
                "IssueTypeID": "{IssueTypeID}",
                "IssueTypeName": "{IssueTypeName}"
            },
            "PreferredReturnMethods": {},
            "RelatedInventory": {},
            "ResolutionDate": {},
            "ResolutionStatus": {
                "ResolutionStatusID": "{ResolutionStatusID}",
                "ResolutionStatusName": "{ResolutionStatusName}",
                "StatusID": "{StatusID}",
                "CustomerResolutionStatusID": "{CustomerResolutionStatusID}"
            },
            "ResolutionTypeID": "{ResolutionTypeID}",
            "UsedResponseContactMethods": {},
            "User": {
                "UserID": "{UserID}",
                "Name": "{Name}",
                "Surname": "{Surname}",
                "UserBusinessChannelID": "{UserBusinessChannelID}",
                "UserName": "{UserName}",
                "IsBuiltIn": "{IsBuiltIn}",
                "Roles": {},
                "UserGroups": {},
                "UserType": "{UserType}"
            },
            "CompanyId": "{CompanyId}",
            "LastActionDate": {}
        }
    },
    "PageCount": "{PageCount}",
    "PageIndex": "{PageIndex}",
    "PageIssueCount": "{PageIssueCount}"
}