organization

This class provides RESTful services to register an organization, to get or update organization information.

Handler Class:

com.ibm.commerce.rest.member.handler.OrganizationHandler

Method Summary

HTTP MethodPathDescription
GET/store/{storeId}/organizationThis allows an administrator to find organizations that he/she can administer.
GET/store/{storeId}/organizationThis allows an administrator to find organizations that he/she can administer.
GET/store/{storeId}/organization?q={q}This allows an administrator to find organizations based on query name. See each query for details on input and output.
GET/store/{storeId}/organization?q=organizationsICanAdminThis allows an administrator to find organizations that he/she can administer.
GET/store/{storeId}/organization?q=rolesICanAssignInOrgThis allows an administrator to find roles that he/she can assign in organizations.
GET/store/{storeId}/organization/{organizationId}This allows an administrator to find organization information by organization identifier.
GET/store/{storeId}/organization/{organizationId}This allows an administrator to find organization information by organization identifier.
GET/store/{storeId}/organization/{organizationId}This allows an administrator to find organization information by organization identifier.
GET/store/{storeId}/organization/{organizationId}This allows an administrator to find organization information by organization identifier.
GET/store/{storeId}/organization/{organizationId}This allows an administrator to find organization information by organization identifier.
GET/store/{storeId}/organization/{organizationId}This allows an administrator to find organization information by organization identifier.
POST/store/{storeId}/organizationThis allows an administrator to register an organization.
POST/store/{storeId}/organization/{organizationId}?action={action}Performs an action on an organization. See each action for details on input and output.
POST/store/{storeId}/organization/{organizationId}?action=assignRoleThis allows an administrator to assign role(s) to an organization.
POST/store/{storeId}/organization/{organizationId}?action=unassignRoleThis allows an administrator to unassign role(s) from an organization.
POST/store/{storeId}/organization/{organizationId}?action=updateApprovalGroupsUpdates approval group.
POST/store/{storeId}/organization/buyerRegisters a buyer organization and a buyer organization administrator.
PUT/store/{storeId}/organization/{organizationId}This allows an administrator to update information of an organization.

Method Details

GET /store/{storeId}/organization

This allows an administrator to find organizations that he/she can administer.

Handler Method:

organizationsICanAdminWOrganizationListShortSummaryProfileName

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_List_Summaryquerystringfalsefalse
orgNameThe organization name.querystringfalsefalse
parentOrgNameThe parent organization name.querystringfalsefalse
startIndexThe starting index of the result.querystringfalsefalse
maxResultsThe maximum number of results to be returned.querystringfalsefalse
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.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Short_Summary

GET /store/{storeId}/organization

This allows an administrator to find organizations that he/she can administer.

Handler Method:

organizationsICanAdminWOrganizationListDetailsProfileName

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_List_Summaryquerystringfalsefalse
orgNameThe organization name.querystringfalsefalse
parentOrgNameThe parent organization name.querystringfalsefalse
startIndexThe starting index of the result.querystringfalsefalse
maxResultsThe maximum number of results to be returned.querystringfalsefalse
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.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details

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

This allows an administrator to find organizations based on query name. See each query for details on input and output.

Handler Method:

findByQuery

Secure Call Mandatory:

true

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.

GET /store/{storeId}/organization?q=organizationsICanAdmin

This allows an administrator to find organizations that he/she can administer.

Handler Method:

organizationsICanAdmin

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_List_Summaryquerystringfalsefalse
orgNameThe organization name.querystringfalsefalse
parentOrgNameThe parent organization name.querystringfalsefalse
qThe query name.querystringtruefalse
startIndexThe starting index of the result.querystringfalsefalse
maxResultsThe maximum number of results to be returned.querystringfalsefalse
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.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Summary


Example

Request:
GET /wcs/resources/store/10801/organization?q=organizationsICanAdmin&orgName=%2522
HTTP Status Code:

200

