Interface: export/visits

POST /api/v3/api/export/visits

Authentication

Required HTTP Headers

  • X-Plugin-Version
  • X-Plugin-Identifier

General

  • Most fields are optional and thus may not be content of the response

Supported Formats

  • json

Examples

POST /api/export/visits
{
  "created_by": "erika.musterfrau@sic.software",
  "from": "2018-06-13T08:47:33+02:00",
  "to": "2018-07-13T08:47:33+02:00"
}
200
[
  {
    "start_time":"2018-10-14T08:55:39+02:00",
    "end_time": 2018-10-14T09:42:27+02:00,
    "created_by": {
      "login": "erika.musterfrau@sic.software"
    },
    "contact": {
      "first_name": "Max",
      "last_name": "Schulze",
      "email": "Max.Schulze@gmx.de",
      "country": "Deutschland",
      "city": "Berlin",
      "zip_code": "11234",
      "street": "Bahnhofstrasse 5",
      "organization": "Muster AG",
      "position_in_organization": "Vertrieb",
      "phone": "030 234567",
      "mobile_phone": "0171 345678",
      "fax": "030 234568",
      "latitude": 52.5072111,
      "longitude": 13.1449525,
      "crm_id": "d1876d06-8a72-4fc3-b1a5-5c3216992518",
      "vcard_page1_filename": "file_49299asc203.png",
      "vcard_page2_filename": "file_49ad94sc2ll.png",
      "updated_at": "2019-03-12T12:49:06.525+01:00",
      "customer_id": "Kundennummer",
      "title": "Herr",
      "academic_title": "Prof. Dr.",
      "website": "https://www.muster-ag.de",
      "department": "R&D",
      "app_crm_id": "1234av23",
      "language": "de"
    },
    "attendants": [
      <more contacts like above>
    ],
    "graphics": [
        {
            "checksum": "<md5sum>",
            "filename": "<filename>",
            "type": "VisitDrawing"
        }
    ],
    "questionnaire": {
      "sections": [
        {
          "identifier": "section_420",
          "name": "Sektion 2",
          "questions": [
            {
              "answers": [
                {
                  "name": "Yes",
                  "identifier": "y"
                },
                {
                  "name": "Freetext",
                  "value": "My answer"
                },
              ],
              "identifier": "Question42",
              "name": "Interesting Question"
            }
          ]
        },
        {
          "name": "Questions",
          "questions": [
            {
              "answers": [
                {
                  "name": "Fine"
                }
              ],
              "name": "How are you?"
            }
          ]
        }
      ]
    }
  }
]

Errors

Code Description
401 Wrong credentials given
403 Invalid or missing X-Plugin-Version / X-Plugin-Identifier header 






Params






Param name
Description






from 

 optional 		
ISO 8601 Timestamp


Validations:


    

  • Must be a String
    • 







to 

 optional 		
ISO 8601 Timestamp


Validations:


    

  • Must be a String
    • 











For getting access to the interfaces please contact the VERMO support team.