GET api/MySettings/{auth}

Use this method to retrieve the MySettings parameters for the user

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	Required

Body Parameters

None.

Response Information

Resource Description

MySettingsResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
UserID		integer	None.
LogonName		string	None.
Password		string	None.
FirstName		string	None.
LastName		string	None.
EmailAddress		string	None.
OfficeNumber		string	None.
FaxNumber		string	None.
MobileNumber		string	None.
TimezoneID		string	None.
CountryID		string	None.
AccountNumber		string	None.
AccountNumberShipper		string	None.
BillToType		string	None.
UserCompanyName		string	None.
Pieces		integer	None.
Weight		decimal number	None.
WeightUOM		string	None.
Length		integer	None.
Width		integer	None.
Height		integer	None.
SizeUOM		string	None.
DistanceUOM		string	None.
PickupCompanyName		string	None.
PickupAddress1		string	None.
PickupAddress2		string	None.
PickupAddress3		string	None.
PickupCityName		string	None.
PickupStateProvID		string	None.
PickupPostalCode		string	None.
PickupCountryID		string	None.
PickupTimezoneID		string	None.
PickupPersonToSee		string	None.
PickupPhoneNumber		string	None.
PickupAfterHoursNumber		string	None.
PickupFaxNumber		string	None.
PickupEmailAddress		string	None.
PickupInstructions		string	None.
PickupReadyTime		date	None.
PickupReadyNow		boolean	None.
PickupAirportID		string	None.
PickupDistance		integer	None.
DeliveryCompanyName		string	None.
DeliveryAddress1		string	None.
DeliveryAddress2		string	None.
DeliveryAddress3		string	None.
DeliveryCityName		string	None.
DeliveryStateProvID		string	None.
DeliveryPostalCode		string	None.
DeliveryCountryID		string	None.
DeliveryTimezoneID		string	None.
DeliveryAttention		string	None.
DeliveryPhoneNumber		string	None.
DeliveryAfterHoursNumber		string	None.
DeliveryFaxNumber		string	None.
DeliveryEmailAddress		string	None.
DeliveryInstructions		string	None.
DeliveryRequestTime		date	None.
DeliveryRequestAsap		boolean	None.
DeliveryAirportID		string	None.
DeliveryDistance		integer	None.
CurrencyID		string	None.
DeclaredValue		decimal number	None.
Contents		string	None.
Reference		string	None.
Reference2		string	None.
Reference3		string	None.
Reference4		string	None.
Reference5		string	None.
ReferenceTypeID		integer	None.
ReferenceTypeID2		integer	None.
ReferenceTypeID3		integer	None.
ReferenceTypeID4		integer	None.
ReferenceTypeID5		integer	None.
ContentsLabel		string	None.
ServiceGUID		string	None.
OrderFormType		string	None.
ReferenceGroupGUID		string	None.
ReferenceGroupGUID2		string	None.
ReferenceGroupGUID3		string	None.
ReferenceGroupGUID4		string	None.
ReferenceGroupGUID5		string	None.
ReferenceLabel		string	None.
ReferenceLabel2		string	None.
ReferenceLabel3		string	None.
ReferenceLabel4		string	None.
ReferenceLabel5		string	None.
NotifyShipperOrderAck		boolean	None.
NotifyShipperOrderRouted		boolean	None.
NotifyShipperDispatched		boolean	None.
NotifyShipperPickedUp		boolean	None.
NotifyShipperDepToAp		boolean	None.
NotifyShipperObcCheckin		boolean	None.
NotifyShipperDropped		boolean	None.
NotifyShipperConfirmed		boolean	None.
NotifyShipperDeparted		boolean	None.
NotifyShipperArrived		boolean	None.
NotifyShipperRecovered		boolean	None.
NotifyShipperOutForDelivery		boolean	None.
NotifyShipperDelivered		boolean	None.
NotifyShipperOrigQdt		boolean	None.
NotifyShipperChangeQdt		boolean	None.
NotifyConseeOrderAck		boolean	None.
NotifyConseeOrderRouted		boolean	None.
NotifyConseeDispatched		boolean	None.
NotifyConseePickedUp		boolean	None.
NotifyConseeDepToAp		boolean	None.
NotifyConseeObcCheckin		boolean	None.
NotifyConseeDropped		boolean	None.
NotifyConseeConfirmed		boolean	None.
NotifyConseeDeparted		boolean	None.
NotifyConseeArrived		boolean	None.
NotifyConseeRecovered		boolean	None.
NotifyConseeOutForDelivery		boolean	None.
NotifyConseeDelivered		boolean	None.
NotifyConseeOrigQdt		boolean	None.
NotifyConseeChangeQdt		boolean	None.
ContentsReferenceGroupGUID		string	None.
HoldForPickup		boolean	None.
DeliverWhen		string	None.
IsDangerousGoods		boolean	None.
DgUNNumber		string	None.
DgCommodityClass		string	None.
DgDryIceWeight		decimal number	None.
DgTransportationIndex		string	None.
DgTransportationLimit		string	None.
DgIsRadioactive		boolean	None.
DgPackingGroup		string	None.
DgQuantityAndPackType		string	None.
DgPackingInst		string	None.
DgAuthorization		string	None.
DgHandlingInfo		string	None.
DgEmergencyPhone		string	None.
DgSignatory		string	None.
DgProperName		string	None.
DgDate		date	None.