Response:
{
	"organizationDataBeans": [
		{
			"businessCategory": null,
			"description": null,
			"displayName": "%22",
			"distinguishedName": "ou=aurora,o=seller organization,o=root organization",
			"legalId": null,
			"memberId": "7000000000000000002",
			"orgEntityType": "OU",
			"organizationId": "7000000000000000002",
			"organizationName": "%22",
			"parentMemberId": "7000000000000000001",
			"state": "1",
			"status": 0,
			"type": "OrganizationBean"
		},
		{
			"businessCategory": null,
			"description": null,
			"displayName": "%22",
			"distinguishedName": "o=%22,o=root organization",
			"legalId": null,
			"memberId": "7000000000000000917",
			"orgEntityType": "O",
			"organizationId": "7000000000000000917",
			"organizationName": "%22",
			"parentMemberId": "-2001",
			"state": "0",
			"status": 0,
			"type": "OrganizationBean"
		}
	],
	"pageNumber": 1,
	"pageSize": "500",
	"recordSetCompleteIndicator": true,
	"recordSetCount": 2,
	"recordSetTotal": 2
}

GET /store/{storeId}/organization?q=rolesICanAssignInOrg

This allows an administrator to find roles that he/she can assign in organizations.

Handler Method:

rolesICanAssignInOrg

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query.querystringfalsefalse
qThe query name.querystringtruefalse
orgIdThe organization identifier.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.user.beans.RoleAssignmentDataBean_IBM_Roles_To_Assign_Details


Example

Request:
GET /wcs/resources/store/10801/organization?q=rolesICanAssignInOrg&orgId=12345
HTTP Status Code:

200

Response:
{
	"roleDataBeans": [
	]
}

GET /store/{storeId}/organization/{organizationId}

This allows an administrator to find organization information by organization identifier.

Handler Method:

findByOrganizationId

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summaryquerystringfalsefalse
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.user.beans.OrganizationDataBean_IBM_Organization_Summary


Example

Request:
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
HTTP Status Code:

200

Response:
{
	"addressBook": [
	],
	"businessCategory": null,
	"contactInfo": {
		"address1": "",
		"address2": "",
		"address3": "",
		"addressId": "-2000",
		"addressType": "",
		"city": "",
		"country": "",
		"countryDisplayName": "",
		"email1": "",
		"email2": "",
		"firstName": "",
		"lastName": "",
		"middleName": "",
		"mobilePhone1": "",
		"nickName": "Default Organization",
		"organizationName": "",
		"phone1": "",
		"phone2": "",
		"state": "",
		"stateProvDisplayName": "",
		"zipCode": ""
	},
	"description": null,
	"displayName": "Default Organization",
	"organizationDisplayName": "Default Organization (Root Organization)",
	"organizationId": "-2000",
	"organizationName": "Default Organization",
	"state": "1",
	"status": 0
}

GET /store/{storeId}/organization/{organizationId}

This allows an administrator to find organization information by organization identifier.

Handler Method:

findByOrganizationIdWOrganizationShortSummaryProfilenName

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summaryquerystringfalsefalse
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.user.beans.OrganizationDataBean_IBM_Organization_Short_Summary


Example

Request:
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
HTTP Status Code:

200

Response:
{
	"addressBook": [
	],
	"businessCategory": null,
	"contactInfo": {
		"address1": "",
		"address2": "",
		"address3": "",
		"addressId": "-2000",
		"addressType": "",
		"city": "",
		"country": "",
		"countryDisplayName": "",
		"email1": "",
		"email2": "",
		"firstName": "",
		"lastName": "",
		"middleName": "",
		"mobilePhone1": "",
		"nickName": "Default Organization",
		"organizationName": "",
		"phone1": "",
		"phone2": "",
		"state": "",
		"stateProvDisplayName": "",
		"zipCode": ""
	},
	"description": null,
	"displayName": "Default Organization",
	"organizationDisplayName": "Default Organization (Root Organization)",
	"organizationId": "-2000",
	"organizationName": "Default Organization",
	"state": "1",
	"status": 0
}

