Finxera

Back to documentation index

updateSchedule

A schedule can be rescheduled using the updateSchedule API. The update can be done only for certain schedule statuses and not all.

Request Parameters

  Parameter Required Type Description
subscriberId Y Long Specify the Subscriber ID issued, when BancBox account was created
+ activity Y Object Specify the activity Id that has to be rescheduled.
rescheduleDate Y Date Specify the date on which the activity has to be rescheduled for.

Response Parameters

  Parameter   Type Description
requestId   Long 13 digit ID for the API request being made
status   Int It is the Status of completed request, (1 for pass or 0 for fail)
+ warnings   Object A Warning object containing a code and description.
+ errors   Object Request failed, error response.
rescheduleDate   Date The reschedule date for the activity

WSDL URL (Production) :  https://api.bancbox.com/v3/BBXPort?wsdl
WSDL URL (SandBox) :  https://sandbox-api.bancbox.com/v3/BBXPort?wsdl

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="schema.bancbox.com">
   <soapenv:Header/>
   <soapenv:Body>
      <sch:updateSchedule>
         <updateScheduleRequest>
            <subscriberId>?</subscriberId>
            <activity>
               <!--Optional:-->
               <bancBoxId>?</bancBoxId>
            </activity>
            <rescheduleDate>?</rescheduleDate>
         </updateScheduleRequest>
      </sch:updateSchedule>
   </soapenv:Body>
</soapenv:Envelope>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:updateScheduleResponse xmlns:ns1="schema.bancbox.com">
         <return xsi:type="ns3:updateScheduleResponse" xmlns:ns3="schema.bancbox.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <requestId>?</requestId>
            <status>?</status>
            <rescheduleDate>?</rescheduleDate>
         </return>
      </ns1:updateScheduleResponse>
   </soap:Body>
</soap:Envelope>

Note:For REST, Content-type should be set to application/json
URL (Production) :  https://api.bancbox.com/v3/BBXPortRest/updateSchedule
URL (SandBox) :  https://sandbox-api.bancbox.com/v3/BBXPortRest/updateSchedule

Sample Request

{
    "authentication": {
        "apiKey": "YOUR_API_KEY_HERE",
        "secret": "SECRET_PASSPHRASE"
    },
    "subscriberId": "",
    "linkedClientId": {
        "bancBoxId": "",
        "subscriberReferenceId": ""
    },
    "merchantFirstName": "",
    "merchantLastName": "",
    "merchantTaxId": "",
    "createdOnFromDate": "",
    "createdOnToDate": "",
    "modifiedOnFromDate": "",
    "modifiedOnToDate": "",
    "ascending": "",
    "pageNo": "",
    "resultsPerPage": ""
}

Sample Response

{
   "rescheduleDate": "",
   "requestId":,
   "status": ,
   "warnings": 
}

Note: This is a beta version. The api listed here are likely to change.