Response Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 14",
  "AccountNumberShipper": "sample string 15",
  "BillToType": "sample string 16",
  "Contents": "sample string 56",
  "ContentsLabel": "sample string 62",
  "ContentsReferenceGroupGUID": "sample string 105",
  "CountryID": "sample string 13",
  "CurrencyID": "sample string 55",
  "DeclaredValue": 1,
  "DeliverWhen": "sample string 107",
  "DeliveryAddress1": "sample string 39",
  "DeliveryAddress2": "sample string 40",
  "DeliveryAddress3": "sample string 41",
  "DeliveryAfterHoursNumber": "sample string 49",
  "DeliveryAirportID": "sample string 54",
  "DeliveryAttention": "sample string 47",
  "DeliveryCityName": "sample string 42",
  "DeliveryCompanyName": "sample string 38",
  "DeliveryCountryID": "sample string 45",
  "DeliveryDistance": 1,
  "DeliveryEmailAddress": "sample string 51",
  "DeliveryFaxNumber": "sample string 50",
  "DeliveryInstructions": "sample string 52",
  "DeliveryPhoneNumber": "sample string 48",
  "DeliveryPostalCode": "sample string 44",
  "DeliveryRequestAsap": true,
  "DeliveryRequestTime": "2025-04-03T13:40:25.575-07:00",
  "DeliveryStateProvID": "sample string 43",
  "DeliveryTimezoneID": "sample string 46",
  "DgAuthorization": "sample string 117",
  "DgCommodityClass": "sample string 110",
  "DgDate": "2025-04-03T13:40:25.575-07:00",
  "DgDryIceWeight": 1,
  "DgEmergencyPhone": "sample string 119",
  "DgHandlingInfo": "sample string 118",
  "DgIsRadioactive": true,
  "DgPackingGroup": "sample string 114",
  "DgPackingInst": "sample string 116",
  "DgProperName": "sample string 121",
  "DgQuantityAndPackType": "sample string 115",
  "DgSignatory": "sample string 120",
  "DgTransportationIndex": "sample string 111",
  "DgTransportationLimit": "sample string 112",
  "DgUNNumber": "sample string 109",
  "DistanceUOM": "sample string 20",
  "EmailAddress": "sample string 8",
  "ErrorMessage": "sample string 2",
  "FaxNumber": "sample string 10",
  "FirstName": "sample string 6",
  "Height": 1,
  "HoldForPickup": true,
  "IsDangerousGoods": true,
  "IsSuccessful": true,
  "LastName": "sample string 7",
  "Length": 1,
  "LogonName": "sample string 4",
  "MobileNumber": "sample string 11",
  "NotifyConseeArrived": true,
  "NotifyConseeChangeQdt": true,
  "NotifyConseeConfirmed": true,
  "NotifyConseeDelivered": true,
  "NotifyConseeDepToAp": true,
  "NotifyConseeDeparted": true,
  "NotifyConseeDispatched": true,
  "NotifyConseeDropped": true,
  "NotifyConseeObcCheckin": true,
  "NotifyConseeOrderAck": true,
  "NotifyConseeOrderRouted": true,
  "NotifyConseeOrigQdt": true,
  "NotifyConseeOutForDelivery": true,
  "NotifyConseePickedUp": true,
  "NotifyConseeRecovered": true,
  "NotifyShipperArrived": true,
  "NotifyShipperChangeQdt": true,
  "NotifyShipperConfirmed": true,
  "NotifyShipperDelivered": true,
  "NotifyShipperDepToAp": true,
  "NotifyShipperDeparted": true,
  "NotifyShipperDispatched": true,
  "NotifyShipperDropped": true,
  "NotifyShipperObcCheckin": true,
  "NotifyShipperOrderAck": true,
  "NotifyShipperOrderRouted": true,
  "NotifyShipperOrigQdt": true,
  "NotifyShipperOutForDelivery": true,
  "NotifyShipperPickedUp": true,
  "NotifyShipperRecovered": true,
  "OfficeNumber": "sample string 9",
  "OrderFormType": "sample string 64",
  "Password": "sample string 5",
  "PickupAddress1": "sample string 22",
  "PickupAddress2": "sample string 23",
  "PickupAddress3": "sample string 24",
  "PickupAfterHoursNumber": "sample string 32",
  "PickupAirportID": "sample string 37",
  "PickupCityName": "sample string 25",
  "PickupCompanyName": "sample string 21",
  "PickupCountryID": "sample string 28",
  "PickupDistance": 1,
  "PickupEmailAddress": "sample string 34",
  "PickupFaxNumber": "sample string 33",
  "PickupInstructions": "sample string 35",
  "PickupPersonToSee": "sample string 30",
  "PickupPhoneNumber": "sample string 31",
  "PickupPostalCode": "sample string 27",
  "PickupReadyNow": true,
  "PickupReadyTime": "2025-04-03T13:40:25.575-07:00",
  "PickupStateProvID": "sample string 26",
  "PickupTimezoneID": "sample string 29",
  "Pieces": 1,
  "Reference": "sample string 57",
  "Reference2": "sample string 58",
  "Reference3": "sample string 59",
  "Reference4": "sample string 60",
  "Reference5": "sample string 61",
  "ReferenceGroupGUID": "sample string 65",
  "ReferenceGroupGUID2": "sample string 66",
  "ReferenceGroupGUID3": "sample string 67",
  "ReferenceGroupGUID4": "sample string 68",
  "ReferenceGroupGUID5": "sample string 69",
  "ReferenceLabel": "sample string 70",
  "ReferenceLabel2": "sample string 71",
  "ReferenceLabel3": "sample string 72",
  "ReferenceLabel4": "sample string 73",
  "ReferenceLabel5": "sample string 74",
  "ReferenceTypeID": 1,
  "ReferenceTypeID2": 1,
  "ReferenceTypeID3": 1,
  "ReferenceTypeID4": 1,
  "ReferenceTypeID5": 1,
  "ServiceGUID": "sample string 63",
  "SizeUOM": "sample string 19",
  "TimezoneID": "sample string 12",
  "UserCompanyName": "sample string 17",
  "UserID": 3,
  "Weight": 1,
  "WeightUOM": "sample string 18",
  "Width": 1
}