GET /store/{storeId}/organization/{organizationId}

This allows an administrator to find organization information by organization identifier.

Handler Method:

findByOrganizationIdWOrganizationDetailsProfileName

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summaryquerystringfalsefalse
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.user.beans.OrganizationDataBean_IBM_Organization_Details


Example

Request:
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
HTTP Status Code:

200

Response:
{
	"addressBook": [
	],
	"businessCategory": null,
	"contactInfo": {
		"address1": "",
		"address2": "",
		"address3": "",
		"addressId": "-2000",
		"addressType": "",
		"city": "",
		"country": "",
		"countryDisplayName": "",
		"email1": "",
		"email2": "",
		"firstName": "",
		"lastName": "",
		"middleName": "",
		"mobilePhone1": "",
		"nickName": "Default Organization",
		"organizationName": "",
		"phone1": "",
		"phone2": "",
		"state": "",
		"stateProvDisplayName": "",
		"zipCode": ""
	},
	"description": null,
	"displayName": "Default Organization",
	"organizationDisplayName": "Default Organization (Root Organization)",
	"organizationId": "-2000",
	"organizationName": "Default Organization",
	"state": "1",
	"status": 0
}

GET /store/{storeId}/organization/{organizationId}

This allows an administrator to find organization information by organization identifier.

Handler Method:

findByOrganizationIdWOrgEntityDetailsProfileName

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summaryquerystringfalsefalse
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.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details


Example

Request:
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
HTTP Status Code:

200

Response:
{
	"addressBook": [
	],
	"businessCategory": null,
	"contactInfo": {
		"address1": "",
		"address2": "",
		"address3": "",
		"addressId": "-2000",
		"addressType": "",
		"city": "",
		"country": "",
		"countryDisplayName": "",
		"email1": "",
		"email2": "",
		"firstName": "",
		"lastName": "",
		"middleName": "",
		"mobilePhone1": "",
		"nickName": "Default Organization",
		"organizationName": "",
		"phone1": "",
		"phone2": "",
		"state": "",
		"stateProvDisplayName": "",
		"zipCode": ""
	},
	"description": null,
	"displayName": "Default Organization",
	"organizationDisplayName": "Default Organization (Root Organization)",
	"organizationId": "-2000",
	"organizationName": "Default Organization",
	"state": "1",
	"status": 0
}

GET /store/{storeId}/organization/{organizationId}

This allows an administrator to find organization information by organization identifier.

Handler Method:

findByOrganizationIdWAssignedRolesDetailsProfileName

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summaryquerystringfalsefalse
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.user.beans.OrgEntityDataBean_IBM_Assigned_Roles_Details


Example

Request:
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
HTTP Status Code:

200

Response:
{
	"addressBook": [
	],
	"businessCategory": null,
	"contactInfo": {
		"address1": "",
		"address2": "",
		"address3": "",
		"addressId": "-2000",
		"addressType": "",
		"city": "",
		"country": "",
		"countryDisplayName": "",
		"email1": "",
		"email2": "",
		"firstName": "",
		"lastName": "",
		"middleName": "",
		"mobilePhone1": "",
		"nickName": "Default Organization",
		"organizationName": "",
		"phone1": "",
		"phone2": "",
		"state": "",
		"stateProvDisplayName": "",
		"zipCode": ""
	},
	"description": null,
	"displayName": "Default Organization",
	"organizationDisplayName": "Default Organization (Root Organization)",
	"organizationId": "-2000",
	"organizationName": "Default Organization",
	"state": "1",
	"status": 0
}

GET /store/{storeId}/organization/{organizationId}

This allows an administrator to find organization information by organization identifier.

Handler Method:

findByOrganizationIdWParentAssignedRolesDetailsProfileName

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
profileNameProfile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summaryquerystringfalsefalse
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.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details


Example

Request:
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
HTTP Status Code:

200

