POST api/Visitor/SaveVisitor

Api to save Visitor

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ApiToken	string	None.
VisitorID	integer	None.
VisitorTypeID	integer	None.
VisitorCabDriverTypeID	integer	None.
VisitorDeliveryCompanyID	integer	None.
Companion	integer	None.
VisitorCode	string	None.
VisitorName	string	None.
VisitorPhoneCode	string	None.
VisitorPhoneNumber	string	None.
VisitorVehicleCabNumber	string	None.
IsNeedVehicleParking	boolean	None.
UserID	integer	None.
VisitorDestination	Collection of VisitorDestinationSaveRequestModel	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "apiToken": "sample string 1",
  "visitorID": 1,
  "visitorTypeID": 1,
  "visitorCabDriverTypeID": 1,
  "visitorDeliveryCompanyID": 1,
  "companion": 1,
  "visitorCode": "sample string 2",
  "visitorName": "sample string 3",
  "visitorPhoneCode": "sample string 4",
  "visitorPhoneNumber": "sample string 5",
  "visitorVehicleCabNumber": "sample string 6",
  "isNeedVehicleParking": true,
  "userID": 8,
  "visitorDestination": [
    {
      "visitorDestinationLocationID": 1,
      "visitorDestinationCustomerID": 1
    },
    {
      "visitorDestinationLocationID": 1,
      "visitorDestinationCustomerID": 1
    }
  ]
}

application/xml, text/xml

Sample:

<VisitorInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel">
  <ApiToken>sample string 1</ApiToken>
  <Companion>1</Companion>
  <IsNeedVehicleParking>true</IsNeedVehicleParking>
  <UserID>8</UserID>
  <VisitorCabDriverTypeID>1</VisitorCabDriverTypeID>
  <VisitorCode>sample string 2</VisitorCode>
  <VisitorDeliveryCompanyID>1</VisitorDeliveryCompanyID>
  <VisitorDestination>
    <VisitorDestinationSaveRequestModel>
      <VisitorDestinationCustomerID>1</VisitorDestinationCustomerID>
      <VisitorDestinationLocationID>1</VisitorDestinationLocationID>
    </VisitorDestinationSaveRequestModel>
    <VisitorDestinationSaveRequestModel>
      <VisitorDestinationCustomerID>1</VisitorDestinationCustomerID>
      <VisitorDestinationLocationID>1</VisitorDestinationLocationID>
    </VisitorDestinationSaveRequestModel>
  </VisitorDestination>
  <VisitorID>1</VisitorID>
  <VisitorName>sample string 3</VisitorName>
  <VisitorPhoneCode>sample string 4</VisitorPhoneCode>
  <VisitorPhoneNumber>sample string 5</VisitorPhoneNumber>
  <VisitorTypeID>1</VisitorTypeID>
  <VisitorVehicleCabNumber>sample string 6</VisitorVehicleCabNumber>
</VisitorInsertUpdateRequestModel>

multipart/form-data

Sample:

<VisitorInsertUpdateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.RequestModel"><ApiToken>sample string 1</ApiToken><Companion>1</Companion><IsNeedVehicleParking>true</IsNeedVehicleParking><UserID>8</UserID><VisitorCabDriverTypeID>1</VisitorCabDriverTypeID><VisitorCode>sample string 2</VisitorCode><VisitorDeliveryCompanyID>1</VisitorDeliveryCompanyID><VisitorDestination><VisitorDestinationSaveRequestModel><VisitorDestinationCustomerID>1</VisitorDestinationCustomerID><VisitorDestinationLocationID>1</VisitorDestinationLocationID></VisitorDestinationSaveRequestModel><VisitorDestinationSaveRequestModel><VisitorDestinationCustomerID>1</VisitorDestinationCustomerID><VisitorDestinationLocationID>1</VisitorDestinationLocationID></VisitorDestinationSaveRequestModel></VisitorDestination><VisitorID>1</VisitorID><VisitorName>sample string 3</VisitorName><VisitorPhoneCode>sample string 4</VisitorPhoneCode><VisitorPhoneNumber>sample string 5</VisitorPhoneNumber><VisitorTypeID>1</VisitorTypeID><VisitorVehicleCabNumber>sample string 6</VisitorVehicleCabNumber></VisitorInsertUpdateRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonVisitorResponseDataModel

Name	Type	Additional information
ReturnVerificationCode	string	None.
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnVerificationCode": "sample string 1",
  "returnID": 2,
  "message": "sample string 3",
  "successful": true,
  "code": 5,
  "totalRecord": 6
}

application/xml, text/xml

Sample:

<CommonVisitorResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel">
  <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</Code>
  <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 3</Message>
  <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">2</ReturnID>
  <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
  <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">6</TotalRecord>
  <ReturnVerificationCode>sample string 1</ReturnVerificationCode>
</CommonVisitorResponseDataModel>

multipart/form-data

Sample:

<CommonVisitorResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 3</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">2</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">6</TotalRecord><ReturnVerificationCode>sample string 1</ReturnVerificationCode></CommonVisitorResponseDataModel>