Read BatchStatus

Retrieves the details of a batch object that has been previously created.

Parameters

Path Params
yourCompany:	string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/BatchStatus will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/BatchStatus
batch_id	string Batch id needs to be passed as an path parameter, batch id is returned with bulk process message..For eg: https://xyzcompany.agiliron.net/agiliron/api-40.php/BatchStatus/bd7cIzgnq2ehYoCSYUfp?key=xyz

Query Auth
key:	string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0.

Header Auth
apiKey:	string Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0.

Sample Response

{
    "BatchStatus": {
        "Id": "10",
        "BatchId": "bd7cIzgnq2ehYoCSYUfp",
        "Response": "{\"SuccessNumber\":2,\"FailureNumber\":0,\"SuccessAccountId\":0,\"Success\":[{\"Leads\":{\"LeadId\":394607,\"LeadName\":\"John Doe\"}},{\"Leads\":{\"LeadId\":394608,\"LeadName\":\"Test Lead\"}}],\"Failure\":[]}",
        "RequestStartTime": "2021-12-13 09:51:27",
        "RequestEndTime": "2021-12-13 09:51:27",
        "Status": "Completed"
    }
}

<BatchStatus>
    <Id>10</Id>
    <BatchId>bd7cIzgnq2ehYoCSYUfp</BatchId>
    <Response>{"SuccessNumber":2,"FailureNumber":0,"SuccessAccountId":0,"Success":[{"Leads":{"LeadId":394607,"LeadName":"John Doe"}},{"Leads":{"LeadId":394608,"LeadName":"Test Lead"}}],"Failure":[]}</Response>
    <RequestStartTime>2021-12-13 09:51:27</RequestStartTime>
    <RequestEndTime>2021-12-13 09:51:27</RequestEndTime>
    <Status>Completed</Status>
</BatchStatus>

{
    "BatchStatus": {
        "Id": "10",
        "BatchId": "bd7cIzgnq2ehYoCSYUfp",
        "Response": "{\"SuccessNumber\":2,\"FailureNumber\":0,\"SuccessAccountId\":0,\"Success\":[{\"Leads\":{\"LeadId\":394607,\"LeadName\":\"John Doe\",\"Record\":1}},{\"Leads\":{\"LeadId\":394608,\"LeadName\":\"Test Lead\",\"Record\":2}}],\"Failure\":[]}",
        "RequestStartTime": "2021-12-13 09:51:27",
        "RequestEndTime": "2021-12-13 09:51:27",
        "Status": "Completed"
    }
}

<BatchStatus>
    <Id>10</Id>
    <BatchId>bd7cIzgnq2ehYoCSYUfp</BatchId>
    <Response>{"SuccessNumber":2,"FailureNumber":0,"SuccessAccountId":0,"Success":[{"Leads":{"LeadId":394607,"LeadName":"John Doe","Record":1}},{"Leads":{"LeadId":394608,"LeadName":"Test Lead","Record":2}}],"Failure":[]}</Response>
    <RequestStartTime>2021-12-13 09:51:27</RequestStartTime>
    <RequestEndTime>2021-12-13 09:51:27</RequestEndTime>
    <Status>Completed</Status>
</BatchStatus>

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="BatchStatus"> 
       <method name="GET">
         <request>
           <param name="key" type="xsd:string" style="query" required="true"/>
           <param name="batch_id" type="xsd:string" style="query" required="true"/>			
         </request> 
         <response status="200"> 
            <representation mediaType="application/xml" element="yn:ResultSet"/> 
         </response> 
         <response status="400"> 
            <representation mediaType="application/xml" element="ya:Error"/> 
         </response> 
       </method> 
     </resource> 
   </resources>
 </application>

Updated 21 days ago