Response:
{
	"addressBook": [
	],
	"businessCategory": null,
	"contactInfo": {
		"address1": "",
		"address2": "",
		"address3": "",
		"addressId": "-2000",
		"addressType": "",
		"city": "",
		"country": "",
		"countryDisplayName": "",
		"email1": "",
		"email2": "",
		"firstName": "",
		"lastName": "",
		"middleName": "",
		"mobilePhone1": "",
		"nickName": "Default Organization",
		"organizationName": "",
		"phone1": "",
		"phone2": "",
		"state": "",
		"stateProvDisplayName": "",
		"zipCode": ""
	},
	"description": null,
	"displayName": "Default Organization",
	"organizationDisplayName": "Default Organization (Root Organization)",
	"organizationId": "-2000",
	"organizationName": "Default Organization",
	"state": "1",
	"status": 0
}

POST /store/{storeId}/organization

This allows an administrator to register an organization.

Handler Method:

registerOrganization

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
bodyRequest body.bodycom.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityAddRequestfalseN/A
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
201The requested resource has been created.
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.rest.member.handler.OrganizationHandler$OrgEntityIdentity


Example

Request:
POST /wcs/resources/store/10801/organization/
Body:
{
	"address1": "302 warden ave.",
	"city": "Markham",
	"country": "Canada",
	"orgEntityName": "newOrg_test842516",
	"orgEntityType": "O",
	"parentMemberId": "-2001",
	"state": "Ontario",
	"zipCode": "L3C 9S8"
}
HTTP Status Code:

201

Response:
{
	"addressId": "15802",
	"orgEntityId": "7000000000000004402",
	"viewTaskName": "RedirectView"
}

POST /store/{storeId}/organization/{organizationId}?action={action}

Performs an action on an organization. See each action for details on input and output.

Handler Method:

performAction

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
actionThe action of the rest service.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
201The requested resource has been created.
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.

POST /store/{storeId}/organization/{organizationId}?action=assignRole

This allows an administrator to assign role(s) to an organization.

Handler Method:

assignRole

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
bodyRequest body.bodycom.ibm.commerce.rest.member.handler.OrganizationHandler$MemberRoleAssignRequestfalseN/A
actionThe action of the rest service.querystringtruefalse
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
201The requested resource has been created.
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.usermanagement.commands.MemberRoleAssignCmd


Example

Request:
POST /wcs/resources/store/10801/organization/7000000000000000919?action=assignRole
Body:
{
	"roleId": "-35",
	"roleId1": "-15",
	"roleId2": "-1"
}
HTTP Status Code:

201

Response:
{
	"viewTaskName": "RedirectView"
}

POST /store/{storeId}/organization/{organizationId}?action=unassignRole

This allows an administrator to unassign role(s) from an organization.

Handler Method:

unassignRole

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
bodyRequest body.bodycom.ibm.commerce.rest.member.handler.OrganizationHandler$MemberRoleUnassignRequestfalseN/A
actionThe action of the rest service.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.usermanagement.commands.MemberRoleUnassignCmd


Example

Request:
POST /wcs/resources/store/10801/organization/7000000000000000919?action=unassignRole
Body:
{
	"roleId": "-35",
	"roleId1": "-15",
	"roleId2": "-1"
}
HTTP Status Code:

200

Response:
{
	"viewTaskName": "RedirectView"
}

POST /store/{storeId}/organization/{organizationId}?action=updateApprovalGroups

Updates approval group.

Handler Method:

updateApprovalGroups

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
bodyRequest body.bodycom.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroupsfalseN/A
actionThe action of the rest service.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.rest.member.handler.OrganizationHandler$UpdateApprovalGroupsResponse


Example

Request:
POST /wcs/resources/store/10801/organization/7000000000000000801?action=updateApprovalGroups
Body:
{
	"URL": "AAA",
	"segmentId": ""
}
HTTP Status Code:

200

Response:
{
	"viewTaskName": "RedirectView"
}

POST /store/{storeId}/organization/buyer

