This class provides RESTful services to register an organization, to get or update organization information.
com.ibm.commerce.rest.member.handler.OrganizationHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/organization | This allows an administrator to find organizations that he/she can administer. |
GET | /store/{storeId}/organization | This 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=organizationsICanAdmin | This allows an administrator to find organizations that he/she can administer. |
GET | /store/{storeId}/organization?q=rolesICanAssignInOrg | This 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}/organization | This 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=assignRole | This allows an administrator to assign role(s) to an organization. |
POST | /store/{storeId}/organization/{organizationId}?action=unassignRole | This allows an administrator to unassign role(s) from an organization. |
POST | /store/{storeId}/organization/{organizationId}?action=updateApprovalGroups | Updates approval group. |
POST | /store/{storeId}/organization/buyer | Registers a buyer organization and a buyer organization administrator. |
PUT | /store/{storeId}/organization/{organizationId} | This allows an administrator to update information of an organization. |
This allows an administrator to find organizations that he/she can administer.
organizationsICanAdminWOrganizationListShortSummaryProfileName
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_List_Summary | query | string | false | false |
orgName | The organization name. | query | string | false | false |
parentOrgName | The parent organization name. | query | string | false | false |
startIndex | The starting index of the result. | query | string | false | false |
maxResults | The maximum number of results to be returned. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Short_Summary
This allows an administrator to find organizations that he/she can administer.
organizationsICanAdminWOrganizationListDetailsProfileName
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_List_Summary | query | string | false | false |
orgName | The organization name. | query | string | false | false |
parentOrgName | The parent organization name. | query | string | false | false |
startIndex | The starting index of the result. | query | string | false | false |
maxResults | The maximum number of results to be returned. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details
This allows an administrator to find organizations based on query name. See each query for details on input and output.
findByQuery
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
q | The query name. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
This allows an administrator to find organizations that he/she can administer.
organizationsICanAdmin
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_List_Summary | query | string | false | false |
orgName | The organization name. | query | string | false | false |
parentOrgName | The parent organization name. | query | string | false | false |
q | The query name. | query | string | true | false |
startIndex | The starting index of the result. | query | string | false | false |
maxResults | The maximum number of results to be returned. | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Summary
GET /wcs/resources/store/10801/organization?q=organizationsICanAdmin&orgName=%2522
200
{ "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 }
This allows an administrator to find roles that he/she can assign in organizations.
rolesICanAssignInOrg
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. | query | string | false | false |
q | The query name. | query | string | true | false |
orgId | The organization identifier. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.RoleAssignmentDataBean_IBM_Roles_To_Assign_Details
GET /wcs/resources/store/10801/organization?q=rolesICanAssignInOrg&orgId=12345
200
{ "roleDataBeans": [ ] }
This allows an administrator to find organization information by organization identifier.
findByOrganizationId
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summary | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Summary
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
200
{ "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 }
This allows an administrator to find organization information by organization identifier.
findByOrganizationIdWOrganizationShortSummaryProfilenName
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summary | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Short_Summary
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
200
{ "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 }
This allows an administrator to find organization information by organization identifier.
findByOrganizationIdWOrganizationDetailsProfileName
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summary | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Details
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
200
{ "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 }
This allows an administrator to find organization information by organization identifier.
findByOrganizationIdWOrgEntityDetailsProfileName
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summary | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
200
{ "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 }
This allows an administrator to find organization information by organization identifier.
findByOrganizationIdWAssignedRolesDetailsProfileName
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summary | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Assigned_Roles_Details
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
200
{ "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 }
This allows an administrator to find organization information by organization identifier.
findByOrganizationIdWParentAssignedRolesDetailsProfileName
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_Organization_Summary | query | string | false | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details
GET /wcs/resources/store/10001/organization/-2000?responseFormat=json
200
{ "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 }
This allows an administrator to register an organization.
registerOrganization
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
body | Request body. | body | com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityAddRequest | false | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
201 | The requested resource has been created. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityIdentity
POST /wcs/resources/store/10801/organization/
{ "address1": "302 warden ave.", "city": "Markham", "country": "Canada", "orgEntityName": "newOrg_test842516", "orgEntityType": "O", "parentMemberId": "-2001", "state": "Ontario", "zipCode": "L3C 9S8" }
201
{ "addressId": "15802", "orgEntityId": "7000000000000004402", "viewTaskName": "RedirectView" }
Performs an action on an organization. See each action for details on input and output.
performAction
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
action | The action of the rest service. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
201 | The requested resource has been created. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
This allows an administrator to assign role(s) to an organization.
assignRole
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
body | Request body. | body | com.ibm.commerce.rest.member.handler.OrganizationHandler$MemberRoleAssignRequest | false | N/A |
action | The action of the rest service. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
201 | The requested resource has been created. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.usermanagement.commands.MemberRoleAssignCmd
POST /wcs/resources/store/10801/organization/7000000000000000919?action=assignRole
{ "roleId": "-35", "roleId1": "-15", "roleId2": "-1" }
201
{ "viewTaskName": "RedirectView" }
This allows an administrator to unassign role(s) from an organization.
unassignRole
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
body | Request body. | body | com.ibm.commerce.rest.member.handler.OrganizationHandler$MemberRoleUnassignRequest | false | N/A |
action | The action of the rest service. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.usermanagement.commands.MemberRoleUnassignCmd
POST /wcs/resources/store/10801/organization/7000000000000000919?action=unassignRole
{ "roleId": "-35", "roleId1": "-15", "roleId2": "-1" }
200
{ "viewTaskName": "RedirectView" }
Updates approval group.
updateApprovalGroups
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
body | Request body. | body | com.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroups | false | N/A |
action | The action of the rest service. | query | string | true | false |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.member.handler.OrganizationHandler$UpdateApprovalGroupsResponse
POST /wcs/resources/store/10801/organization/7000000000000000801?action=updateApprovalGroups
{ "URL": "AAA", "segmentId": "" }
200
{ "viewTaskName": "RedirectView" }
Registers a buyer organization and a buyer organization administrator.
registerBuyerOrganization
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
body | Request body. | body | com.ibm.commerce.rest.member.handler.OrganizationHandler$BuyerRegistrationAddRequest | false | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
201 | The requested resource has been created. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityBuyerIdentifier
This allows an administrator to update information of an organization.
updateOrganization
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
organizationId | The organization identifier | path | string | true | N/A |
body | Request body. | body | com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityUpdateRequest | false | N/A |
HTTP Status Code | Description |
---|---|
200 | The requested completed successfully. |
400 | Bad request. Some of the inputs provided to the request aren't valid. |
401 | Not authenticated. The user session isn't valid. |
403 | The user isn't authorized to perform the specified request. |
500 | Internal server error. Additional details will be contained on the server logs. |
com.ibm.commerce.rest.member.handler.OrganizationHandler$OrgEntityIdentity
PUT /wcs/resources/store/10801/organization/7000000000000000919
{ "address1": "8200 Warden Ave", "address2": "Unit A4-664", "bestCallingTime": "1", "city": "Markham", "description": "updated", "zipCode": "C0U 3B2" }
201
{ "addressId": "12338", "orgEntityId": "7000000000000000919", "viewTaskName": "RedirectView" }
Request of BuyerRegistrationAddCmd.
Name | Data Type | Required |
---|---|---|
org_ | string array | false |
usr_ | string array | false |
Request of MemberRoleAssignCmd.
Name | Data Type | Required |
---|---|---|
orgEntityIdi | string array | true |
roleIdi | string array | true |
URL | string | false |
Request of MemberRoleUnassignCmd.
Name | Data Type | Required |
---|---|---|
orgEntityIdi | string array | true |
roleIdi | string array | true |
URL | string | false |
Request of OrgEntityAddCmd.
Name | Data Type | Required |
---|---|---|
organizationUnitName | string | false |
personTitle | string | false |
phone1 | string | false |
phone2 | string | false |
billingCode | string | false |
addressField1 | string | false |
addressField2 | string | false |
addressField3 | string | false |
packageSuppression | string | false |
administratorFirstName | string | false |
state | string | false |
orgEntityName | string | true |
email1 | string | false |
preferredDelivery | string | false |
country | string | false |
email2 | string | false |
parentMemberId | string | true |
customMemberAttributes | string array | false |
taxPayerId | string | false |
bestCallingTime | string | false |
administratorLastName | string | false |
zipCode | string | false |
taxGeoCode | string | false |
legalId | string | false |
fax1 | string | false |
fax2 | string | false |
address1 | string | false |
address2 | string | false |
orgEntityField1 | string | false |
address3 | string | false |
orgEntityField2 | string | false |
orgEntityField3 | string | false |
middleName | string | false |
orgEntityType | string | true |
lastName | string | false |
addressType | string | false |
URL | string | false |
shippingGeoCode | string | false |
firstName | string | false |
phone1Type | string | false |
businessCategory | string | false |
organizationName | string | false |
phone2Type | string | false |
billingCodeType | string | false |
city | string | false |
administratorMiddleName | string | false |
distinguishedName | string | true |
publishPhone1 | string | false |
publishPhone2 | string | false |
description | string | false |
Response of registering an organization entity and a buyer.
Name | Data Type | Required |
---|---|---|
orgEntityId | string | true |
userId | string | true |
Information about an organization entity identity.
Name | Data Type | Required |
---|---|---|
orgEntityId | string | true |
addressId | string | true |
Request of OrgEntityUpdateCmd.
Name | Data Type | Required |
---|---|---|
middleName | string | false |
orgEntityField3 | string | false |
lastName | string | false |
organizationUnitName | string | false |
phone1 | string | false |
personTitle | string | false |
phone2 | string | false |
billingCode | string | false |
addressField1 | string | false |
addressField2 | string | false |
packageSuppression | string | false |
addressField3 | string | false |
administratorFirstName | string | false |
addressType | string | false |
URL | string | false |
shippingGeoCode | string | false |
state | string | false |
orgEntityName | string | false |
preferredDelivery | string | false |
email1 | string | false |
email2 | string | false |
country | string | false |
firstName | string | false |
phone1Type | string | false |
phone2Type | string | false |
organizationName | string | false |
businessCategory | string | false |
customMemberAttributes | string array | false |
orgEntityId | string | true |
billingCodeType | string | false |
taxPayerId | string | false |
city | string | false |
administratorMiddleName | string | false |
bestCallingTime | string | false |
zipCode | string | false |
administratorLastName | string | false |
publishPhone1 | string | false |
taxGeoCode | string | false |
publishPhone2 | string | false |
fax1 | string | false |
legalId | string | false |
fax2 | string | false |
description | string | false |
address1 | string | false |
orgEntityField1 | string | false |
address2 | string | false |
orgEntityField2 | string | false |
address3 | string | false |
Information about an organization entity identity.
Name | Data Type | Required |
---|---|---|
orgEntityId | string | true |
segmentId | string | true |
URL | string | true |
Information about an organization entity identity.
Name | Data Type | Required |
---|---|---|
orgEntityId | string | true |
catalogId | string | false |
requesttype | string | false |
storeId | string | false |
segmentId | string | true |
URL | string | true |
Name | Data Type | Required |
---|---|---|
orgEntityType | string | false |
isBusinessEntity | string | false |
administratorFirstName | string | false |
state | string | false |
memberId | string | false |
preferredDelivery | string | false |
businessCategory | string | false |
organizationName | string | false |
parentMemberId | string | false |
taxPayerId | string | false |
ownerMemberId | string | false |
displayName | string | false |
administratorMiddleName | string | false |
contactInfo | com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Details.contactInfo | false |
administratorLastName | string | false |
organizationId | string | false |
distinguishedName | string | false |
status | string | false |
owner | string | false |
legalId | string | false |
organizationDisplayName | string | false |
type | string | false |
description | string | false |
addressBook | com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Details.addressBook array | false |
roles | integer array | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
primary | string | false |
organizationUnitName | string | false |
phone1 | string | false |
personTitle | string | false |
phone2 | string | false |
mobilePhone1 | string | false |
addressType | string | false |
nickName | string | false |
state | string | false |
mobilePhone1Country | string | false |
email1 | string | false |
memberId | string | false |
email2 | string | false |
country | string | false |
officeAddress | string | false |
firstName | string | false |
organizationName | string | false |
city | string | false |
bestCallingTime | string | false |
zipCode | string | false |
addressId | string | false |
status | string | false |
publishPhone1 | string | false |
stateProvDisplayName | string | false |
publishPhone2 | string | false |
fax1 | string | false |
fax2 | string | false |
countryDisplayName | string | false |
businessTitle | string | false |
address1 | string | false |
address2 | string | false |
address3 | string | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
primary | string | false |
organizationUnitName | string | false |
phone1 | string | false |
personTitle | string | false |
phone2 | string | false |
mobilePhone1 | string | false |
addressType | string | false |
nickName | string | false |
state | string | false |
mobilePhone1Country | string | false |
email1 | string | false |
memberId | string | false |
email2 | string | false |
country | string | false |
officeAddress | string | false |
firstName | string | false |
organizationName | string | false |
city | string | false |
bestCallingTime | string | false |
zipCode | string | false |
addressId | string | false |
status | string | false |
publishPhone1 | string | false |
stateProvDisplayName | string | false |
publishPhone2 | string | false |
fax1 | string | false |
fax2 | string | false |
countryDisplayName | string | false |
businessTitle | string | false |
address1 | string | false |
address2 | string | false |
address3 | string | false |
Name | Data Type | Required |
---|---|---|
state | string | false |
status | string | false |
organizationDisplayName | string | false |
description | string | false |
displayName | string | false |
organizationName | string | false |
organizationId | string | false |
contactInfo | com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Short_Summary.contactInfo | false |
businessCategory | string | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
phone1 | string | false |
phone2 | string | false |
mobilePhone1 | string | false |
city | string | false |
zipCode | string | false |
nickName | string | false |
addressType | string | false |
addressId | string | false |
state | string | false |
stateProvDisplayName | string | false |
email1 | string | false |
country | string | false |
email2 | string | false |
countryDisplayName | string | false |
firstName | string | false |
address1 | string | false |
organizationName | string | false |
address2 | string | false |
address3 | string | false |
Name | Data Type | Required |
---|---|---|
state | string | false |
status | string | false |
organizationDisplayName | string | false |
description | string | false |
displayName | string | false |
addressBook | com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Summary.addressBook array | false |
organizationName | string | false |
organizationId | string | false |
contactInfo | com.ibm.commerce.user.beans.OrganizationDataBean_IBM_Organization_Summary.contactInfo | false |
businessCategory | string | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
phone1 | string | false |
phone2 | string | false |
mobilePhone1 | string | false |
city | string | false |
zipCode | string | false |
nickName | string | false |
addressType | string | false |
addressId | string | false |
state | string | false |
stateProvDisplayName | string | false |
email1 | string | false |
country | string | false |
email2 | string | false |
countryDisplayName | string | false |
firstName | string | false |
address1 | string | false |
organizationName | string | false |
address2 | string | false |
address3 | string | false |
Name | Data Type | Required |
---|---|---|
middleName | string | false |
lastName | string | false |
phone1 | string | false |
phone2 | string | false |
mobilePhone1 | string | false |
city | string | false |
zipCode | string | false |
nickName | string | false |
addressType | string | false |
addressId | string | false |
state | string | false |
stateProvDisplayName | string | false |
email1 | string | false |
country | string | false |
email2 | string | false |
countryDisplayName | string | false |
firstName | string | false |
address1 | string | false |
organizationName | string | false |
address2 | string | false |
address3 | string | false |
Name | Data Type | Required |
---|---|---|
pageSize | string | false |
recordSetTotal | string | false |
recordSetCompleteIndicator | string | false |
organizationDataBeans | com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Details.organizationDataBeans array | false |
pageNumber | string | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
orgEntityField3 | string | false |
orgEntityType | string | false |
taxPayerId | string | false |
ownerMemberId | string | false |
administratorMiddleName | string | false |
displayName | string | false |
organizationId | string | false |
administratorFirstName | string | false |
administratorLastName | string | false |
distinguishedName | string | false |
state | string | false |
status | string | false |
owner | string | false |
legalId | string | false |
preferredDelivery | string | false |
memberId | string | false |
type | string | false |
description | string | false |
roles | integer array | false |
organizationName | string | false |
businessCategory | string | false |
orgEntityField1 | string | false |
parentMemberId | string | false |
orgEntityField2 | string | false |
Name | Data Type | Required |
---|---|---|
pageSize | string | false |
recordSetTotal | string | false |
recordSetCompleteIndicator | string | false |
organizationDataBeans | com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Short_Summary.organizationDataBeans array | false |
pageNumber | string | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
state | string | false |
status | string | false |
memberId | string | false |
type | string | false |
organizationName | string | false |
organizationId | string | false |
distinguishedName | string | false |
Name | Data Type | Required |
---|---|---|
pageSize | string | false |
recordSetTotal | string | false |
recordSetCompleteIndicator | string | false |
organizationDataBeans | com.ibm.commerce.user.beans.OrganizationSearchDataBean_IBM_Organization_List_Summary.organizationDataBeans array | false |
pageNumber | string | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
orgEntityType | string | false |
displayName | string | false |
organizationId | string | false |
distinguishedName | string | false |
state | string | false |
status | string | false |
legalId | string | false |
memberId | string | false |
type | string | false |
description | string | false |
businessCategory | string | false |
organizationName | string | false |
parentMemberId | string | false |
Name | Data Type | Required |
---|---|---|
memberId | string | false |
displayName | string | false |
rolesWithDetails | com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Assigned_Roles_Details.rolesWithDetails array | false |
Name | Data Type | Required |
---|---|---|
roleId | string | false |
name | string | false |
description | string | false |
displayName | string | false |
Name | Data Type | Required |
---|---|---|
orgEntityType | string | false |
orgEntityId | string | false |
parent | com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details.parent | false |
administratorMiddleName | string | false |
displayName | string | false |
organizationId | string | false |
administratorFirstName | string | false |
administratorLastName | string | false |
distinguishedName | string | false |
orgEntityName | string | false |
legalId | string | false |
memberId | string | false |
orgProperties | com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Org_Entity_Details.orgProperties | false |
type | string | false |
description | string | false |
organizationName | string | false |
businessCategory | string | false |
Name | Data Type | Required |
---|---|---|
orgEntityType | string | false |
orgEntityId | string | false |
administratorMiddleName | string | false |
displayName | string | false |
administratorFirstName | string | false |
administratorLastName | string | false |
organizationId | string | false |
distinguishedName | string | false |
orgEntityName | string | false |
legalId | string | false |
memberId | string | false |
type | string | false |
description | string | false |
organizationName | string | false |
businessCategory | string | false |
Name | Data Type | Required |
---|---|---|
memberId | string | false |
parentRolesWithDetails | com.ibm.commerce.user.beans.OrgEntityDataBean_IBM_Parent_Assigned_Roles_Details.parentRolesWithDetails array | false |
displayName | string | false |
Name | Data Type | Required |
---|---|---|
roleId | string | false |
name | string | false |
description | string | false |
displayName | string | false |
Name | Data Type | Required |
---|---|---|
roleDataBeans | com.ibm.commerce.user.beans.RoleAssignmentDataBean_IBM_Roles_To_Assign_Details.roleDataBeans array | false |
Name | Data Type | Required |
---|---|---|
roleId | string | false |
name | string | false |
description | string | false |
displayName | string | false |