Get Outbound Faxes List
Gets the list of outgoing faxes owned by authenticated user.
Resource URL
GET fw/Apps/StoneFax/WebAPI/Faxes/Outbound/Mine
Resource Information
Response Content-Type: application/json
Requires authentication: Yes
URL Parameters
Name | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
page | int | optional | The number of the page which we want to retrieve. It must be greater or equal than 1. | 1 | 3 |
pageSize | int | optional | The size of the page where the results will be stored in. It must be greater or equal than 0. If 0, page will be ignored and will be returned all inbound faxes of the user. | 0 | 10 |
date | string | optional | The time interval of the faxes to be retrieved. It must be specified via RHS colon syntax using one of the following operators: "between", "after", "before". | null | between:2018-01-01T00:00:00;2018-12-31T23:59:59 |
Response
200 OK
The list of outgoing faxes is returned.
Response body
Response body is a JSON object representing outbound faxes list:
Name | Type | Description |
|---|---|---|
faxlist | Fax | The outbound faxes list |
Fax
Name | Type | Description |
|---|---|---|
faxId | string | The fax id |
username | string | The username of the user the fax belongs to |
recipient | Recipient | The fax recipient |
subject | string | The subject of the fax |
status | Status | The status of the fax. Possible values are:
|
date | string | The ISO date when the fax has been submitted |
Recipient
Name | Type | Description |
|---|---|---|
name | string | The complete name (first and last name) of the recipient |
faxNumber | string | The recipient's fax number |
Error response
400 Forbidden
The filters are not valid
401 Unauthorized
No authentication provided
Wrong credentials
403 Forbidden
Insufficient privilege level
404 NotFound
No such outbound fax having the given id
Examples
GET fw/Apps/StoneFax/WebAPI/Faxes/Outbound/Mine
{ "faxList": [ { "__type": "LessInfoOutboundFax:StoneFax.Faxes", "date": "2020-12-02T16:20:44.0000000", "faxId": "IAS-N1_eb031e4f-58fd-45af-ae0d-77f95d5ce6d1_0", "recipient": { "faxNumber": "200", "name": "200" }, "status": "Completed", "username": "user1", "subject": "abc" } ] }