Registers a buyer organization and a buyer organization administrator.

Handler Method:

registerBuyerOrganization

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
bodyRequest body.bodycom.ibm.commerce.rest.member.handler.OrganizationHandler$BuyerRegistrationAddRequestfalseN/A
HTTP Status Codes:
HTTP Status CodeDescription
200The requested completed successfully.
201The requested resource has been created.
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.rest.member.handler.OrganizationHandler$OrgEntityBuyerIdentifier

PUT /store/{storeId}/organization/{organizationId}

This allows an administrator to update information of an organization.

Handler Method:

updateOrganization

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:
NameDescriptionParameter TypeData TypeRequiredAllow Multiple
storeIdThe store identifier.pathstringtrueN/A
organizationIdThe organization identifierpathstringtrueN/A
bodyRequest body.bodycom.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityUpdateRequestfalseN/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.
500Internal server error. Additional details will be contained on the server logs.
Response Data Type:

com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityIdentity


Example

Request:
PUT /wcs/resources/store/10801/organization/7000000000000000919
Body:
{
	"address1": "8200 Warden Ave",
	"address2": "Unit A4-664",
	"bestCallingTime": "1",
	"city": "Markham",
	"description": "updated",
	"zipCode": "C0U 3B2"
}
HTTP Status Code:

201

Response:
{
	"addressId": "12338",
	"orgEntityId": "7000000000000000919",
	"viewTaskName": "RedirectView"
}

Data Type Details

com.ibm.commerce.rest.member.handler.OrganizationHandler$BuyerRegistrationAddRequest

Request of BuyerRegistrationAddCmd.

Properties:
NameData TypeRequired
org_string arrayfalse
usr_string arrayfalse

com.ibm.commerce.rest.member.handler.OrganizationHandler$MemberRoleAssignRequest

Request of MemberRoleAssignCmd.

Properties:
NameData TypeRequired
orgEntityIdistring arraytrue
roleIdistring arraytrue
URLstringfalse

com.ibm.commerce.rest.member.handler.OrganizationHandler$MemberRoleUnassignRequest

Request of MemberRoleUnassignCmd.

Properties:
NameData TypeRequired
orgEntityIdistring arraytrue
roleIdistring arraytrue
URLstringfalse

com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityAddRequest

Request of OrgEntityAddCmd.

Properties:
NameData TypeRequired
organizationUnitNamestringfalse
personTitlestringfalse
phone1stringfalse
phone2stringfalse
billingCodestringfalse
addressField1stringfalse
addressField2stringfalse
addressField3stringfalse
packageSuppressionstringfalse
administratorFirstNamestringfalse
statestringfalse
orgEntityNamestringtrue
email1stringfalse
preferredDeliverystringfalse
countrystringfalse
email2stringfalse
parentMemberIdstringtrue
customMemberAttributesstring arrayfalse
taxPayerIdstringfalse
bestCallingTimestringfalse
administratorLastNamestringfalse
zipCodestringfalse
taxGeoCodestringfalse
legalIdstringfalse
fax1stringfalse
fax2stringfalse
address1stringfalse
address2stringfalse
orgEntityField1stringfalse
address3stringfalse
orgEntityField2stringfalse
orgEntityField3stringfalse
middleNamestringfalse
orgEntityTypestringtrue
lastNamestringfalse
addressTypestringfalse
URLstringfalse
shippingGeoCodestringfalse
firstNamestringfalse
phone1Typestringfalse
businessCategorystringfalse
organizationNamestringfalse
phone2Typestringfalse
billingCodeTypestringfalse
citystringfalse
administratorMiddleNamestringfalse
distinguishedNamestringtrue
publishPhone1stringfalse
publishPhone2stringfalse
descriptionstringfalse

com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityBuyerIdentifier

Response of registering an organization entity and a buyer.

Properties:
NameData TypeRequired
orgEntityIdstringtrue
userIdstringtrue

com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityIdentity

Information about an organization entity identity.

