API Documentation - FAM1 List
Endpoint
GET /FAM1/LIST/
Parameters
The following query parameter can be included in the request:
champstraduit
(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": {
"fam1": [
{
"fam1ID": "Unique family 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"
}
// Additional FAM1 items
]
}
}
Error Handling
If an error occurs, the response will contain the following fields:
{
"success": "false",
"message": "Error description"
}
Example Request
GET /FAM1/LIST/?champstraduit=Fam_Libelles
Example Response
{
"success": "true",
"message": "FAM1 List",
"result": {
"fam1": [
{
"fam1ID": 1,
"name": "Terrasement",
"champsLangueAutiliser": "Terracing",
"libWebLangue1": "Terracing",
"libWebLangue2": "NivelaciĆ³n",
"libWebLangue3": "Terrassement",
"libWebLangue4": "Terraplenagem",
"webOrder": 1,
"photo1_base64": "data:image/png;base64,...",
"photo1_base64_secondaire": "data:image/png;base64,...",
"photo": "image.png"
}
// Additional FAM1 items
]
}
}