VendorFaxConfigurations

Get the list of Vendor Fax Configurations

Path

GET /odata/VendorFaxConfigurations

Description

Returns the list with active/inactive Fax Configurations of active Vendors related to active Facilities within a logged organization. You can filter the results by the strict match using the $filter parameter–entity eq ‘string’. Or filter the results by the partial match using $filter=contains parameter–contains(entity, ‘string’).

Request parameters

Parameter	Explanation
includeInactiveVendors boolean default: false in query	Include inactive Vendors.
includeInactiveFacilities boolean default: false in query	Include inactive Facilities.
api-version: string default: 1.0 in header	The requested API version.
$filter: string in query	Restricts the set of items returned. The maximum number of expressions is 100.
$orderby: string in query	Specifies the order in which items are returned. The maximum number of expressions is 5.
$search: string in query	Picks the value in all possible fields.
$top: string in query	Returns only the first n results.
$skip: string in query	Skips the first n results.
Authorization: string default: Bearer access_token in header	Specify the type of the token (bearer) and then insert the `access_token`, which was obtained during authentication.

Responses

Response	Explanation
200 OK	OK
400 Bad Request	Incorrect input data or organization ID does not match with the organization ID user is logged in.
400 Bad Request	The limit for the `$top` query has been exceeded. The value from the incoming request is 'N' (N is your value from the request). You can find the data on the current limit here.
401 Unauthorized	Incorrect specified `access_token` or `access_token` got expired.
403 Forbidden	User doesn’t have appropriate privileges.
500 Internal Server Error	Server encountered an unexpected condition that prevented it from fulfilling the request.

Properties

Property	Explanation
vendorFaxId: string (uuid)	Unique Identifier of the Vendor Fax
vendorId: string (uuid)	Unique Identifier of the Vendor
vendorNo: string	Code of the Supplier who sells products
vendorName: string	Name of the Vendor
facilityId: string (uuid)	Unique Identifier of the Facility
facilityNo: string	Identification Number of the Facility
facilityName: string	Name of the Facility
faxDescription: string	Description of the Vendor Fax
csid: string	Called Subscriber Identification
faxNumber: string	Number of the Fax
useCoverPage: boolean	Use Cover Page or not?
coverPageBody: string	Body Cover Page
activeStatus: boolean	Is the Status of the Vendor Fax active or not?
dateAdded: string (date-time)	Date when the Vendor Fax was added
addedBy: string (uuid)	Unique Identifier of the user who added the Vendor Fax
addedByName: string	Name of the user who added the Vendor Fax
lastUpdated: string (date-time)	Last Date when the Vendor Fax was updated
lastUpdatedBy: string (uuid)	Unique Identifier of the last user who updated the Vendor Fax
lastUpdatedByName: string	Name of the last user who updated the Vendor Fax

Response Content-types: APPLICATION/JSON, APPLICATION/XML
Response example (200 OK)

{
  "items": [
    {
      "vendorFaxId": "00000000-0000-0000-0000-000000000000",
      "vendorId": "00000000-0000-0000-0000-000000000000",
      "vendorNo": "string",
      "vendorName": "string",
      "facilityId": "00000000-0000-0000-0000-000000000000",
      "facilityNo": "string",
      "facilityName": "string",
      "faxDescription": "string",
      "csid": "string",
      "faxNumber": "string",
      "useCoverPage": "boolean",
      "coverPageBody": "string",
      "activeStatus": "boolean",
      "dateAdded": "string (date-time)",
      "addedBy": "00000000-0000-0000-0000-000000000000",
      "addedByName": "string",
      "lastUpdated": "string (date-time)",
      "lastUpdatedBy": "00000000-0000-0000-0000-000000000000",
      "lastUpdatedByName": "string"
      }
  ],
  "nextPageLink": "string",
  "count": "integer (int64)"
}

Get the specified Vendor Fax Configuration