Properties:
NameData TypeRequired
orgEntityIdstringtrue
addressIdstringtrue

com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityUpdateRequest

Request of OrgEntityUpdateCmd.

Properties:
NameData TypeRequired
middleNamestringfalse
orgEntityField3stringfalse
lastNamestringfalse
organizationUnitNamestringfalse
phone1stringfalse
personTitlestringfalse
phone2stringfalse
billingCodestringfalse
addressField1stringfalse
addressField2stringfalse
packageSuppressionstringfalse
addressField3stringfalse
administratorFirstNamestringfalse
addressTypestringfalse
URLstringfalse
shippingGeoCodestringfalse
statestringfalse
orgEntityNamestringfalse
preferredDeliverystringfalse
email1stringfalse
email2stringfalse
countrystringfalse
firstNamestringfalse
phone1Typestringfalse
phone2Typestringfalse
organizationNamestringfalse
businessCategorystringfalse
customMemberAttributesstring arrayfalse
orgEntityIdstringtrue
billingCodeTypestringfalse
taxPayerIdstringfalse
citystringfalse
administratorMiddleNamestringfalse
bestCallingTimestringfalse
zipCodestringfalse
administratorLastNamestringfalse
publishPhone1stringfalse
taxGeoCodestringfalse
publishPhone2stringfalse
fax1stringfalse
legalIdstringfalse
fax2stringfalse
descriptionstringfalse
address1stringfalse
orgEntityField1stringfalse
address2stringfalse
orgEntityField2stringfalse
address3stringfalse

com.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroups

Information about an organization entity identity.

Properties:
NameData TypeRequired
orgEntityIdstringtrue
segmentIdstringtrue
URLstringtrue

com.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroupsResponse

Information about an organization entity identity.

Properties:
NameData TypeRequired
orgEntityIdstringtrue
catalogIdstringfalse
requesttypestringfalse
storeIdstringfalse
segmentIdstringtrue
URLstringtrue

com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Details

Properties:
NameData TypeRequired
orgEntityTypestringfalse
isBusinessEntitystringfalse
administratorFirstNamestringfalse
statestringfalse
memberIdstringfalse
preferredDeliverystringfalse
businessCategorystringfalse
organizationNamestringfalse
parentMemberIdstringfalse
taxPayerIdstringfalse
ownerMemberIdstringfalse
displayNamestringfalse
administratorMiddleNamestringfalse
contactInfocom.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Details.contactInfofalse
administratorLastNamestringfalse
organizationIdstringfalse
distinguishedNamestringfalse
statusstringfalse
ownerstringfalse
legalIdstringfalse
organizationDisplayNamestringfalse
typestringfalse
descriptionstringfalse
addressBookcom.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Details.addressBook arrayfalse
rolesinteger arrayfalse

com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Details.addressBook

Properties:
NameData TypeRequired
middleNamestringfalse
lastNamestringfalse
primarystringfalse
organizationUnitNamestringfalse
phone1stringfalse
personTitlestringfalse
phone2stringfalse
mobilePhone1stringfalse
addressTypestringfalse
nickNamestringfalse
statestringfalse
mobilePhone1Countrystringfalse
email1stringfalse
memberIdstringfalse
email2stringfalse
countrystringfalse
officeAddressstringfalse
firstNamestringfalse
organizationNamestringfalse
citystringfalse
bestCallingTimestringfalse
zipCodestringfalse
addressIdstringfalse
statusstringfalse
publishPhone1stringfalse
stateProvDisplayNamestringfalse
publishPhone2stringfalse
fax1stringfalse
fax2stringfalse
countryDisplayNamestringfalse
businessTitlestringfalse
address1stringfalse
address2stringfalse
address3stringfalse

com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Details.contactInfo

