<h1> WEB SERVICES "Pièces"</h1> <h2 style="background: rgb(65, 131, 215); color: rgb(255, 255, 255); padding: 10px;">PutDocument</h2> <h3 style="color: rgb(65, 131, 215);">Description</h3> <p> Permet la création d'un document (ex.: Commande client) et la gestion de son workflow (grâce aux fonctions API "GetDocumentStatus" et "GetDocumentsStatus"). </p> <h3 style="color: rgb(65, 131, 215);">Méthode</h3> <p> POST </p> <h3 style="color: rgb(65, 131, 215);">Paramètres</h3>

Nom	Type	Description	Méthode	Valeur par défaut
content *	String	Contenu du document au format XML (voir schéma XSD “Content” + Descriptif champs “Content” ci-dessous).	POST
AccountId *	Int	Id du Tiers de la pièce	URL
Status *	Int	Etat de traitement. 41 = En attente, 42 = Validée (en attente de traitement)	URL
WorkflowId	Int	Id du workflow à mettre à jour. Si non renseigné (ou vide ou =0), il s'agit alors d'un nouveau document.	URL	0

Descriptif champs "Content"
Descriptif XSD du champ "Content" pour validation XML
Exemple XML du champ "Content" <h3 style="color: rgb(65, 131, 215);">Retour</h3>

Nom	Type	Description
WorkflowId	Int	Id du Workflow nouvellement créé (Null si erreur à la création) ou Id du Workflow modifié
State	Int	Etat de l'action. 0 = Erreur, 1 = OK
Message	String	Message de l'erreur.

<h3 style="color: rgb(65, 131, 215);">Formalisme</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/PutDocument?CustomerName={customerName}&AccountId={accountId}&Status={status}&WorkflowId={workflowId}</code></pre> <h3 style="color: rgb(65, 131, 215);">Exemple</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/PutDocument?CustomerName=DEMO&AccountId=1000367&Status=41 </code></pre> <hr> <h2 style="background: rgb(65, 131, 215); color: rgb(255, 255, 255); padding: 10px;">GetDocumentStatus</h2> <h3 style="color: rgb(65, 131, 215);">Description</h3> <p> Permet la récupération de l'état d'un document (workflow) créé par la fonction API "PutDocument". </p> <h3 style="color: rgb(65, 131, 215);">Paramètres</h3>

Nom	Type	Description	Valeur par défaut
WorkflowId *	Int	Id de Workflow créé

<h3 style="color: rgb(65, 131, 215);">Retour</h3>

Nom	Type	Description
Status	Int	40 = Simulation, 41 = En attente, 42 = Validée (en attente de traitement), 43 = Refusée, 44 = En cours de traitement, 45 = Traitée, 46 = Clôturée, 47 = Rejeté
StatusName	String	40 = Simulation, 41 = En attente, 42 = Validée (en attente de traitement), 43 = Refusée, 44 = En cours de traitement, 45 = Traitée, 46 = Clôturée, 47 = Rejeté
UpdateDate	DateTime	Date de dernière modification

<h3 style="color: rgb(65, 131, 215);">Formalisme</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocumentStatus?CustomerName={customerName}&WorkflowId={workflowId}</code></pre> <h3 style="color: rgb(65, 131, 215);">Exemple</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocumentStatus?CustomerName=DEMO&WorkflowId=1000010283 </code></pre> <hr> <h2 style="background: rgb(65, 131, 215); color: rgb(255, 255, 255); padding: 10px;">GetDocumentsStatus</h2> <h3 style="color: rgb(65, 131, 215);">Description</h3> <p> Permet la récupération de tous les états des documents créés par la fonction API "PutDocument" et modifiés depuis une date donnée. </p> <h3 style="color: rgb(65, 131, 215);">Paramètres</h3>

Nom	Type	Description	Valeur par défaut
UpdatedSince *	DateTime	Date-heure permettant de ne retourner que les documents dont l'état a été modifié depuis le

<h3 style="color: rgb(65, 131, 215);">Retour</h3>

Nom	Type	Description
WorkflowId	Int	Id de Workflow
Status	Int	40 = Simulation, 41 = En attente, 42 = Validée (en attente de traitement), 43 = Refusée, 44 = En cours de traitement, 45 = Traitée, 46 = Clôturée, 47 = Rejeté
StatusName	String	40 = Simulation, 41 = En attente, 42 = Validée (en attente de traitement), 43 = Refusée, 44 = En cours de traitement, 45 = Traitée, 46 = Clôturée, 47 = Rejeté
UpdateDate	DateTime	Date de dernière modification

