This section provide some detailed information the use of the forms
List all the available forms
using the endpoint https://api.medicys-conventionnel.fr/api/form/GetAll (for the sandbox, use https://staging-api.medicys-conventionnel.fr/api/form/GetAll), you can list all the available form. Here is an example of the response you could get :
[
{
"code": "NeighborhoodConflict",
"rank": 13,
"id": "0ac9768c-bc1c-4ca6-b494-f7fa409cb51b",
"caption": "Litiges de voisinage"
},
{
"code": "CustomerSeller",
"rank": 14,
"id": "9e433d4a-4e2b-4426-833c-dcf886a64c13",
"caption": "Litiges commercial"
},
{
"code": "TenantOwner",
"rank": 15,
"id": "6ac41de6-83f1-49cf-a33c-7a9865393423",
"caption": "Litige locatif"
},
{
"code": "Family",
"rank": 16,
"id": "937c33a4-c36e-4b00-ba8b-c3fe89dc3efc",
"caption": "Litige familial"
},
{
"code": "EmployerEmploye",
"rank": 17,
"id": "a52e528d-8c55-41a6-9144-3235e6fd3bca",
"caption": "Litige en entreprise"
},
{
"code": "Other",
"rank": 18,
"id": "fbce11c5-7e00-4251-864b-b27665841d3a",
"caption": "Autre"
}
]
From here, you would pick a form that would best describe your case. Let's go with "Litige familial". Note the corresponding FormId (in our case "937c33a4-c36e-4b00-ba8b-c3fe89dc3efc").
List the option of a specific form
Once you have a FormId, you can list the different options available via https://api.medicys-conventionnel.fr/api/form/GetDescription (for the sandbox, use https://staging-api.medicys-conventionnel.fr/api/form/GetDescription). Here is an example of the response you could get :
{
"sections": [
{
"id": "cba19ad0-09f5-4740-bd91-c5c597487fca",
"caption": "Le litige concerne",
"help": null,
"rank": 0,
"options": [
{
"id": "944f12e0-c6b4-4804-83e4-82972f010213",
"caption": "Les créneaux de garde d’enfants",
"captionComplement": null,
"help": null,
"rank": 0,
"complementType": 0,
"complementLength": 0
},
{
"id": "17d78ce3-963e-46d7-8e64-d1f272aebcb8",
"caption": "Le paiement de pension alimentaire",
"captionComplement": null,
"help": null,
"rank": 1,
"complementType": 0,
"complementLength": 0
},
{
"id": "ff13ad22-aa87-4438-9295-ee871eb940a7",
"caption": "Le paiement de prestation compensatoire",
"captionComplement": null,
"help": null,
"rank": 2,
"complementType": 0,
"complementLength": 0
},
{
"id": "edaf6f0a-dc8c-4b2f-95f2-487c7b09dc4c",
"caption": "La répartition du patrimoine",
"captionComplement": null,
"help": null,
"rank": 3,
"complementType": 0,
"complementLength": 0
},
{
"id": "58a8946d-3487-45d0-afa6-84de9158e0dd",
"caption": "Un comportement d’un des membres de la famille",
"captionComplement": null,
"help": null,
"rank": 4,
"complementType": 0,
"complementLength": 0
},
{
"id": "a3d46ef9-53b6-4fb6-b866-db3c9f6a62e3",
"caption": "Autre",
"captionComplement": null,
"help": null,
"rank": 5,
"complementType": 0,
"complementLength": 0
}
]
}
],
"id": "937c33a4-c36e-4b00-ba8b-c3fe89dc3efc",
"caption": "Litige familial"
}
In the first section, you will see a list of options for that specific form. Pick the ones that best suits your case. Lets go with : "Le paiement de pension alimentaire". Note the corresponding option Id (in our case "17d78ce3-963e-46d7-8e64-d1f272aebcb8")
Creating a description
When creating a description, you would use the FormId and the OptionId previously mentioned as parameters of the request to the endpoints https://api.medicys-conventionnel.fr/api/form/CreateDescription (for the sandbox, use https://staging-api.medicys-conventionnel.fr/api/form/CreateDescription). Like so :
{
"FileId": "27FF7826-0DED-4101-9FB4-81991117B656",
"FormId": "937c33a4-c36e-4b00-ba8b-c3fe89dc3efc",
"PartyId": "4B2D72C1-5B55-441F-BA03-3F4383219DCC",
"AdditionalInformation": "Mon litige 2",
"AnswerOptions":
{
"17d78ce3-963e-46d7-8e64-d1f272aebcb8": "Le paiement de pension alimentaire"
}
}
List the proposal of a specific form
Once you have a FormId, you can list the different proposal available via https://api.medicys-conventionnel.fr/api/form/GetProposition (for the sandbox, use https://staging-api.medicys-conventionnel.fr/api/form/GetProposition). Here is an example of the response you could get :
{
"sections": [
{
"id": "e87db8b2-1f8c-46dd-9117-a08e0b30c78e",
"caption": "Financièrement",
"help": null,
"rank": 0,
"options": [
{
"id": "e0cd0617-cda3-455a-bc62-4afd73daf2f7",
"caption": "Un paiement en une seule fois",
"captionComplement": null,
"help": null,
"rank": 0,
"complementType": 0,
"complementLength": 0
},
{
"id": "7c70e97a-a1d0-4a6a-8afd-ae2df45d19e9",
"caption": "Un paiement mensualisé",
"captionComplement": null,
"help": null,
"rank": 1,
"complementType": 0,
"complementLength": 0
},
{
"id": "b4d14b52-189c-4e10-9bcc-ca6bfdc1220b",
"caption": "Une annulation de tout ou partie de la dette",
"captionComplement": null,
"help": null,
"rank": 2,
"complementType": 0,
"complementLength": 0
}
]
},
{
"id": "d8cdd409-1a9f-4c78-9ed3-b0e86d16680e",
"caption": "Matériellement",
"help": null,
"rank": 1,
"options": [
{
"id": "1dd7941c-6274-4329-8173-8342ff7389ac",
"caption": "Une livraison de bien",
"captionComplement": null,
"help": null,
"rank": 0,
"complementType": 0,
"complementLength": 0
},
{
"id": "c0eed10c-a09f-4638-903e-a4836fc4440d",
"caption": "Une fourniture de service",
"captionComplement": null,
"help": null,
"rank": 1,
"complementType": 0,
"complementLength": 0
},
{
"id": "00361997-df35-49c2-b19a-26f600dc2b89",
"caption": "Un retour de bien",
"captionComplement": null,
"help": null,
"rank": 2,
"complementType": 0,
"complementLength": 0
},
{
"id": "1e7c5ac9-0a5e-4dc0-bafd-212e8b543ce5",
"caption": "Un échange ou remplacement du bien",
"captionComplement": null,
"help": null,
"rank": 3,
"complementType": 0,
"complementLength": 0
}
]
},
{
"id": "7211670c-93fa-4fe1-9bc5-5c5b949b40dd",
"caption": "Factuellement",
"help": null,
"rank": 2,
"options": [
{
"id": "4ada6672-5208-46b6-9226-ce43be20b988",
"caption": "Un changement de comportement/d’habitude",
"captionComplement": null,
"help": null,
"rank": 0,
"complementType": 0,
"complementLength": 0
},
{
"id": "229340c0-c56c-43cf-971c-8153e881c2e4",
"caption": "Une mise à disposition des informations demandées",
"captionComplement": null,
"help": null,
"rank": 1,
"complementType": 0,
"complementLength": 0
}
]
}
],
"id": "937c33a4-c36e-4b00-ba8b-c3fe89dc3efc",
"caption": "Litige familial"
}
In the first section, you will see a list of proposal, with different options for that specific form. Pick the options that best suits your case. Lets go with : "Un paiement en une seule fois". Note the corresponding Id (in our case "e0cd0617-cda3-455a-bc62-4afd73daf2f7")
Create a proposal
When creating a proposal, you would use the FormId and the OptionId previously mentioned as parameters of the request to the endpoints https://api.medicys-conventionnel.fr/api/form/CreateProposition (for the sandbox, use https://staging-api.medicys-conventionnel.fr/api/form/CreateProposition). Like so :
{
"FileId": "27FF7826-0DED-4101-9FB4-81991117B656",
"FormId": "937c33a4-c36e-4b00-ba8b-c3fe89dc3efc",
"PartyId": "4B2D72C1-5B55-441F-BA03-3F4383219DCC",
"PartyType": "Party1",
"AdditionalInformation": "Additional info",
"ProposalReason": "Mes raisons",
"ModifiedDate": "2020-05-29T16:50:20.879Z",
"AnswerOptions": {
"e0cd0617-cda3-455a-bc62-4afd73daf2f7": "Un paiement en une seule fois"
}
}