Manuals / Multitech / Computer Equipment / Server

Multitech FF240 manual Retrieving Contacts

Models: FF240

1 126

Download 126 pages 44.68 Kb

Page 101

Appendix B: Customization

Retrieving Contacts

HTTP Request line:

GET /ffws/v1/contacts/USERNAME HTTP/1.1

GET /ffws/v1/contacts/USERNAME/ID HTTP/1.1

GET /ffws/v1/contacts/global_contact_list HTTP/1.1

GET /ffws/v1/contacts/global_contact_list/ID HTTP/1.1

Query Parameters:

limit=LIMIT

Limit the number of results to LIMIT.

offset=OFFSET

Skip OFFSET entries from the start. Only valid when limit is specified.

name=SUBSTR

fax_number=SUBSTR phone_number=SUBSTR organization=SUBSTR

Search for contacts by field name. If you specify more than one they are logically ANDed.

HTTP Response Status Codes:

200OK Success

403 Forbidden

Authenticated user does not have permission to view data associated with username.

404 Not Found

No user found with that username.

Example:

GET /ffws/v1/contacts/admin HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4=

-----------------------------------

HTTP/1.1 200 OK content-type: application/xml

<?xml version="1.0" encoding="UTF-8"?> <response>

<message>Success</message>

<contact> <contact_url>https://192.168.2.1/ffws/v1/contacts/admin/3</contact_url> <name>Contact Name</name> <fax_number>111-222-4444</fax_number> <phone_number>218-555-3336</phone_number>

<organization>Contacts Org</organization> </contact>

</response>

Multi-Tech Systems, Inc.

FF240-IP Admin User Guide

101

Image 101

Multitech FF240 manual Retrieving Contacts

Contents

FaxFinder IP S000493A, Version a WarrantyCopyright 2011, by Multi-Tech Systems, Inc RevisionsContents Multi-Tech Systems, Inc FF240-IP Admin User Guide Product Description Product Description SpecificationsSafety Warnings Technical Specifications FF240-IP Operating Modes Getting StartedIntroduction Send Fax screen Client software Rack Mounting Inch Rack Enclosure Mounting ProcedureMechanical Mounting Front Panel LEDs External DescriptionsBack Panel Connections Verify Powering Installation OverviewConnect FF240-IP to AC Outlet Connect FF240-IP to Ethernet NetworkSetting Admin PC to Startup IP Address Part B Configuring the FF240-IP ServerLogging Setting FF240-IP IP AddressesResetting Admin PC to Its Regular IP Address Firefox Add Exception Process Log In After ResetSending a loop-back test fax Save your Configuration to a File on the Local PCSending Test Faxes Adding Client-Users Sending a test fax on your SIP networkWeb Management Interface Login ScreenForgot Password? Home Screen System Status Status & Logs SectionSystem Status Printer Status sectionChannel Status Fax StatusStart Time Inbound Fax StatusExtension RecipientOutbound Fax Status Mail Queue Mail Log Inbound Fax Log Outbound Fax Log Call Log ResolutionDirection Fax NumberNetwork System Configuration SectionNetwork Configuration Send a Test Email Smtp ConfigurationSet Current Time Time ConfigurationTime Printers PrinterAdvanced Setup Advanced SetupCancel button Add PrinterNetwork Shares SharesShared Resources Confirm Password PasswordCancel button Add Network ShareGenerate Server Certificate CertificatesServer Certificate Email AddressGenerate button Save/Restore Configuration Save/RestoreRestore Config Restore buttonLicense Upgrade Software UpdateSoftware Update Debug RebootSIP / T.38 Configuration Fax Configuration SectionTransport Protocol Authorization RequiredSIP Proxy/Gateway SIP DomainJitter Buffer Delay Error CorrectionFax ID Fax MethodInbound Routing General SetupEmail Size Limit Fax Output Format Email Fax DetailsGlobal Routing Default RoutingFax Destinations Add Destination GlobalRecipients Values FieldsExport Recipients to CSV Delete AllOutbound Archive OutboundOutbound Options Outbound Approval Approvers Outbound Approval SetupApproved Fax Numbers Approved UsersOpt-Out Cover PagesCover Cover PagesAction Delete Add CoverStore & Forward Fax T.37 Parameters Store & Forward Fax T.37Add Store & Forward Fax T.37 Additional HostsFax Log Purge Fax LogFaxFinder Users Users SectionAdd / Import / Export / Delete All Full NameEdit Groups for username Edit Contacts for usernameExisting Users ImportUsers CSV Import Format Personal Contacts SectionExport Delete AllGlobal Contacts GlobalGlobal Groups Personal GroupsPersonal Groups Global GroupsSend a Fax Screen Recipient Information Send FaxSender Information Attachments Options Cover Page InformationLogout Installation Client Software InstallationPage Page Page Client Install Shield Mass Uninstall Push Installation MethodPush Installs of the Client Software Associating Client Software and User with the FF240-IP Unit Setting the Usage Rights for the PrinterFor Windows Server 2003, Windows XP and earlier For Windows Vista, Windows 7 and laterAdd FF240-IP Manually Use Auto Discover to Locate FF240-IP Client Installation Disassociating the Client from a Specific FF240-IP Unit Introduction Overview FaxFinder-IP OperationSchedule Fax Screen New Fax Sending FaxesDevice pane Reconnect buttonFax Scheduling Options Schedule Options paneDocuments pane Recipients paneOrganization column Send the Fax Cover Page paneSend Fax by Printing Send Fax with Client SoftwareSend Fax from Web Interface Send Fax from Email T.37File Menu Command Descriptions Using the Client SoftwareFile menu Commands Send Fax by Web APIAdd FF240-IP Edit Menu Command DescriptionsLogging tab Date/Time tabAdvanced tab Tools Menu Command Descriptions Open Devices Tab Main WindowFax Status tab User Info tabSchedule Options tab Set as DefaultReconnect DeleteFax Print Capture Tab Main WindowView Clear AllToolbar Icons Using the Multi-Tech Tiff ViewerImporting Fax Images into Other Application Programs What if I cant see the web page for my FF240-IP? Appendix a TroubleshootingPage No email message after mail server setup cont’d Smtp Error Code ListAuthorization Web Services APIAppendix B Customization IntroductionExample Retrieving Fax Entries Appendix B Customization Http Response Status Codes Rescheduling a Fax Entry Aborting a Fax EntryRetrieving User Information Retrieving Contacts Adding New Contacts Modifying Contacts Deleting Contacts Retrieving Contact Groups Retrieving Cover Pages Retrieving information about the FF240-IP Verify UserSchedule Fax Element General Status Codes109 110 111 Fax Entry Element 113 This element represents a user registered on the FF240-IP User ElementThis element represents a user contact Contact ElementOptions Advanced UsageIntroduction Relaying Multiple Options ExampleSome of the Software Known to Work Appendix C Creating Cover PagesText Field Names and Descriptions TipsFax Branding Statement Appendix E Regulatory ComplianceCFR Part 15 Regulation Industry Canada Canadian Limitations NoticeWaste Electrical and Electronic Equipment Appendix F Environmental InformationWeee Statement Restriction of the Use of Hazardous Substances RoHS Reach StatementRohs HT/TS Substance Concentration 依照中国标准的有毒有害物质信息Important Read Before Operating Appendix G End User License Agreement125 Index Fax Configuration