<h3 style="color: rgb(65, 131, 215);">Formalisme</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocumentsStatus?CustomerName={customerName}&UpdateSince={updateSince}</code></pre> <h3 style="color: rgb(65, 131, 215);">Exemple</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocumentsStatus?CustomerName=DEMO&UpdateSince=13-12-2017 </code></pre> <hr> <h2 style="background: rgb(65, 131, 215); color: rgb(255, 255, 255); padding: 10px;">GetDocument</h2> <h3 style="color: rgb(65, 131, 215);">Description</h3> <p> Permet la récupération des informations / du contenu d'un document. </p> <h3 style="color: rgb(65, 131, 215);">Paramètres</h3>

Nom	Type	Description	Valeur par défaut
DocumentId *	Int	Id du document

<h3 style="color: rgb(65, 131, 215);">Retour</h3>

Nom	Type	Description
ID	Int	Id du document
IDENT_EXTERNE	String	Identification externe du document
ID_TYPE_PIECE	Int	Id du type de document
TYPE_PIECE	String	Intitulé du type de document
NO_PIECE	String	Numéro du document
IMMATRICULATION	String	Immatriculation du document
COMMENTAIRE	String	Commentaires du document
ID_ENTITE_SITE	Int	Id de l'entité site du document
ENTITE_SITE	String	Intitulé de l'entité site du document
ID_ENTITE_ADMINISTRATIVE	Int	Id de l'entité administrative du document
ENTITE_ADMINISTRATIVE	String	Intitulé de l'entité administrative du document
ID_MODE_REGLEMENT	Int	Id du mode de réglement
MODE_REGLEMENT	String	Intitulé du mode de réglement
ID_TYPE_ECHEANCE	Int	Id du type d'échéance
TYPE_ECHEANCE	String	Intitulé du type d'échance
DATE_PIECE	DateTime	Date du document
DATE_ECHEANCE	DateTime	Date de l'échéance du document
ID_REGIME_TAXE	Int	Id du régime de taxe
REGIME_TAXE	String	Intitulé du régime de taxe
ID_TIERS	Int	Id du tiers du document
NOM_TIERS	String	Nom_Prénom du Tiers du document
ADRESSE	String	Adresse de la pièce
VILLE	String	Ville de la pièce
ID_TRANSPORTEUR	Int	Id du transporteur
NOM_TRANSPORTEUR	String	Intitulé du transporteur
ID_ATC	Int	Id de l'ATC
NOM_ATC	String	Nom_Prénom de l'ATC
UPDATE_DATE	DateTime	Date de dernière modification de l'article
STATUS	Boolean	[0/1], 1=Normal, 0=Supprimé

<h3 style="color: rgb(65, 131, 215);">Formalisme</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocument?CustomerName={customerName}&DocumentId={documentId}</code></pre> <h3 style="color: rgb(65, 131, 215);">Exemple</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocument?CustomerName=DEMO&DocumentId= </code></pre> <hr> <h2 style="background: rgb(65, 131, 215); color: rgb(255, 255, 255); padding: 10px;">GetDocuments</h2> <h3 style="color: rgb(65, 131, 215);">Description</h3> <p> Permet la récupération des informations / du contenu des documents pour un Tiers donné. </p> <h3 style="color: rgb(65, 131, 215);">Paramètres</h3>

Nom	Type	Description	Valeur par défaut
ThirdPartyId *	Int	Id du Tiers
DateFrom	DateTime	Date-heure de début de la plage de date de sélection	01/01/1900
DateTo	DateTime	Date-heure de fin de la plage de date de sélection	31/12/2099
CreatedSince	DateTime	Date-heure permettant de ne retourner que les document ayant eu une création quelconque depuis le	01/01/1900
UpdatedSince	DateTime	Date-heure permettant de ne retourner que les document ayant eu une modification quelconque depuis le	01/01/1900
UpdatedSinceDB	DateTime	Date-heure permettant de ne retourner que les document ayant eu une modification en base de données quelconque depuis le	01/01/1900
Revision	Boolean	true=Voir uniquement les révisés, false=Toutes	true
Deleted	Boolean	true=Voir aussi les documents supprimés, false=Ne pas voir les supprimés	false

<h3 style="color: rgb(65, 131, 215);">Retour</h3>

