term_condition

A term or condition of an account or contract.

Handler Class:

com.ibm.commerce.rest.contract.handler.TermConditionHandler

Method Summary

HTTP MethodPathDescription
GET/store/{storeId}/term_condition?q={q}Finds terms and conditions by a query. See each query for details on input and output.
GET/store/{storeId}/term_condition?q=displayCustomizationTCFinds the display customization TC of the account associated with the current user.
GET/store/{storeId}/term_condition/{termConditionId}Finds a term condition by its ID.

Method Details

GET /store/{storeId}/term_condition?q={q}

Finds terms and conditions by a query. See each query for details on input and output.

Handler Method:

findByQuery

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
404The specified resource couldn't be found.
500Internal server error. Additional details will be contained on the server logs.

GET /store/{storeId}/term_condition?q=displayCustomizationTC

Finds the display customization TC of the account associated with the current user.

Handler Method:

findDisplayCustomizationTC

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
qThe query name.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

com.ibm.commerce.tools.contract.beans.DisplayCustomizationTCDataBean_IBM_Store_Details


Example

Request:
GET /wcs/resources/store/10801/term_condition?q=displayCustomizationTC
HTTP Status Code:

200

Response:
{
	"resultList": [
		{
			"accountId": 10022,
			"attachmentURL": [
				"",
				"images\/logoAccount1.gif"
			],
			"displayText": [
				""
			],
			"hasDisplayLogo": true,
			"hasDisplayText": false,
			"languageId": -1,
			"storeId": 10801,
			"userId": -1004
		}
	]
}

GET /store/{storeId}/term_condition/{termConditionId}

Finds a term condition by its ID.

Handler Method:

findByTermConditionId

Secure Call Mandatory:

false

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
termConditionIdThe term condition ID.pathstringtrueN/A
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
400Bad request. Some of the inputs provided to the request aren't valid.
401Not authenticated. The user session isn't valid.
403The user isn't authorized to perform the specified request.
404The specified resource couldn't be found.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details


Example

Request:
GET /wcs/resources/store/10001/term_condition/10003
HTTP Status Code:

200

Response:
{
	"resultList": [
		{
			"XMLString": "    <TermCondition type = \"CatalogFilterTC\" mandatory = \"false\" changeable = \"false\" >\r\n        <Property name = \"catalogFilterId\"  value = \"10001\" \/>\r\n    <\/TermCondition>\r\n",
			"changeableFlag": 0,
			"mandatoryFlag": 0,
			"participants": [
			],
			"policies": [
			],
			"tcSequence": 3,
			"tcSubType": "CatalogFilterTC",
			"termConditionId": "10003",
			"timeCreated": "2014-10-29 19:06:18.884",
			"timeUpdated": "2014-10-29 19:06:18.884",
			"tradingId": "10001"
		}
	]
}

Data Type Details

com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details

Properties:
NameData TypeRequired
tcSequencestringfalse
policiescom.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.policies arrayfalse
participantscom.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.participants arrayfalse
mandatoryFlagstringfalse
changeableFlagstringfalse
XMLStringstringfalse
termConditionIdstringfalse
timeCreatedstringfalse
tcSubTypestringfalse
tradingIdstringfalse
timeUpdatedstringfalse

com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.participants

Properties:
NameData TypeRequired
roleIdstringfalse
memberIdstringfalse
termConditionIdstringfalse
timeCreatedstringfalse
tradingIdstringfalse
informationstringfalse
timeUpdatedstringfalse
participantIdstringfalse

com.ibm.commerce.contract.beans.ExtendedTermConditionDataBean_IBM_Store_Details.policies

Properties:
NameData TypeRequired
startDatestringfalse
propertiesstringfalse
endDatestringfalse
typestringfalse
storeIdstringfalse
policyNamestringfalse
policyIdstringfalse
ownerIdstringfalse

com.ibm.commerce.tools.contract.beans.DisplayCustomizationTCDataBean_IBM_Store_Details

Properties:
NameData TypeRequired
languageIdstringfalse
hasDisplayLogostringfalse
hasDisplayTextstringfalse
userIdstringfalse
accountIdstringfalse
storeIdstringfalse
attachmentURLstring arrayfalse
displayTextstring arrayfalse