API Documentation - FAM2 List
Endpoint
GET /FAM2/LIST/
Parameters
The following query parameters can be included in the request:
fam1ID
(optional): Filters the FAM2 items by FAM1 ID.fam2ID
(optional): Filters the FAM2champstraduit
(optional): Specifies the translated field to use in the response. Valid values are:Fam_Libelles
Fam_Libelles2
Fam_Libelles3
Fam_Libelles4
Response
The response is a JSON object containing the following fields:
{
"success": "true or false",
"message": "Description of the response",
"result": {
"fam2": [
{
"fam2ID": "Unique family 2 ID",
"fam1ID": "Unique family 1 ID",
"name": "Family name",
"champsLangueAutiliser": "Translated field value",
"libWebLangue1": "Web label in language 1",
"libWebLangue2": "Web label in language 2",
"libWebLangue3": "Web label in language 3",
"libWebLangue4": "Web label in language 4",
"webOrder": "Web order",
"photo1_base64": "Primary photo in base64",
"photo1_base64_secondaire": "Secondary photo in base64",
"photo": "Photo",
"text_if_only_one_product": "text of presentation of the unique product of the list",
}
// Additional FAM2 items
]
}
}
Error Handling
If an error occurs, the response will contain the following fields:
{
"success": "false",
"message": "Error description"
}
Example Request
GET /FAM2/LIST/?fam1ID=1&champstraduit=Fam_Libelles
Example Response
{
"success": "true",
"message": "FAM2 List",
"result": {
"fam2": [
{
"fam2ID": 1,
"fam1ID": 1,
"name": "Example Name",
"champsLangueAutiliser": "Example Translated Field",
"libWebLangue1": "Web Label 1",
"libWebLangue2": "Web Label 2",
"libWebLangue3": "Web Label 3",
"libWebLangue4": "Web Label 4",
"webOrder": 1,
"photo1_base64": "data:image/png;base64,...",
"photo1_base64_secondaire": "data:image/png;base64,...",
"photo": "image.png"
}
// Additional FAM2 items
]
}
}