edit_mandate_batch


POST  -- Mass modification of mandate statuses

Argument Description Type - Length Example Mandatory
statusNew mandate statusString - 2YES
umrList of mandate's UMR to modifyJsonYES


Request

POST /ssp/edit_mandate_batch HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json


{
    "status": "1",
    "umr" : [
        "SSP-202102081745512868",
        "SSP-202102081745153790",
        "SSP-202011061043565298",
        "SSP-202102081706407076",
        "SSP-202011061045536685"
    ]
}

                                                    

If modification has succeeded

Response

HTTP/1.1 200 OK
Content-Type: application/json


{
    "result": true,
    "mandats": [
            {
            "umr": "SSP-202102081745512868",
            "status": "1"
                    },
                    {
            "umr": "SSP-202102081745153790",
            "status": "1"
                    },
                    {
            "umr": "SSP-202011061043565298",
            "status": "1"
                    },
                    {
            "umr": "SSP-202102081706407076",
            "status": "1"
                    },
                    {
            "umr": "SSP-202011061045536685",
            "status": "1"
            }
        ]
}

                                                

If modification failed

Response

POST /ssp/edit_mandate_batch HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json


{
    "result" : false,
    "code" : "XXXX"
}
                                                

Argument Description
result true or false :
true : action succeeded
false : action failed
mandats List of mandates with the status of each mandate
- umr
- status
If mandate's modification is not allowed it will keep it's initial status.
code See (error codes in annex).
Request

HTTP/1.1 200 OK
POST /ssp/edit_mandate_batch HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json