Read article cards
You use this method to read one or more article cards.
Request method
GET
Request url
https://ponte.venice.be/webconnect/api/{DossierId}/Article?{Key}={KeyValues}[&fields={FieldList}][&partFields={FieldList}]
Context identification
Identification | Description |
---|---|
DossierId | The unique identifier of the dossier. |
Parameters
Parameter | Description |
---|---|
{Key} | The available keys to seek one or more articles: |
Fields | List of fields, containing property names of the article card, of which the value has to be returned in the response body. (optional) |
PartFields | List of part fields, containing property names of the article part, of which the value has to be returned in the response body. (optional) |
https://ponte.venice.be/WebConnect/api/Demo/Article?Number=1&fields=Number,DscLng1,SalesPrice&partFields=ArtNumPart,Quantity
Request header
See request header.
Request body
-Http status
See http status.Response body
You can receive the response in json or xml.
Structure
Response (object)
- Articles (array)
- Article (array item)
- Fields (object)
- Parts (array)
- Part (array item)
- Fields (object)
Examples
{ "Response": { "Articles": { "Article": [ { "Fields" : { "Number": "MyArticle", "DscLng1": "My article description", "SalesPrice": "1.98" }, "Parts": { "Part": [ { "Fields": { "ArtNumPart": "MyPart", "Quantity": "1.00" } }, ... ] } } ] } } }
<?xml version="1.0" encoding="utf-8"?> <Response> <Articles> <Article> <Fields> <Number>MyArticle</Number> <DscLng1>My article description</DscLng1> <SalesPrice>1.98</SalesPrice> </Fields> <Parts> <Part> <Fields> <ArtNumPart>MyPart</ArtNumPart> <Quantity>1.00</Quantity> </Fields> ... </Part> </Parts> </Article> </Articles> </Response>