Get Inbound Fax Details

Gets the details of an inbound fax identified by its id.

Resource URL

GET fw/Apps/StoneFax/WebAPI/Faxes/Inbound/{id}

Resource Information

Response Content-Type: application/json
Requires authentication: Yes

URL Parameters

Name	Type	Required	Description	Default	Example
id	string	required	Fax ID	null	IAS-N1_401d6c8c07d6b7a_0

Response

200 OK

Fax info have been returned.

Response body

Response body is a JSON object representing outbound fax data:

Name	Type	Description
fax	Fax	The inbound fax data

Fax

Name	Type	Description
faxId	string	The fax id
username	string	The username of the user the fax belongs to
subject	string	The fax subject
recipient	Recipient[]	The fax recipients
sender	Sender	The fax sender
status	Status	The status of the fax. Possible values are: Completed Failed Queued InProgress Canceled
numberOfPages	int	The number of fax pages
detailedStatus	string	A more detailed version of the fax status
serverName	string	The name of the server that sent the fax
submitTime	DateTime	The time when the fax has been submitted to the system (ISO 8601)
startTime	DateTime	The time when the fax sending was started (ISO 8601)
endTime	DateTime	The time when the fax sending was concluded (ISO 8601)
size	int	Size in bytes of the fax

Sender

Name	Type	Description
name	string	The complete name (first and last name) of the sender
faxNumber	string	The sender's fax number

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

401 Unauthorized

No authentication provided
Wrong credentials

403 Forbidden

Insufficient privilege level

404 Not Found

No such inbound fax having the given id

Examples

GET fw/Apps/StoneFax/WebAPI/Faxes/Inbound/IAS-N1_401d6c8c07d6b7a_0


{
    "fax": {
        "__type": "InboundFax:StoneFax.Faxes",
        "detailedStatus": null,
        "endTime": "2020-12-02T16:34:45.0000000",
        "faxId": "WIN-SM96NKMUNDO_401d6c8c07d6b7a_0",
        "numberOfPages": 2,
        "recipient": {
            "faxNumber": "200",
            "name": "user2"
        },
        "serverName": "WIN-SM96NKMUNDO",
        "size": 63616,
        "startTime": "2020-12-02T16:33:31.0000000",
        "status": "Completed",
        "username": "user2",
        "sender": {
            "faxNumber": "100",
            "name": null
        }
    }
}