POST api/GetUserDetails_V1

Get user details as locations and carriers linked

Request Information

URI Parameters

None.

Body Parameters

User Details Request

WS_Repository.Models.Requests.UserDetails.UserDetailsRequest
NameDescriptionTypeAdditional information
WS_Key

(Mandatory) Webservice Key provided by 2ship support

string

None.

Request Formats

application/json, text/json

Sample:
{
  "WS_Key": "sample string 1"
}

application/xml, text/xml

Sample:
<UserDetailsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.UserDetails">
  <WS_Key>sample string 1</WS_Key>
</UserDetailsRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.UserDetails.UserDetailsRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.UserDetails.UserDetailsResponse
NameDescriptionTypeAdditional information
Id

User Id

integer

None.

ClientId

Client Id

integer

None.

ClientName

Client Name

string

None.

UserName

User Name

string

None.

DefaultSender

Default User Sender

WS_Repository.Models.Responses.UserDetails.DefaultSender

None.

AllUserLocations

Default Location Id

Collection of WS_Repository.Models.Responses.UserDetails.UserDetailsLocation

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ClientId": 2,
  "ClientName": "sample string 3",
  "UserName": "sample string 4",
  "DefaultSender": {
    "LocationId": 1,
    "Contact": "sample string 2",
    "Company": "sample string 3",
    "Country": "sample string 4",
    "State": "sample string 5",
    "City": "sample string 6",
    "Postal": "sample string 7",
    "Address1": "sample string 8",
    "Address2": "sample string 9",
    "Address3": "sample string 10",
    "Email": "sample string 11",
    "Tel": "sample string 12"
  },
  "AllUserLocations": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Address": {
        "Contact": "sample string 1",
        "Company": "sample string 2",
        "Country": "sample string 3",
        "State": "sample string 4",
        "City": "sample string 5",
        "Postal": "sample string 6",
        "Address1": "sample string 7",
        "Address2": "sample string 8",
        "Email": "sample string 9",
        "Tel": "sample string 10"
      },
      "Carriers": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Address": {
        "Contact": "sample string 1",
        "Company": "sample string 2",
        "Country": "sample string 3",
        "State": "sample string 4",
        "City": "sample string 5",
        "Postal": "sample string 6",
        "Address1": "sample string 7",
        "Address2": "sample string 8",
        "Email": "sample string 9",
        "Tel": "sample string 10"
      },
      "Carriers": [
        {
          "Id": 1,
          "Name": "sample string 2"
        },
        {
          "Id": 1,
          "Name": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<UserDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.UserDetails">
  <AllUserLocations>
    <UserDetailsLocation>
      <Address>
        <Address1>sample string 7</Address1>
        <Address2>sample string 8</Address2>
        <City>sample string 5</City>
        <Company>sample string 2</Company>
        <Contact>sample string 1</Contact>
        <Country>sample string 3</Country>
        <Email>sample string 9</Email>
        <Postal>sample string 6</Postal>
        <State>sample string 4</State>
        <Tel>sample string 10</Tel>
      </Address>
      <Carriers>
        <LocationCarrier>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </LocationCarrier>
        <LocationCarrier>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </LocationCarrier>
      </Carriers>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </UserDetailsLocation>
    <UserDetailsLocation>
      <Address>
        <Address1>sample string 7</Address1>
        <Address2>sample string 8</Address2>
        <City>sample string 5</City>
        <Company>sample string 2</Company>
        <Contact>sample string 1</Contact>
        <Country>sample string 3</Country>
        <Email>sample string 9</Email>
        <Postal>sample string 6</Postal>
        <State>sample string 4</State>
        <Tel>sample string 10</Tel>
      </Address>
      <Carriers>
        <LocationCarrier>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </LocationCarrier>
        <LocationCarrier>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </LocationCarrier>
      </Carriers>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </UserDetailsLocation>
  </AllUserLocations>
  <ClientId>2</ClientId>
  <ClientName>sample string 3</ClientName>
  <DefaultSender>
    <Address1>sample string 8</Address1>
    <Address2>sample string 9</Address2>
    <Address3>sample string 10</Address3>
    <City>sample string 6</City>
    <Company>sample string 3</Company>
    <Contact>sample string 2</Contact>
    <Country>sample string 4</Country>
    <Email>sample string 11</Email>
    <LocationId>1</LocationId>
    <Postal>sample string 7</Postal>
    <State>sample string 5</State>
    <Tel>sample string 12</Tel>
  </DefaultSender>
  <Id>1</Id>
  <UserName>sample string 4</UserName>
</UserDetailsResponse>