Nom	Type	Description
ID	Int	Id du document
IDENT_EXTERNE	String	Identification externe du document
ID_TYPE_PIECE	Int	Id du type de document
TYPE_PIECE	String	Intitulé du type de document
NO_PIECE	String	Numéro du document
IMMATRICULATION	String	Immatriculation du document
COMMENTAIRE	String	Commentaires du document
ID_ENTITE_SITE	Int	Id de l'entité site du document
ENTITE_SITE	String	Intitulé de l'entité site du document
ID_ENTITE_ADMINISTRATIVE	Int	Id de l'entité administrative du document
ENTITE_ADMINISTRATIVE	String	Intitulé de l'entité administrative du document
ID_MODE_REGLEMENT	Int	Id du mode de réglement
MODE_REGLEMENT	String	Intitulé du mode de réglement
ID_TYPE_ECHEANCE	Int	Id du type d'échéance
TYPE_ECHEANCE	String	Intitulé du type d'échance
DATE_PIECE	DateTime	Date du document
DATE_ECHEANCE	DateTime	Date de l'échéance du document
ID_REGIME_TAXE	Int	Id du régime de taxe
REGIME_TAXE	String	Intitulé du régime de taxe
ID_TIERS	Int	Id du tiers du document
NOM_TIERS	String	Nom_Prénom du Tiers du document
ADRESSE	String	Adresse de la pièce
VILLE	String	Ville de la pièce
ID_TRANSPORTEUR	Int	Id du transporteur
NOM_TRANSPORTEUR	String	Intitulé du transporteur
ID_ATC	Int	Id de l'ATC
NOM_ATC	String	Nom_Prénom de l'ATC
UPDATE_DATE	DateTime	Date de dernière modification de l'article
STATUS	Boolean	[0/1], 1=Normal, 0=Supprimé

<h3 style="color: rgb(65, 131, 215);">Formalisme</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocuments?CustomerName={customerName}&ThirdPartyId={thirdPartyId}&DateFrom={dateFrom}&DateTo={dateTo}&CreatedSince={createdSince}&UpdatedSince={updatedSince}&UpdatedSinceDB={updatedSinceDB}&Revision={revision}&Deleted={deleted}</code></pre> <h3 style="color: rgb(65, 131, 215);">Exemple</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocuments?CustomerName=DEMO&ThirdPartyId=&DateFrom=01-10-2017 14:30&DateTo=30-10-2017 20:30&CreatedSince=01-10-2017 14:30&UpdatedSince=01-10-2017 14:30&UpdatedSinceDB=01-10-2017 14:30&Revision=1&Deleted=0 </code></pre> <hr> <h2 style="background: rgb(65, 131, 215); color: rgb(255, 255, 255); padding: 10px;">GetDocuments</h2> <h3 style="color: rgb(65, 131, 215);">Description</h3> <p> Permet la récupération des informations / du contenu des documents pour un type de document donné. </p> <h3 style="color: rgb(65, 131, 215);">Paramètres</h3>

Nom	Type	Description	Valeur par défaut
DocumentTypesIds *	String	Liste des IDs types des documents séparés par des ,
ThirdPartyTypesIds*	String	Liste des IDs types des tiers séparés par des ,
ATCIds*	String	Liste des IDs d'ATC séparés par des ,
DateFrom	DateTime	Date-heure de début de la plage de date de sélection	01/01/1900
DateTo	DateTime	Date-heure de fin de la plage de date de sélection	31/12/2099
CreatedSince	DateTime	Date-heure permettant de ne retourner que les document ayant eu une création quelconque depuis le	01/01/1900
UpdatedSince	DateTime	Date-heure permettant de ne retourner que les document ayant eu une modification quelconque depuis le	01/01/1900
UpdatedSinceDB	DateTime	Date-heure permettant de ne retourner que les document ayant eu une modification en base de données quelconque depuis le	01/01/1900
Revision	Boolean	true=Voir uniquement les révisés, false=Toutes	true
Deleted	Boolean	true=Voir aussi les documents supprimés, false=Ne pas voir les supprimés	false

<h3 style="color: rgb(65, 131, 215);">Retour</h3>

Nom	Type	Description
ID	Int	Id du document
IDENT_EXTERNE	String	Identification externe du document
ID_TYPE_PIECE	Int	Id du type de document
TYPE_PIECE	String	Intitulé du type de document
NO_PIECE	String	Numéro du document
IMMATRICULATION	String	Immatriculation du document
COMMENTAIRE	String	Commentaires du document
ID_ENTITE_SITE	Int	Id de l'entité site du document
ENTITE_SITE	String	Intitulé de l'entité site du document
ID_ENTITE_ADMINISTRATIVE	Int	Id de l'entité administrative du document
ENTITE_ADMINISTRATIVE	String	Intitulé de l'entité administrative du document
ID_MODE_REGLEMENT	Int	Id du mode de réglement
MODE_REGLEMENT	String	Intitulé du mode de réglement
ID_TYPE_ECHEANCE	Int	Id du type d'échéance
TYPE_ECHEANCE	String	Intitulé du type d'échance
DATE_PIECE	DateTime	Date du document
DATE_ECHEANCE	DateTime	Date de l'échéance du document
ID_REGIME_TAXE	Int	Id du régime de taxe
REGIME_TAXE	String	Intitulé du régime de taxe
ID_TIERS	Int	Id du tiers du document
NOM_TIERS	String	Nom_Prénom du Tiers du document
ADRESSE	String	Adresse de la pièce
VILLE	String	Ville de la pièce
ID_TRANSPORTEUR	Int	Id du transporteur
NOM_TRANSPORTEUR	String	Intitulé du transporteur
ID_ATC	Int	Id de l'ATC
NOM_ATC	String	Nom_Prénom de l'ATC
UPDATE_DATE	DateTime	Date de dernière modification de l'article
STATUS	Boolean	[0/1], 1=Normal, 0=Supprimé

