POST api/Shipper/AddressSearch

Search users address book

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserGUID	string	None.
UserGroupGUID	string	None.
CompanyName	string	None.
CityName	string	None.
StateProvID	string	None.
AddressCode	string	None.
CountryID	string	None.
PostalCode	string	None.
ReturnAllIfNoParms	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "UserGroupGUID": "sample string 2",
  "CompanyName": "sample string 3",
  "CityName": "sample string 4",
  "StateProvID": "sample string 5",
  "AddressCode": "sample string 6",
  "CountryID": "sample string 7",
  "PostalCode": "sample string 8",
  "ReturnAllIfNoParms": true
}

application/xml, text/xml

Sample:

<AddressSearchParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models.Shipper">
  <AddressCode>sample string 6</AddressCode>
  <CityName>sample string 4</CityName>
  <CompanyName>sample string 3</CompanyName>
  <CountryID>sample string 7</CountryID>
  <PostalCode>sample string 8</PostalCode>
  <ReturnAllIfNoParms>true</ReturnAllIfNoParms>
  <StateProvID>sample string 5</StateProvID>
  <UserGUID>sample string 1</UserGUID>
  <UserGroupGUID>sample string 2</UserGroupGUID>
</AddressSearchParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddressSearchResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	Required
ErrorMessage	The error message if method call was not successful	string	None.
Addresses	List of addresses returned from search parameters	Collection of AddressItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Addresses": [
    {
      "AddressGUID": "sample string 1",
      "AddressCode": "sample string 2",
      "CompanyName": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "Address3": "sample string 6",
      "CityName": "sample string 7",
      "StateProvID": "sample string 8",
      "PostalCode": "sample string 9",
      "CountryID": "sample string 10",
      "TimezoneID": "sample string 11",
      "Attention": "sample string 12",
      "PhoneNumber": "sample string 13",
      "EmailAddress": "sample string 14",
      "Reference": "sample string 15",
      "PickupInstructions": "sample string 16",
      "DeliveryInstructions": "sample string 17",
      "InsertUserGUID": "sample string 18",
      "InsertDateTime": "2024-09-19T09:13:17.8935505+00:00",
      "UserGroupGUID": "sample string 20",
      "GroupAvailable": true,
      "NotifyOrderAck": true,
      "NotifyOrderRouted": true,
      "NotifyDispatched": true,
      "NotifyPickedUp": true,
      "NotifyDepToAp": true,
      "NotifyObcCheckin": true,
      "NotifyDropped": true,
      "NotifyConfirmed": true,
      "NotifyDeparted": true,
      "NotifyArrived": true,
      "NotifyRecovered": true,
      "NotifyDelivered": true,
      "NotifyOrigQdt": true,
      "NotifyChangeQdt": true,
      "AirportID": "sample string 36",
      "PickupReadyDay": 1,
      "PickupReadyTime": "2024-09-19T09:13:17.8935505+00:00",
      "DeliveryRequestDay": 1,
      "DeliveryRequestTime": "2024-09-19T09:13:17.8935505+00:00",
      "PickupReady": "2024-09-20T09:13:00Z",
      "DeliveryRequest": "2024-09-20T09:13:00Z",
      "AirportID2": "sample string 37",
      "AirportID3": "sample string 38",
      "DistanceToAirport": 1,
      "DistanceToAirport2": 1,
      "DistanceToAirport3": 1,
      "DistanceUOM": "sample string 39",
      "SingleLineDisplay": "sample string 3, sample string 4, sample string 7 sample string 8, sample string 9 sample string 10"
    },
    {
      "AddressGUID": "sample string 1",
      "AddressCode": "sample string 2",
      "CompanyName": "sample string 3",
      "Address1": "sample string 4",
      "Address2": "sample string 5",
      "Address3": "sample string 6",
      "CityName": "sample string 7",
      "StateProvID": "sample string 8",
      "PostalCode": "sample string 9",
      "CountryID": "sample string 10",
      "TimezoneID": "sample string 11",
      "Attention": "sample string 12",
      "PhoneNumber": "sample string 13",
      "EmailAddress": "sample string 14",
      "Reference": "sample string 15",
      "PickupInstructions": "sample string 16",
      "DeliveryInstructions": "sample string 17",
      "InsertUserGUID": "sample string 18",
      "InsertDateTime": "2024-09-19T09:13:17.8935505+00:00",
      "UserGroupGUID": "sample string 20",
      "GroupAvailable": true,
      "NotifyOrderAck": true,
      "NotifyOrderRouted": true,
      "NotifyDispatched": true,
      "NotifyPickedUp": true,
      "NotifyDepToAp": true,
      "NotifyObcCheckin": true,
      "NotifyDropped": true,
      "NotifyConfirmed": true,
      "NotifyDeparted": true,
      "NotifyArrived": true,
      "NotifyRecovered": true,
      "NotifyDelivered": true,
      "NotifyOrigQdt": true,
      "NotifyChangeQdt": true,
      "AirportID": "sample string 36",
      "PickupReadyDay": 1,
      "PickupReadyTime": "2024-09-19T09:13:17.8935505+00:00",
      "DeliveryRequestDay": 1,
      "DeliveryRequestTime": "2024-09-19T09:13:17.8935505+00:00",
      "PickupReady": "2024-09-20T09:13:00Z",
      "DeliveryRequest": "2024-09-20T09:13:00Z",
      "AirportID2": "sample string 37",
      "AirportID3": "sample string 38",
      "DistanceToAirport": 1,
      "DistanceToAirport2": 1,
      "DistanceToAirport3": 1,
      "DistanceUOM": "sample string 39",
      "SingleLineDisplay": "sample string 3, sample string 4, sample string 7 sample string 8, sample string 9 sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:

<AddressSearchResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models.Shipper">
  <Addresses>
    <AddressItem>
      <Address1>sample string 4</Address1>
      <Address2>sample string 5</Address2>
      <Address3>sample string 6</Address3>
      <AddressCode>sample string 2</AddressCode>
      <AddressGUID>sample string 1</AddressGUID>
      <AirportID>sample string 36</AirportID>
      <AirportID2>sample string 37</AirportID2>
      <AirportID3>sample string 38</AirportID3>
      <Attention>sample string 12</Attention>
      <CityName>sample string 7</CityName>
      <CompanyName>sample string 3</CompanyName>
      <CountryID>sample string 10</CountryID>
      <DeliveryInstructions>sample string 17</DeliveryInstructions>
      <DeliveryRequestDay>1</DeliveryRequestDay>
      <DeliveryRequestTime>2024-09-19T09:13:17.8935505+00:00</DeliveryRequestTime>
      <DistanceToAirport>1</DistanceToAirport>
      <DistanceToAirport2>1</DistanceToAirport2>
      <DistanceToAirport3>1</DistanceToAirport3>
      <DistanceUOM>sample string 39</DistanceUOM>
      <EmailAddress>sample string 14</EmailAddress>
      <GroupAvailable>true</GroupAvailable>
      <InsertDateTime>2024-09-19T09:13:17.8935505+00:00</InsertDateTime>
      <InsertUserGUID>sample string 18</InsertUserGUID>
      <NotifyArrived>true</NotifyArrived>
      <NotifyChangeQdt>true</NotifyChangeQdt>
      <NotifyConfirmed>true</NotifyConfirmed>
      <NotifyDelivered>true</NotifyDelivered>
      <NotifyDepToAp>true</NotifyDepToAp>
      <NotifyDeparted>true</NotifyDeparted>
      <NotifyDispatched>true</NotifyDispatched>
      <NotifyDropped>true</NotifyDropped>
      <NotifyObcCheckin>true</NotifyObcCheckin>
      <NotifyOrderAck>true</NotifyOrderAck>
      <NotifyOrderRouted>true</NotifyOrderRouted>
      <NotifyOrigQdt>true</NotifyOrigQdt>
      <NotifyPickedUp>true</NotifyPickedUp>
      <NotifyRecovered>true</NotifyRecovered>
      <PhoneNumber>sample string 13</PhoneNumber>
      <PickupInstructions>sample string 16</PickupInstructions>
      <PickupReadyDay>1</PickupReadyDay>
      <PickupReadyTime>2024-09-19T09:13:17.8935505+00:00</PickupReadyTime>
      <PostalCode>sample string 9</PostalCode>
      <Reference>sample string 15</Reference>
      <StateProvID>sample string 8</StateProvID>
      <TimezoneID>sample string 11</TimezoneID>
      <UserGroupGUID>sample string 20</UserGroupGUID>
    </AddressItem>
    <AddressItem>
      <Address1>sample string 4</Address1>
      <Address2>sample string 5</Address2>
      <Address3>sample string 6</Address3>
      <AddressCode>sample string 2</AddressCode>
      <AddressGUID>sample string 1</AddressGUID>
      <AirportID>sample string 36</AirportID>
      <AirportID2>sample string 37</AirportID2>
      <AirportID3>sample string 38</AirportID3>
      <Attention>sample string 12</Attention>
      <CityName>sample string 7</CityName>
      <CompanyName>sample string 3</CompanyName>
      <CountryID>sample string 10</CountryID>
      <DeliveryInstructions>sample string 17</DeliveryInstructions>
      <DeliveryRequestDay>1</DeliveryRequestDay>
      <DeliveryRequestTime>2024-09-19T09:13:17.8935505+00:00</DeliveryRequestTime>
      <DistanceToAirport>1</DistanceToAirport>
      <DistanceToAirport2>1</DistanceToAirport2>
      <DistanceToAirport3>1</DistanceToAirport3>
      <DistanceUOM>sample string 39</DistanceUOM>
      <EmailAddress>sample string 14</EmailAddress>
      <GroupAvailable>true</GroupAvailable>
      <InsertDateTime>2024-09-19T09:13:17.8935505+00:00</InsertDateTime>
      <InsertUserGUID>sample string 18</InsertUserGUID>
      <NotifyArrived>true</NotifyArrived>
      <NotifyChangeQdt>true</NotifyChangeQdt>
      <NotifyConfirmed>true</NotifyConfirmed>
      <NotifyDelivered>true</NotifyDelivered>
      <NotifyDepToAp>true</NotifyDepToAp>
      <NotifyDeparted>true</NotifyDeparted>
      <NotifyDispatched>true</NotifyDispatched>
      <NotifyDropped>true</NotifyDropped>
      <NotifyObcCheckin>true</NotifyObcCheckin>
      <NotifyOrderAck>true</NotifyOrderAck>
      <NotifyOrderRouted>true</NotifyOrderRouted>
      <NotifyOrigQdt>true</NotifyOrigQdt>
      <NotifyPickedUp>true</NotifyPickedUp>
      <NotifyRecovered>true</NotifyRecovered>
      <PhoneNumber>sample string 13</PhoneNumber>
      <PickupInstructions>sample string 16</PickupInstructions>
      <PickupReadyDay>1</PickupReadyDay>
      <PickupReadyTime>2024-09-19T09:13:17.8935505+00:00</PickupReadyTime>
      <PostalCode>sample string 9</PostalCode>
      <Reference>sample string 15</Reference>
      <StateProvID>sample string 8</StateProvID>
      <TimezoneID>sample string 11</TimezoneID>
      <UserGroupGUID>sample string 20</UserGroupGUID>
    </AddressItem>
  </Addresses>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</AddressSearchResp>