POST api/FrontierWeb/Booking/ManageStops

Request Information

URI Parameters

None.

Body Parameters

ManageStopsRequest
NameDescriptionTypeAdditional information
ObjectKeyStringWithVersion

string

None.

IdNo

integer

None.

GeoLocationIdNo

integer

None.

Action

string

None.

BookingEquipmentWithDetails

BookingEquipmentWithDetails

None.

UserName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ObjectKeyStringWithVersion": "sample string 1",
  "IdNo": 2,
  "GeoLocationIdNo": 3,
  "Action": "sample string 4",
  "BookingEquipmentWithDetails": {
    "BookingEquipmentDetails": [
      {
        "GeoLocationDescription": "sample string 1",
        "IdNo": 2,
        "BookingEquipmentIdNo": 3,
        "Sequence": 4,
        "GeoLocationIdNo": 5,
        "EquipmentIdNo": 1,
        "ObjectKeyStringWithVersion": "sample string 6",
        "VersionNo": 7,
        "IsActive": true,
        "LastModifiedBy": "sample string 9",
        "ObjectKeyString": "sample string 10",
        "PrimaryKey": [
          2
        ],
        "IsPrimaryKeyInitialized": true
      },
      {
        "GeoLocationDescription": "sample string 1",
        "IdNo": 2,
        "BookingEquipmentIdNo": 3,
        "Sequence": 4,
        "GeoLocationIdNo": 5,
        "EquipmentIdNo": 1,
        "ObjectKeyStringWithVersion": "sample string 6",
        "VersionNo": 7,
        "IsActive": true,
        "LastModifiedBy": "sample string 9",
        "ObjectKeyString": "sample string 10",
        "PrimaryKey": [
          2
        ],
        "IsPrimaryKeyInitialized": true
      }
    ],
    "EquipmentSubtypeDescription": "sample string 1",
    "CurrentGeoLocationIdNo": 1,
    "CurrentGeoLocationDescription": "sample string 2",
    "Stops": "sample string 3",
    "StopCount": 4,
    "AccessorialCharges": 5.0,
    "StatusDisplayName": "Pending",
    "TareWeight": 1.0,
    "TareWeightUomCode": "sample string 6",
    "IdNo": 7,
    "BookingDocumentIdNo": 8,
    "EquipmentSubtypeIdNo": 1,
    "EquipmentLabel": "SAMPLE STRING 9",
    "TrackedAssetIdNo": 1,
    "Status": 0,
    "CustomerReference": "SAMPLE STRING 10",
    "ObjectKeyStringWithVersion": "sample string 11",
    "VersionNo": 12,
    "IsActive": true,
    "LastModifiedBy": "sample string 14",
    "ObjectKeyString": "sample string 15",
    "PrimaryKey": [
      7
    ],
    "IsPrimaryKeyInitialized": true
  },
  "UserName": "sample string 5"
}

text/html

Sample:
{"ObjectKeyStringWithVersion":"sample string 1","IdNo":2,"GeoLocationIdNo":3,"Action":"sample string 4","BookingEquipmentWithDetails":{"BookingEquipmentDetails":[{"GeoLocationDescription":"sample string 1","IdNo":2,"BookingEquipmentIdNo":3,"Sequence":4,"GeoLocationIdNo":5,"EquipmentIdNo":1,"ObjectKeyStringWithVersion":"sample string 6","VersionNo":7,"IsActive":true,"LastModifiedBy":"sample string 9","ObjectKeyString":"sample string 10","PrimaryKey":[2],"IsPrimaryKeyInitialized":true},{"GeoLocationDescription":"sample string 1","IdNo":2,"BookingEquipmentIdNo":3,"Sequence":4,"GeoLocationIdNo":5,"EquipmentIdNo":1,"ObjectKeyStringWithVersion":"sample string 6","VersionNo":7,"IsActive":true,"LastModifiedBy":"sample string 9","ObjectKeyString":"sample string 10","PrimaryKey":[2],"IsPrimaryKeyInitialized":true}],"EquipmentSubtypeDescription":"sample string 1","CurrentGeoLocationIdNo":1,"CurrentGeoLocationDescription":"sample string 2","Stops":"sample string 3","StopCount":4,"AccessorialCharges":5.0,"StatusDisplayName":"Pending","TareWeight":1.0,"TareWeightUomCode":"sample string 6","IdNo":7,"BookingDocumentIdNo":8,"EquipmentSubtypeIdNo":1,"EquipmentLabel":"SAMPLE STRING 9","TrackedAssetIdNo":1,"Status":0,"CustomerReference":"SAMPLE STRING 10","ObjectKeyStringWithVersion":"sample string 11","VersionNo":12,"IsActive":true,"LastModifiedBy":"sample string 14","ObjectKeyString":"sample string 15","PrimaryKey":[7],"IsPrimaryKeyInitialized":true},"UserName":"sample string 5"}

Response Information

Resource Description

GenericTransactionResponse
NameDescriptionTypeAdditional information
ReturnedObject

Object

None.

IsSuccessful

Indicates if the transaction was successful or not.

boolean

None.

ReturnedMessages

Contains a list of Informational, Warning, and/or Error messages regarding the outcome of the transaction.

Collection of ReturnedMessage

None.

Response Formats

application/json, text/json

Sample:
{
  "ReturnedObject": {},
  "IsSuccessful": true,
  "ReturnedMessages": null
}

text/html

Sample:
{"ReturnedObject":{},"IsSuccessful":true,"ReturnedMessages":null}