jagomart
digital resources
picture1_Word Document Invoice Template 29355 | Orders Api User Guide


 202x       Filetype DOCX       File size 0.14 MB       Source: www.cedar-rose.com


File: Word Document Invoice Template 29355 | Orders Api User Guide
orders api user documentation abstract user guide describing how to use cedar rose orders api orders api table of contents document change log error bookmark not defined introduction 3 restful ...

icon picture DOCX Filetype Word DOCX | Posted on 07 Aug 2022 | 3 years ago
Partial capture of text on file.
                                  ORDERS API
                                   User Documentation
                                                 Abstract
                               User guide describing how to use Cedar Rose Orders API
                                    ORDERS API
        Table of Contents
        Document Change Log..........................................................Error! Bookmark not defined.
        Introduction..............................................................................................................................3
          Restful Web Services............................................................................................................3
          General RESTful Response Guide.........................................................................................3
        Advantages..............................................................................................................................3
          Flexible "Search Parameters"...............................................................................................3
          Search Values.......................................................................................................................3
          Response Data......................................................................................................................3
        Authentication..........................................................................................................................4
        Responses & errors..................................................................................................................4
        API Endpoints...........................................................................................................................1
        Company search......................................................................................................................2
          POST /company/search.........................................................................................................2
        Company quick search.............................................................................................................3
          POST /company/CompanyQuickSearch................................................................................3
          POST /company/FlexibleSearchCompany.............................................................................4
        Company available data..........................................................................................................5
          POST /company/AvailableSectionsByUID..............................................................................5
        Person Directorship/ Shareholding Search...............................................................................6
          POST /Person/PersonSearch..................................................................................................6
        Place Order (or download).......................................................................................................7
          POST /Order/RequestOrder...................................................................................................7
        Receive JSON Report................................................................................................................8
          GET /order/ReceiveJsonReport..............................................................................................8
        Receive PDF Report..................................................................................................................8
          POST /order/ReceiveJsonReport............................................................................................8
        Supporting Functions...............................................................................................................9
          Product Categories - GET /common/Categories....................................................................9
          Products - GET /common/Products........................................................................................9
          Speeds - GET /common/Speeds............................................................................................9
          Price - POST /Order/GetPricebySpeedId..............................................................................10
          Due Date - POST /Order/OrderDueDate..............................................................................10
          Countries - GET /common/countries...................................................................................11
          Organizations - GET /common/organizations......................................................................11
          Registers - GET /common/Registers....................................................................................11
       Page 1 of 19                                    Cedar Rose International Services Ltd
                                                          PO Box 50751, Limassol 3609, Cyprus
                                                                   Tel +357 25 346630
                                                                    Fax +357 25 346620
                                                                  www.cedar-rose.com
                                ORDERS API
         Legal Forms - GET /common/LegalForms............................................................................12
         Client Balances - POST /client/GetClientBalances..............................................................12
         Client Orders - POST /client/GetClientOrders......................................................................12
         Check Order Status - POST /order/CheckOrderStatus........................................................13
         Send Order PDF Report - POST /order/sendOrderReport....................................................13
       FAQ.........................................................................................................................................14
         Question 1: How to optimise the response time?...............................................................14
         Question 2: What are the Language capabilities?..............................................................14
      Page 2 of 19                              Cedar Rose International Services Ltd
                                                   PO Box 50751, Limassol 3609, Cyprus
                                                           Tel +357 25 346630
                                                           Fax +357 25 346620
                                                          www.cedar-rose.com
                                          ORDERS API
          Introduction
          Restful Web Services
          Cedar Rose implements RESTful web services over HTTPS, with a JSON response, and thus, 
          we can integrate with any web-based solution.
          General RESTful Response Guide
              HTTP Code 200: Success
              HTTP Code 400: Business Error
              HTTP Code 500: Technical Error
          JSON property names are case sensitive. Therefore, if the web service expects "Name", then
          "name" wouldn't be valid. See example:
          {Name: "cedar rose"} // valid
          {name: "cedar rose"} // not valid
          JSON property string values are NOT case sensitive. See example:
          {Name:"cedar rose"} is same as {Name: "Cedar Rose"}
          Advantages
          Flexible "Search Parameters"
              Company Name: English, Arabic
              Address Details: Country, Region, District, Town, Area, Street, Building, P.O. Box, 
               Postal Code
              Register Details: Country, Organization, Register, Number
              Name of a Shareholder or a Director (mostly CEO)
          Search Values
              When you are doubting the spelling of certain parameters, you can search for 
               "Similar values".
              For each parameter you include in the request, you can specify whether the search 
               value is exact or partial.
          Response Data
              Able to include almost any detail in the response.
              The response details can be the same as search parameters or totally different.
        Page 3 of 19                                            Cedar Rose International Services Ltd
                                                                   PO Box 50751, Limassol 3609, Cyprus
                                                                             Tel +357 25 346630
                                                                              Fax +357 25 346620
                                                                            www.cedar-rose.com
The words contained in this file might help you see if this file matches what you are looking for:

...Orders api user documentation abstract guide describing how to use cedar rose table of contents document change log error bookmark not defined introduction restful web services general response advantages flexible search parameters values data authentication responses errors endpoints company post quick companyquicksearch flexiblesearchcompany available availablesectionsbyuid person directorship shareholding personsearch place order or download requestorder receive json report get receivejsonreport pdf supporting functions product categories common products speeds price getpricebyspeedid due date orderduedate countries organizations registers page international ltd po box limassol cyprus tel fax www com legal forms legalforms client balances getclientbalances getclientorders check status checkorderstatus send sendorderreport faq question optimise the time what are language capabilities implements over https with a and thus we can integrate any based solution http code success business ...

no reviews yet
Please Login to review.