Properties:
NameData TypeRequired
middleNamestringfalse
lastNamestringfalse
primarystringfalse
organizationUnitNamestringfalse
phone1stringfalse
personTitlestringfalse
phone2stringfalse
mobilePhone1stringfalse
addressTypestringfalse
nickNamestringfalse
statestringfalse
mobilePhone1Countrystringfalse
email1stringfalse
memberIdstringfalse
email2stringfalse
countrystringfalse
officeAddressstringfalse
firstNamestringfalse
organizationNamestringfalse
citystringfalse
bestCallingTimestringfalse
zipCodestringfalse
addressIdstringfalse
statusstringfalse
publishPhone1stringfalse
stateProvDisplayNamestringfalse
publishPhone2stringfalse
fax1stringfalse
fax2stringfalse
countryDisplayNamestringfalse
businessTitlestringfalse
address1stringfalse
address2stringfalse
address3stringfalse

com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Short_Summary

Properties:
NameData TypeRequired
statestringfalse
statusstringfalse
organizationDisplayNamestringfalse
descriptionstringfalse
displayNamestringfalse
organizationNamestringfalse
organizationIdstringfalse
contactInfocom.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Short_Summary.contactInfofalse
businessCategorystringfalse

com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Short_Summary.contactInfo

Properties:
NameData TypeRequired
middleNamestringfalse
lastNamestringfalse
phone1stringfalse
phone2stringfalse
mobilePhone1stringfalse
citystringfalse
zipCodestringfalse
nickNamestringfalse
addressTypestringfalse
addressIdstringfalse
statestringfalse
stateProvDisplayNamestringfalse
email1stringfalse
countrystringfalse
email2stringfalse
countryDisplayNamestringfalse
firstNamestringfalse
address1stringfalse
organizationNamestringfalse
address2stringfalse
address3stringfalse

com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Summary

Properties:
NameData TypeRequired
statestringfalse
statusstringfalse
organizationDisplayNamestringfalse
descriptionstringfalse
displayNamestringfalse
addressBookcom.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Summary.addressBook arrayfalse
organizationNamestringfalse
organizationIdstringfalse
contactInfocom.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Summary.contactInfofalse
businessCategorystringfalse

com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Summary.addressBook

Properties:
NameData TypeRequired
middleNamestringfalse
lastNamestringfalse
phone1stringfalse
phone2stringfalse
mobilePhone1stringfalse
citystringfalse
zipCodestringfalse
nickNamestringfalse
addressTypestringfalse
addressIdstringfalse
statestringfalse
stateProvDisplayNamestringfalse
email1stringfalse
countrystringfalse
email2stringfalse
countryDisplayNamestringfalse
firstNamestringfalse
address1stringfalse
organizationNamestringfalse
address2stringfalse
address3stringfalse

com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Summary.contactInfo

Properties:
NameData TypeRequired
middleNamestringfalse
lastNamestringfalse
phone1stringfalse
phone2stringfalse
mobilePhone1stringfalse
citystringfalse
zipCodestringfalse
nickNamestringfalse
addressTypestringfalse
addressIdstringfalse
statestringfalse
stateProvDisplayNamestringfalse
email1stringfalse
countrystringfalse
email2stringfalse
countryDisplayNamestringfalse
firstNamestringfalse
address1stringfalse
organizationNamestringfalse
address2stringfalse
address3stringfalse

com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details

Properties:
NameData TypeRequired
pageSizestringfalse
recordSetTotalstringfalse
recordSetCompleteIndicatorstringfalse
organizationDataBeanscom.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details.organizationDataBeans arrayfalse
pageNumberstringfalse
recordSetCountstringfalse

com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details.organizationDataBeans

Properties:
NameData TypeRequired
orgEntityField3stringfalse
orgEntityTypestringfalse
taxPayerIdstringfalse
ownerMemberIdstringfalse
administratorMiddleNamestringfalse
displayNamestringfalse
organizationIdstringfalse
administratorFirstNamestringfalse
administratorLastNamestringfalse
distinguishedNamestringfalse
statestringfalse
statusstringfalse
ownerstringfalse
legalIdstringfalse
preferredDeliverystringfalse
memberIdstringfalse
typestringfalse
descriptionstringfalse
rolesinteger arrayfalse
organizationNamestringfalse
businessCategorystringfalse
orgEntityField1stringfalse
parentMemberIdstringfalse
orgEntityField2stringfalse