application/xml, text/xml

Sample:

<MySettingsResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <AccountNumber>sample string 14</AccountNumber>
  <AccountNumberShipper>sample string 15</AccountNumberShipper>
  <BillToType>sample string 16</BillToType>
  <Contents>sample string 56</Contents>
  <ContentsLabel>sample string 62</ContentsLabel>
  <ContentsReferenceGroupGUID>sample string 105</ContentsReferenceGroupGUID>
  <CountryID>sample string 13</CountryID>
  <CurrencyID>sample string 55</CurrencyID>
  <DeclaredValue>1</DeclaredValue>
  <DeliverWhen>sample string 107</DeliverWhen>
  <DeliveryAddress1>sample string 39</DeliveryAddress1>
  <DeliveryAddress2>sample string 40</DeliveryAddress2>
  <DeliveryAddress3>sample string 41</DeliveryAddress3>
  <DeliveryAfterHoursNumber>sample string 49</DeliveryAfterHoursNumber>
  <DeliveryAirportID>sample string 54</DeliveryAirportID>
  <DeliveryAttention>sample string 47</DeliveryAttention>
  <DeliveryCityName>sample string 42</DeliveryCityName>
  <DeliveryCompanyName>sample string 38</DeliveryCompanyName>
  <DeliveryCountryID>sample string 45</DeliveryCountryID>
  <DeliveryDistance>1</DeliveryDistance>
  <DeliveryEmailAddress>sample string 51</DeliveryEmailAddress>
  <DeliveryFaxNumber>sample string 50</DeliveryFaxNumber>
  <DeliveryInstructions>sample string 52</DeliveryInstructions>
  <DeliveryPhoneNumber>sample string 48</DeliveryPhoneNumber>
  <DeliveryPostalCode>sample string 44</DeliveryPostalCode>
  <DeliveryRequestAsap>true</DeliveryRequestAsap>
  <DeliveryRequestTime>2025-04-03T13:40:25.5756513-07:00</DeliveryRequestTime>
  <DeliveryStateProvID>sample string 43</DeliveryStateProvID>
  <DeliveryTimezoneID>sample string 46</DeliveryTimezoneID>
  <DgAuthorization>sample string 117</DgAuthorization>
  <DgCommodityClass>sample string 110</DgCommodityClass>
  <DgDate>2025-04-03T13:40:25.5756513-07:00</DgDate>
  <DgDryIceWeight>1</DgDryIceWeight>
  <DgEmergencyPhone>sample string 119</DgEmergencyPhone>
  <DgHandlingInfo>sample string 118</DgHandlingInfo>
  <DgIsRadioactive>true</DgIsRadioactive>
  <DgPackingGroup>sample string 114</DgPackingGroup>
  <DgPackingInst>sample string 116</DgPackingInst>
  <DgProperName>sample string 121</DgProperName>
  <DgQuantityAndPackType>sample string 115</DgQuantityAndPackType>
  <DgSignatory>sample string 120</DgSignatory>
  <DgTransportationIndex>sample string 111</DgTransportationIndex>
  <DgTransportationLimit>sample string 112</DgTransportationLimit>
  <DgUNNumber>sample string 109</DgUNNumber>
  <DistanceUOM>sample string 20</DistanceUOM>
  <EmailAddress>sample string 8</EmailAddress>
  <ErrorMessage>sample string 2</ErrorMessage>
  <FaxNumber>sample string 10</FaxNumber>
  <FirstName>sample string 6</FirstName>
  <Height>1</Height>
  <HoldForPickup>true</HoldForPickup>
  <IsDangerousGoods>true</IsDangerousGoods>
  <IsSuccessful>true</IsSuccessful>
  <LastName>sample string 7</LastName>
  <Length>1</Length>
  <LogonName>sample string 4</LogonName>
  <MobileNumber>sample string 11</MobileNumber>
  <NotifyConseeArrived>true</NotifyConseeArrived>
  <NotifyConseeChangeQdt>true</NotifyConseeChangeQdt>
  <NotifyConseeConfirmed>true</NotifyConseeConfirmed>
  <NotifyConseeDelivered>true</NotifyConseeDelivered>
  <NotifyConseeDepToAp>true</NotifyConseeDepToAp>
  <NotifyConseeDeparted>true</NotifyConseeDeparted>
  <NotifyConseeDispatched>true</NotifyConseeDispatched>
  <NotifyConseeDropped>true</NotifyConseeDropped>
  <NotifyConseeObcCheckin>true</NotifyConseeObcCheckin>
  <NotifyConseeOrderAck>true</NotifyConseeOrderAck>
  <NotifyConseeOrderRouted>true</NotifyConseeOrderRouted>
  <NotifyConseeOrigQdt>true</NotifyConseeOrigQdt>
  <NotifyConseeOutForDelivery>true</NotifyConseeOutForDelivery>
  <NotifyConseePickedUp>true</NotifyConseePickedUp>
  <NotifyConseeRecovered>true</NotifyConseeRecovered>
  <NotifyShipperArrived>true</NotifyShipperArrived>
  <NotifyShipperChangeQdt>true</NotifyShipperChangeQdt>
  <NotifyShipperConfirmed>true</NotifyShipperConfirmed>
  <NotifyShipperDelivered>true</NotifyShipperDelivered>
  <NotifyShipperDepToAp>true</NotifyShipperDepToAp>
  <NotifyShipperDeparted>true</NotifyShipperDeparted>
  <NotifyShipperDispatched>true</NotifyShipperDispatched>
  <NotifyShipperDropped>true</NotifyShipperDropped>
  <NotifyShipperObcCheckin>true</NotifyShipperObcCheckin>
  <NotifyShipperOrderAck>true</NotifyShipperOrderAck>
  <NotifyShipperOrderRouted>true</NotifyShipperOrderRouted>
  <NotifyShipperOrigQdt>true</NotifyShipperOrigQdt>
  <NotifyShipperOutForDelivery>true</NotifyShipperOutForDelivery>
  <NotifyShipperPickedUp>true</NotifyShipperPickedUp>
  <NotifyShipperRecovered>true</NotifyShipperRecovered>
  <OfficeNumber>sample string 9</OfficeNumber>
  <OrderFormType>sample string 64</OrderFormType>
  <Password>sample string 5</Password>
  <PickupAddress1>sample string 22</PickupAddress1>
  <PickupAddress2>sample string 23</PickupAddress2>
  <PickupAddress3>sample string 24</PickupAddress3>
  <PickupAfterHoursNumber>sample string 32</PickupAfterHoursNumber>
  <PickupAirportID>sample string 37</PickupAirportID>
  <PickupCityName>sample string 25</PickupCityName>
  <PickupCompanyName>sample string 21</PickupCompanyName>
  <PickupCountryID>sample string 28</PickupCountryID>
  <PickupDistance>1</PickupDistance>
  <PickupEmailAddress>sample string 34</PickupEmailAddress>
  <PickupFaxNumber>sample string 33</PickupFaxNumber>
  <PickupInstructions>sample string 35</PickupInstructions>
  <PickupPersonToSee>sample string 30</PickupPersonToSee>
  <PickupPhoneNumber>sample string 31</PickupPhoneNumber>
  <PickupPostalCode>sample string 27</PickupPostalCode>
  <PickupReadyNow>true</PickupReadyNow>
  <PickupReadyTime>2025-04-03T13:40:25.5756513-07:00</PickupReadyTime>
  <PickupStateProvID>sample string 26</PickupStateProvID>
  <PickupTimezoneID>sample string 29</PickupTimezoneID>
  <Pieces>1</Pieces>
  <Reference>sample string 57</Reference>
  <Reference2>sample string 58</Reference2>
  <Reference3>sample string 59</Reference3>
  <Reference4>sample string 60</Reference4>
  <Reference5>sample string 61</Reference5>
  <ReferenceGroupGUID>sample string 65</ReferenceGroupGUID>
  <ReferenceGroupGUID2>sample string 66</ReferenceGroupGUID2>
  <ReferenceGroupGUID3>sample string 67</ReferenceGroupGUID3>
  <ReferenceGroupGUID4>sample string 68</ReferenceGroupGUID4>
  <ReferenceGroupGUID5>sample string 69</ReferenceGroupGUID5>
  <ReferenceLabel>sample string 70</ReferenceLabel>
  <ReferenceLabel2>sample string 71</ReferenceLabel2>
  <ReferenceLabel3>sample string 72</ReferenceLabel3>
  <ReferenceLabel4>sample string 73</ReferenceLabel4>
  <ReferenceLabel5>sample string 74</ReferenceLabel5>
  <ReferenceTypeID>1</ReferenceTypeID>
  <ReferenceTypeID2>1</ReferenceTypeID2>
  <ReferenceTypeID3>1</ReferenceTypeID3>
  <ReferenceTypeID4>1</ReferenceTypeID4>
  <ReferenceTypeID5>1</ReferenceTypeID5>
  <ServiceGUID>sample string 63</ServiceGUID>
  <SizeUOM>sample string 19</SizeUOM>
  <TimezoneID>sample string 12</TimezoneID>
  <UserCompanyName>sample string 17</UserCompanyName>
  <UserID>3</UserID>
  <Weight>1</Weight>
  <WeightUOM>sample string 18</WeightUOM>
  <Width>1</Width>
</MySettingsResp>