GET api/Visits/GetVisitSummary?pVisitCode={pVisitCode}&withPrev={withPrev}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pVisitCode

integer

Required
withPrev

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

RetSummaryVisit
NameDescriptionTypeAdditional information
summary

Collection of Object

None.
summaryMongo

VisitSummaryMongo

None.
prevSums

Collection of PreviousVisitSummary

None.

Response Formats

application/json, text/json

Sample: 
{
  "summary": [
    {},
    {}
  ],
  "summaryMongo": {
    "visitCode": 1,
    "custNum": 2,
    "printered": true,
    "summaryTitle": "sample string 4",
    "templateName": "sample string 5",
    "creationDate": "2024-11-21T11:31:37.0039663+02:00",
    "summary": [
      {
        "title": "sample string 1",
        "value": "sample string 2",
        "type": "sample string 3",
        "name": "sample string 4",
        "rows": 5,
        "cols": 6
      },
      {
        "title": "sample string 1",
        "value": "sample string 2",
        "type": "sample string 3",
        "name": "sample string 4",
        "rows": 5,
        "cols": 6
      }
    ],
    "_id": "000000000000000000000000"
  },
  "prevSums": [
    {
      "EmpName": "sample string 1",
      "visitCode": 2,
      "summaryTitle": "sample string 3",
      "creationDate": "2024-11-21T11:31:37.0039663+02:00",
      "summary": [
        {
          "title": "sample string 1",
          "value": "sample string 2",
          "type": "sample string 3",
          "name": "sample string 4",
          "rows": 5,
          "cols": 6
        },
        {
          "title": "sample string 1",
          "value": "sample string 2",
          "type": "sample string 3",
          "name": "sample string 4",
          "rows": 5,
          "cols": 6
        }
      ],
      "operName": "sample string 4",
      "templateName": "sample string 5",
      "_id": "000000000000000000000000"
    },
    {
      "EmpName": "sample string 1",
      "visitCode": 2,
      "summaryTitle": "sample string 3",
      "creationDate": "2024-11-21T11:31:37.0039663+02:00",
      "summary": [
        {
          "title": "sample string 1",
          "value": "sample string 2",
          "type": "sample string 3",
          "name": "sample string 4",
          "rows": 5,
          "cols": 6
        },
        {
          "title": "sample string 1",
          "value": "sample string 2",
          "type": "sample string 3",
          "name": "sample string 4",
          "rows": 5,
          "cols": 6
        }
      ],
      "operName": "sample string 4",
      "templateName": "sample string 5",
      "_id": "000000000000000000000000"
    }
  ]
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'System.Linq.EnumerableQuery`1[[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]' with data contract name 'ArrayOfanyType:http://schemas.microsoft.com/2003/10/Serialization/Arrays' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'System.Linq.EnumerableQuery`1[[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]' with data contract name 'ArrayOfanyType:http://schemas.microsoft.com/2003/10/Serialization/Arrays' is not expected. Consider using a DataContractResolver if you are using DataContractSerializer or add any types not known statically to the list of known types - for example, by using the KnownTypeAttribute attribute or by adding them to the list of known types passed to the serializer.

application/bson

Sample: 
Binary JSON content. See http://bsonspec.org for details.