com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Short_Summary

Properties:
NameData TypeRequired
pageSizestringfalse
recordSetTotalstringfalse
recordSetCompleteIndicatorstringfalse
organizationDataBeanscom.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Short_Summary.organizationDataBeans arrayfalse
pageNumberstringfalse
recordSetCountstringfalse

com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Short_Summary.organizationDataBeans

Properties:
NameData TypeRequired
statestringfalse
statusstringfalse
memberIdstringfalse
typestringfalse
organizationNamestringfalse
organizationIdstringfalse
distinguishedNamestringfalse

com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Summary

Properties:
NameData TypeRequired
pageSizestringfalse
recordSetTotalstringfalse
recordSetCompleteIndicatorstringfalse
organizationDataBeanscom.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Summary.organizationDataBeans arrayfalse
pageNumberstringfalse
recordSetCountstringfalse

com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Summary.organizationDataBeans

Properties:
NameData TypeRequired
orgEntityTypestringfalse
displayNamestringfalse
organizationIdstringfalse
distinguishedNamestringfalse
statestringfalse
statusstringfalse
legalIdstringfalse
memberIdstringfalse
typestringfalse
descriptionstringfalse
businessCategorystringfalse
organizationNamestringfalse
parentMemberIdstringfalse

com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Assigned_Roles_Details

Properties:
NameData TypeRequired
memberIdstringfalse
displayNamestringfalse
rolesWithDetailscom.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Assigned_Roles_Details.rolesWithDetails arrayfalse

com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Assigned_Roles_Details.rolesWithDetails

Properties:
NameData TypeRequired
roleIdstringfalse
namestringfalse
descriptionstringfalse
displayNamestringfalse

com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details

Properties:
NameData TypeRequired
orgEntityTypestringfalse
orgEntityIdstringfalse
parentcom.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details.parentfalse
administratorMiddleNamestringfalse
displayNamestringfalse
organizationIdstringfalse
administratorFirstNamestringfalse
administratorLastNamestringfalse
distinguishedNamestringfalse
orgEntityNamestringfalse
legalIdstringfalse
memberIdstringfalse
orgPropertiescom.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details.orgPropertiesfalse
typestringfalse
descriptionstringfalse
organizationNamestringfalse
businessCategorystringfalse

com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details.orgProperties

com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details.parent

Properties:
NameData TypeRequired
orgEntityTypestringfalse
orgEntityIdstringfalse
administratorMiddleNamestringfalse
displayNamestringfalse
administratorFirstNamestringfalse
administratorLastNamestringfalse
organizationIdstringfalse
distinguishedNamestringfalse
orgEntityNamestringfalse
legalIdstringfalse
memberIdstringfalse
typestringfalse
descriptionstringfalse
organizationNamestringfalse
businessCategorystringfalse

com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details

Properties:
NameData TypeRequired
memberIdstringfalse
parentRolesWithDetailscom.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details.parentRolesWithDetails arrayfalse
displayNamestringfalse

com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details.parentRolesWithDetails

Properties:
NameData TypeRequired
roleIdstringfalse
namestringfalse
descriptionstringfalse
displayNamestringfalse

com.ibm.commerce.user.beans.RoleAssignmentDataBean_IBM_Roles_To_Assign_Details

com.ibm.commerce.user.beans.RoleAssignmentDataBean_IBM_Roles_To_Assign_Details.roleDataBeans

Properties:
NameData TypeRequired
roleIdstringfalse
namestringfalse
descriptionstringfalse
displayNamestringfalse

com.ibm.commerce.usermanagement.commands.MemberRoleAssignCmd

com.ibm.commerce.usermanagement.commands.MemberRoleUnassignCmd