<h3 style="color: rgb(65, 131, 215);">Formalisme</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocuments?CustomerName={customerName}&DocumentTypesIds={documentTypesIds}&ThirdPartyTypesIds={thirdPartyTypesIds}&ATCIds={ATCIds}&DateFrom={dateFrom}&DateTo={dateTo}&CreatedSince={createdSince}&UpdatedSince={updatedSince}&UpdatedSinceDB={updatedSinceDB}&Revision={revision}&Deleted={deleted}</code></pre> <h3 style="color: rgb(65, 131, 215);">Exemple</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocuments?CustomerName=DEMO&DocumentTypesIds=&ThirdPartyTypesIds=&ATCIds=&DateFrom=01-10-2017 14:30&DateTo=30-10-2017 20:30&CreatedSince=01-10-2017 14:30&UpdatedSince=01-10-2017 14:30&UpdatedSinceDB=01-10-2017 14:30&Revision=1&Deleted=0 </code></pre> <hr> <h2 style="background: rgb(65, 131, 215); color: rgb(255, 255, 255); padding: 10px;">GetDocumentDetailLines</h2> <h3 style="color: rgb(65, 131, 215);">Description</h3> <p> Permet la récupération des lignes d'une pièce donnée </p> <h3 style="color: rgb(65, 131, 215);">Paramètres</h3>

Nom	Type	Description	Valeur par défaut
DocumentId *	Int	ID du document
UpdatedSince	DateTime	Date-heure permettant de ne retourner que les document ayant eu une modification quelconque depuis le	01/01/1900
Deleted	Boolean	true=Voir aussi les documents supprimés, false=Ne pas voir les supprimés	false

<h3 style="color: rgb(65, 131, 215);">Retour</h3>

Nom	Type	Description
ID	Int	Id du document
UPDATE_DATE	DateTime	Date de dernière modification de l'article
STATUS	Boolean	[0/1], 1=Normal, 0=Supprimé

<h3 style="color: rgb(65, 131, 215);">Formalisme</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocumentDetailLines?CustomerName={customerName}&DocumentId={documentId}&UpdatedSince={updatedSince}&Deleted={deleted}</code></pre> <h3 style="color: rgb(65, 131, 215);">Exemple</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocumentDetailLines?CustomerName=DEMO&DocumentId=&UpdatedSince=01-10-2017 14:30&Deleted=0 </code></pre> <hr> <h2 style="background: rgb(65, 131, 215); color: rgb(255, 255, 255); padding: 10px;">GetDocumentFooterLines</h2> <h3 style="color: rgb(65, 131, 215);">Description</h3> <p> Permet la récupération des lignes pied d'une pièce donnée </p> <h3 style="color: rgb(65, 131, 215);">Paramètres</h3>

Nom	Type	Description	Valeur par défaut
DocumentId *	Int	ID du document
UpdatedSince	DateTime	Date-heure permettant de ne retourner que les document ayant eu une modification quelconque depuis le	01/01/1900
Deleted	Boolean	true=Voir aussi les documents supprimés, false=Ne pas voir les supprimés	false

<h3 style="color: rgb(65, 131, 215);">Retour</h3>

Nom	Type	Description
ID	Int	Id du document
UPDATE_DATE	DateTime	Date de dernière modification de l'article
STATUS	Boolean	[0/1], 1=Normal, 0=Supprimé

<h3 style="color: rgb(65, 131, 215);">Formalisme</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocumentFooterLines?CustomerName={customerName}&DocumentId={documentId}&UpdatedSince={updatedSince}&Deleted={deleted}</code></pre> <h3 style="color: rgb(65, 131, 215);">Exemple</h3> <pre><code>http://api.analys-informatique.com/AnalysWebService.API.Documents.svc/GetDocumentFooterLines?CustomerName=DEMO&DocumentId=&UpdatedSince=01-10-2017 14:30&Deleted=0 </code></pre> <hr>

Tracedump:

newBaseSize: 16pt
newBaseSizeInPt: 16