Get all your job summaries

Home » DOCOON APIs » REST API » Basic functionnalities » Get all your job summaries

After sending messages, you might want to see simply in your software the transmission result of each recipient.

We created a workflow “Get transmission reports (Real time way)” that allows you to get those transmission results in 2 steps, get all your job summaries, and get recipients transmission result for one job. This basic functionnality illustrate the first step.

After checking the quick information, you can either get recipients transmission result of the job or get transmision report file associated to the job.

Avoid to call this webservice less than every 5 minutes.

Request Informations

Name:/JobSummaries
Type: GET

Headers:

Name	Value
Authorization	Value : Authorization token check : Connect to REST API
Content-Type	Value : application/json

Parameters list:

Parameter	Type	Description
customerNumber	int	(Optional) Customer number of the jobs.
pageIndex	int	(Optional) Page of the result you want to get (default = 1).
pageSize	int	(Optional) Number of jobs per page (default = 10).
filterFeature	int	(Optional) Filter returning a list of jobs using a specific feature. Values : 1 = all (default), 2 = TrackingEmail, 3 = FormsManagement, 4 = SmsAnswer, 5 = ShortUrl
filterJob	int	(Optional) Filter returning a specific job if you specify a jobId. Value : The job ID
*filterTid*	String	(Optional) filter returning a list of jobs with the specified TrackingID. Value : The trackingID
filterOnlyNotSent	boolean	(Optional) Filter returning a list of jobs that are sent or not sent. Can be use to check the unsent recipient. Values : True => list of jobs with unsent recipients. False => list of jobs with only sent recipients.
filterAllSubAccounts	boolean	(Optional) Filter returning a list of jobs of the logged in subaccount, or from all subaccount. Values: True => All sub account. False => connected account only.
filterMedia	int	(Optional) Filter returning a list of jobs by media. Value : 0 = Fax, 1 = Sms, 2 = Voice, 3 = Mail, 4 = Push notification, 5 = Email
filterStartDate	DateTime	(Optional) Filter returning a list of jobs created after the specified date. Format : “2017-07-08T12:54:40.460Z”
filterEndDate	DateTime	(Optional) Filter returning a list of jobs created before the specified date. Format : “2017-07-08T12:54:40.460Z”
sortField	int	(Optional) Sort the data by the field returned. Values : 0 = Job, 1 = Date, 2 = Status, 3 = Tracking Id, 4 = Total, 5 = Sent, 6 = Failed, 7 = Remaining, 8 = Media, 9 = Creation date, 10 = Start date
sortDirection	int	(Optional) Type of sorting. Values : 1 = Ascending, 2 = Descending

Get all your job summaries

GET /api/V1/JobSummaries
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NjAzMDAuYXxxxxxxxx

Filter by PageSize and Index

GET /api/V1/JobSummaries?pageIndex=2&amp;pageSize=5
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NjAzMDAuYxxxxx

Filter by TrackingID and NotSent

GET /api/V1/JobSummaries?filterTid=API&amp;filterOnlyNotSent=true
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NjAzMDAuYxxxxx

Filter by Media and Sort

GET /api/V1/JobSummaries?filterMedia=1&amp;sortField=2&amp;sortDirection=2
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NjAzMDAuYxxxxx

Filter by Date

GET /api/V1/JobSummaries?filterStartDate=2017-07-01T12:54:40.460Z&amp;filterEndDate=2017-07-08T12:54:40.460Z
Host: api.odyssey-services.fr
Content-Type: application/json
Authorization: Basic NjAzMDAuYxxxxx

Successful Response

Status : 200

Parameter	Type	Description
*PageIndex*	Int	Page number currently returned.
PageSize	Int	Number of item per page
TotalCount	Int	Total Number of jobs that can be returned.
TotalPageCount	Int	Total of page that can be returned
Ressources	JobSummary Object	List of JobSummary Object, returning the job summary information, See below for structure the details.
HasPreviousPage	boolean	True: This is the first page you can display. False: you can display the previous page.
HasNextPage	Boolean	True: you can display the next page. False: This is the last page you can display.

Response is a list of JobSummary Object.

JobSummary Object

Parameter	Type	Description
Login	String	Login of the user that sent the job.
MostRecentDate	DateTime	Date of the Last action did by the server. values: “2017-07-11T06:55:42”.
Status	Int	Internal status for job advancement (check the JobStatus in the FAQ).
TID	String	Tracking ID of the job.
Total	Int	Total of recipient.
Sent	Int	Total of sent recipients.
Failed	Int	Total of failed recipients.
Remaining	Int	Total of remaining recipients.
FirstDoc	String	Name and extension of the job Document file (or the first if there are several documents).
FirstList	String	Name and extension of the job List file (or the first in case of several List).
Page	Int	Number of pages of the document (Specific for Fax media).
PageSent	Int	Number of pages Sent.
Media	Int	Job media type. Values: 0 = Fax, 1 = Sms, 2 = Voice, 3 = Mail, 4 = Push notification, 5 = Email
CreationDate	DateTime	Date of the job creation values: “2017-07-11T06:55:42”.
StartDate	DateTime	Date of the start of the job sending values: “2017-07-11T06:55:42”.
JobNumber	Int	Job reference number (Job Id).
JobType	String	JobType used for the job.
CustomerNumber	Int	Customer number used for the job.

Successful Response


{
    "PageIndex": 1,
    "PageSize": 10,
    "TotalCount": 114,
    "TotalPageCount": 12,
    "Resources": [
        {
            "Login": "50XXX.user2",
            "MostRecentDate": "2017-07-11T06:55:42",
            "Status": 85,
            "TID": "SMS Sending",
            "Total": 1,
            "Sent": 1,
            "Failed": 0,
            "Remaining": 0,
            "FirstDoc": "",
            "FirstList": "adhoc.tab",
            "Page": 0,
            "PageSent": 0,
            "Media": 5,
            "CreationDate": "2017-07-11T06:53:59",
            "StartDate": "2017-07-11T06:53:59",
            "JobNumber": 48034262,
            "JobType": "SMS",
            "CustomerNumber": 50XXX
        },
        {
            "Login": "50xxx.user1",
            "MostRecentDate": "2017-07-11T06:54:22",
            "Status": 85,
            "TID": "Email Sending",
            "Total": 1,
            "Sent": 1,
            "Failed": 0,
            "Remaining": 0,
            "FirstDoc": "",
            "FirstList": "adhoc.tab",
            "Page": 0,
            "PageSent": 0,
            "Media": 5,
            "CreationDate": "2017-07-11T06:52:23",
            "StartDate": "2017-07-11T06:52:26",
            "JobNumber": 48034261,
            "JobType": "Email_ods3",
            "CustomerNumber": 50XXX
        }
    ],
    "HasPreviousPage": false,
    "HasNextPage": true
}