POST api/Mobile/KitScan

Used to perform the Kit Scan

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserGUID	Unique identifier of user of mobile app	string	None.
KitNumbers	List of kit numbers	Collection of string	None.
AccountNumber	The account number of the customer that the scan applies	string	None.
Signature	The text signature	string	None.
SignatureImage	The signature image (base64)	string	None.
Comment	Special comments from the courier related to this scan	string	None.
LocationData	Geolocation (lat/long) if available	string	None.
Photos	List of photo images (base64)	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "KitNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "AccountNumber": "sample string 2",
  "Signature": "sample string 3",
  "SignatureImage": "sample string 4",
  "Comment": "sample string 5",
  "LocationData": "sample string 6",
  "Photos": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<KitScanParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <AccountNumber>sample string 2</AccountNumber>
  <Comment>sample string 5</Comment>
  <KitNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </KitNumbers>
  <LocationData>sample string 6</LocationData>
  <Photos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Photos>
  <Signature>sample string 3</Signature>
  <SignatureImage>sample string 4</SignatureImage>
  <UserGUID>sample string 1</UserGUID>
</KitScanParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
IsSuccessful	Set to true if method was successful	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>