Service de synchronisation d'organisation
Le service de synchronisation d'organisation est un service Web entrant, dont le rôle est d'ajouter ou de mettre à jour une organisation dans HCL Commerce afin de synchroniser HCL Commerce avec le référentiel principal externe.
Cas d'utilisation typiques
- Création ou mise à jour d'une organisation
- Création ou mise à jour d'une adresse pour une organisation
URL du point d'extrémité et opération du service Web
L'URL de nœud final par défaut de ce service Web entrant est https://hostname:8000/webapp/wcs/services/MemberServices. L'opération exposée par le service est SyncOrganization, avec le BOD SyncOrganization en guise de demande et le BOD ConfirmBOD en guise de réponse.
Demande
Les requêtes adressées à ce service Web entrant ont la forme de documents BOD (Business Object Documents) SyncOrganization. Il existe deux types de demande pour ce service :
- Ajout ou mise à jour d'une organisation
- Ajout ou mise à jour d'une adresse pour une organisation
Ajout ou mise à jour d'une organisation
Les requêtes d'ajout ou de mise à jour d'une organisation sont mappées à com.ibm.commerce.usermanagement.commands.OrgEntityAddCmd et com.ibm.commerce.usermanagement.commands.OrgEntityUpdateCmd. Les demandes doivent contenir les informations suivantes :
| XPath* | Type | Mappé au paramètre de commande suivant | Description | Obligatoire |
|---|---|---|---|---|
| ApplicationArea/BusinessContext/ContextData | USERDATA | - | Données de contexte. Par exemple :
| N |
| DataArea/Sync/ActionCriteria/ActionExpression/@actionCode | chaîne | action | Le code d'action. Les valeurs admises sont les suivantes :
|
O |
| DataArea/Sync/ActionCriteria/ActionExpression | chaîne | commerceObject | L'expression d'action. Elle doit être spécifiée comme suit :
| O |
| DataArea/Organization/OrganizationIdentifier/DistinguishedName | chaîne | distinguishedName | Le nom distinctif de l'organisation. | Y - lorsque vous mettez à jour une organisation N - lorsque vous ajoutez une organisation |
| DataArea/Organization/ParentIdentifier/DistinguishedName | chaîne | parentDN | Le nom distinctif de l'organisation parent. | Y - en cas d'ajout d'une organisation et si OrganizationType = "OU". Lorsque OrganizationType = O, ce paramètre n'est pas obligatoire ; sa valeur par défaut est Root Organization (organisation racine). Ce paramètre ne s'applique que lorsque vous ajoutez une organisation. |
| DataArea/Organization/OrganizationName | chaîne | orgEntityName | Le nom abrégé de l'organisation (O) ou de l'unité organisationnelle (OU). | Y - lorsque vous ajoutez une organisation N - lorsque vous mettez à jour une organisation |
| DataArea/Organization/OrganizationType | chaîne | orgEntityType | Le type d'entité organisationnelle (OrgEntity). Les valeurs admises sont les suivantes : O : organisation OU : unité organisationnelle | Y - lorsque vous ajoutez une organisation. Ce paramètre ne s'applique que lorsque vous ajoutez une organisation. |
| DataArea/Organization/BusinessCategory | chaîne | businessCategory | Le secteur d'activité, qui décrit le genre d'activité d'une entité organisationnelle. | N |
| DataArea/Organization/Description | chaîne | description | La description de l'entité organisationnelle. | N |
| DataArea/Organization/ContactInfo/Telephone[1] | chaîne | phone1 | Le numéro de téléphone principal de l'organisation. | N |
| DataArea/Organization/ContactInfo/Telephone[1]/@type | chaîne | phone1Type | Le type de téléphone utilisé pour le numéro de téléphone principal de l'organisation. Par exemple, TTY pour une personne malentendante, PCM pour la modulation par impulsions codées ou CEL (cellulaire) pour un portable. Cette valeur est une zone à trois caractères. | N |
| DataArea/Organization/ContactInfo/Telephone[1]/@publish | chaîne | publishPhone1 | Indique si le numéro de téléphone principal est publié dans l'annuaire. | N |
| DataArea/Organization/ContactInfo/Telephone[2] | chaîne | phone2 | Le numéro de téléphone secondaire de l'organisation. | N |
| DataArea/Organization/ContactInfo/Telephone[2]/@type | chaîne | phone2Type | Le type de téléphone utilisé pour le numéro de téléphone secondaire de l'organisation. Par exemple, TTY pour une personne malentendante, PCM pour la modulation par impulsions codées ou CEL (cellulaire) pour un portable. Cette valeur est une zone à trois caractères. | N |
| DataArea/Organization/ContactInfo/Telephone[2]/@publish | chaîne | publishPhone2 | Indique si le numéro de téléphone principal est publié dans l'annuaire. | N |
| DataArea/Organization/ContactInfo/Email[1] | chaîne | email1 | L'adresse e-mail principale de l'organisation. | N |
| DataArea/Organization/ContactInfo/Email[2] | chaîne | email2 | L'adresse e-mail secondaire de l'organisation. | N |
| DataArea/Organization/ContactInfo/Fax[1] | chaîne | fax1 | Le numéro de fax principal de l'organisation. | N |
| DataArea/Organization/ContactInfo/Fax[2] | chaîne | fax2 | Le numéro de fax secondaire de l'organisation. | N |
| DataArea/Organization/ContactInfo/Address/@type | chaîne | addressType | L'utilisation de l'adresse. Les valeurs admises sont les suivantes :
| N |
| DataArea/Organization/ContactInfo/Address/City | chaîne | city | La ville. | N |
| DataArea/Organization/ContactInfo/Address/StateOrProvinceName | chaîne | état | L'état ou la province (Etats-Unis ou Canada). | N |
| DataArea/Organization/ContactInfo/Address/Country | chaîne | country | Le pays ou la région. | N |
| DataArea/Organization/ContactInfo/Address/PostalCode | chaîne | zipCode | Le code postal. | N |
| DataArea/Organization/ContactInfo/Address/AddressLine[1] | chaîne | address1 | La première ligne de la partie 'numéro et rue' de l'adresse. | N |
| DataArea/Organization/ContactInfo/Address/AddressLine[2] | chaîne | address2 | La deuxième ligne de la partie 'numéro et rue' de l'adresse. | N |
| DataArea/Organization/ContactInfo/Address/AddressLine[3] | chaîne | address3 | La troisième ligne de la partie 'numéro et rue' de l'adresse. | N |
| DataArea/Organization/ContactInfo/Address/UserData/UserDataField | USERDATA | - | Utilisé pour passer des paramètres additionnels à la commande cible. | N |
| DataArea/Organization/ContactInfo/UserData/UserDataField | USERDATA | - | Utilisé pour passer des paramètres additionnels à la commande cible. | N |
| DataArea/Organization/ContextAttribute[j]/Name | chaîne | attributeName partie de la spécification suivante, qui concerne un attribut de membre personnalisé : &attributeName_storeId_r_n=value | Le nom d'un attribut personnalisable. | N |
| DataArea/Organization/ContextAttribute/AttributeValue[k]/Value[n] | chaîne | value partie de la spécification suivante, qui concerne un attribut de membre personnalisé : &attributeName_storeId_r_n=value | La valeur d'un attribut personnalisable. | N |
| DataArea/Organization/ContextAttribute/AttributeValue[k]/StoreID | chaîne | storeId partie de la spécification suivante, qui concerne un attribut de membre personnalisé : &attributeName_storeId_r_n=value | L'ID du magasin auquel s'applique la valeur de l'attribut. S'il n'est pas spécifié, la valeur s'appliquer à tous les magasins. | N |
| DataArea/Organization/UserData/UserDataField | USERDATA | - | Utilisé pour passer des paramètres additionnels à la commande cible. | N |
Ajout ou mise à jour d'une adresse pour une organisation
Les requêtes d'ajout ou de mise à jour d'une adresse pour une personne sont mappées à com.ibm.commerce.usermanagement.commands.AddressAddCmd et com.ibm.commerce.usermanagement.commands.AddressUpdateCmd. Les demandes doivent contenir les informations suivantes :
| XPath* | Type | Mappé au paramètre de commande suivant | Description | Obligatoire |
|---|---|---|---|---|
| ApplicationArea/BusinessContext/ContextData | USERDATA | - | Données de contexte. Par exemple :
| N |
| DataArea/Sync/ActionCriteria/ActionExpression/@actionCode | chaîne | action | Le code d'action. Les valeurs admises sont les suivantes :
| O |
| DataArea/Sync/ActionCriteria/ActionExpression | chaîne | commerceObject | L'expression d'action. Elle doit être spécifiée comme suit :
| O |
| DataArea/Organization/OrganizationIdentifier/DistinguishedName | chaîne | distinguishedName | Le nom distinctif de l'organisation. | O |
| DataArea/Organization/ContactList/ContactEntry/@contactNickName | chaîne | nickName | L'alias ou l'identificateur de l'adresse ajoutée ou mise à jour. Une organisation peut avoir plusieurs adresses, chacune avec un alias. L'adresse qu'une organisation fournit pendant l'inscription est traitée par le système comme la propre adresse de l'organisation. Le système définit le surnom de cette adresse sur la valeur orgEntityName de l'organisation. | O |
| DataArea/Organization/ContactList/ContactEntry/ContactName/LastName | chaîne | lastName | Surnom du contact. | N |
| DataArea/Organization/ContactList/ContactEntry/ContactName/PersonTitle | chaîne | personTitle | Titre du contact ; par exemple, Dr, M. ou Mme. | N |
| DataArea/Organization/ContactList/ContactEntry/ContactName/FirstName | chaîne | firstName | Prénom du contact. | N |
| DataArea/Organization/ContactList/ContactEntry/ContactName/MiddleName | chaîne | middleName | Deuxième prénom du contact. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[1] | chaîne | phone1 | Le numéro de téléphone principal de l'organisation. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[1]/@type | chaîne | phone1Type | Le type de téléphone utilisé pour le numéro de téléphone principal de l'organisation. Par exemple, TTY pour une personne malentendante, PCM pour la modulation par impulsions codées ou CEL (cellulaire) pour un portable. Cette valeur est une zone à trois caractères. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[1]/@publish | chaîne | publishPhone1 | Indique si le numéro de téléphone principal est publié dans l'annuaire. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[2] | chaîne | phone2 | Le numéro de téléphone secondaire de l'organisation. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[2]/@type | chaîne | phone2Type | Le type de téléphone utilisé pour le numéro de téléphone secondaire de l'organisation. Par exemple, TTY pour une personne malentendante, PCM pour la modulation par impulsions codées ou CEL (cellulaire) pour un portable. Cette valeur est une zone à trois caractères. | N |
| DataArea/Organization/ContactList/ContactEntry/Telephone[2]/@publish | chaîne | publishPhone2 | Indique si le numéro de téléphone principal est publié dans l'annuaire. | N |
| DataArea/Organization/ContactList/ContactEntry/Email[1] | chaîne | email1 | L'adresse e-mail principale de l'organisation. | N |
| DataArea/Organization/ContactList/ContactEntry/Email[2] | chaîne | email2 | L'adresse e-mail secondaire de l'organisation. | N |
| DataArea/Organization/ContactList/ContactEntry/Fax[1] | chaîne | fax1 | Le numéro de fax principal de l'organisation. | N |
| DataArea/Organization/ContactList/ContactEntry/Fax[2] | chaîne | fax2 | Le numéro de fax secondaire de l'organisation. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/@type | chaîne | addressType | L'utilisation de l'adresse. Les valeurs admises sont les suivantes :
| N |
| DataArea/Organization/ContactList/ContactEntry/Address/City | chaîne | city | La ville. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/StateOrProvinceName | chaîne | état | L'état ou la province (Etats-Unis ou Canada). | N |
| DataArea/Organization/ContactList/ContactEntry/Address/Country | chaîne | country | Le pays ou la région. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/PostalCode | chaîne | zipCode | Le code postal. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/AddressLine[1] | chaîne | address1 | La première ligne de la partie 'numéro et rue' de l'adresse. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/AddressLine[2] | chaîne | address2 | La deuxième ligne de la partie 'numéro et rue' de l'adresse. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/AddressLine[3] | chaîne | address3 | La troisième ligne de la partie 'numéro et rue' de l'adresse. | N |
| DataArea/Organization/ContactList/ContactEntry/Address/UserData/UserDataField | USERDATA | - | Utilisé pour passer des paramètres additionnels à la commande cible. | N |
| DataArea/Organization/ContactList/ContactEntry/UserData/UserDataField | USERDATA | - | Utilisé pour passer des paramètres additionnels à la commande cible. | N |
* Les préfixes d'espace de noms sont omis pour simplifier la présentation.
Exemples
- SyncOrganization.xml - Ajout d'une organisation
- SyncOrganizationAddress.xml - Ajout d'une adresse pour une organisation
Réponse
Les réponses de ce service Web entrant ont la forme de documents BOD ConfirmBOD.
La réponse à une demande d'ajout ou de mise à jour d'une organisation contient les informations suivantes :
| XPath* | Type | Description |
|---|---|---|
| DataArea/BOD/BODSuccessMessage | - | Cet élément est présent si la demande a été traitée avec succès. |
| DataArea/BOD/BODSuccessMessage/UserArea/Organization/OrganizationIdentifier/UniqueID | chaîne | ID de membre de l'organisation |
La réponse à une requête d'ajout ou de mise à jour d'une adresse pour une organisation contient les informations suivantes :
| XPath* | Type | Description |
| DataArea/BOD/BODSuccessMessage | - | Cet élément est présent si la demande a été traitée avec succès. |
* Les préfixes d'espace de noms sont omis pour simplifier la présentation.
Exemples
- ConfirmBODOrganization.xml - réponse lorsque l'ajout ou la mise à jour d'une organisation a réussi
- ConfirmBODAddress.xml - réponse lorsque l'ajout ou la mise à jour d'une adresse pour une organisation a réussi
Exceptions
Toutes les exceptions sont renvoyées sous forme de documents BOD ConfirmBOD avec un élément ResponseCriteria sous le verbe Confirm. Elles contiennent les informations suivantes :
| XPath* | Type | Description |
|---|---|---|
DataArea/Confirm/ResponseCriteria/ChangeStatus/Code |
chaîne | L'identificateur de corrélation. Peut être utilisé pour identifier de manière unique une exception dans les journaux du serveur. |
DataArea/Confirm/ResponseCriteria/ChangeStatus/ReasonCode |
chaîne | Le code raison, qui est soit un code d'erreur système de HCL Commercecode d'erreur système de HCL Commerces'il est disponible, soit la clé de message EC plus un code d'erreur secondaire en option, si le code d'erreur système de HCL Commerce n'est pas disponible (ce qui est généralement le cas lorsque l'exception est émise par l'application). |
DataArea/Confirm/ResponseCriteria/ChangeStatus/Reason |
chaîne | Le message de l'exception. |
* Les préfixes d'espace de noms sont omis pour simplifier la présentation.
Fichier de mappage de messages utilisé : SyncOrganizationBODMapping.xml
Exemples
- SyncOrganization.xml
- SyncOrganizationAddress.xml
- ConfirmBODOrganizationError.xml - réponse avec exception lorsqu'il manque un paramètre obligatoire.