GET api/v1/account/registration/getProfileByAccessCode?customerId={customerId}&accessCode={accessCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerId

integer

Required

accessCode

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ProfileByAccessCodeModel
NameDescriptionTypeAdditional information
CustomerName

string

None.

Profile

ProfileModel

None.

DepartmentCodes

Collection of IdTitleModel

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerName": "sample string 1",
  "Profile": {
    "Activity": 1,
    "Remark": "sample string 2",
    "Mobile": "sample string 3",
    "BirthDate": "2021-09-09T05:22:18.3198213+03:00",
    "LastNameHeb": "sample string 4",
    "FirstNameHeb": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "IdentificationNumber": "sample string 8",
    "Phone": "sample string 9",
    "Email": "sample string 10",
    "Flags": [
      {
        "FieldName": "sample string 1",
        "Description": "sample string 2",
        "FlagValue": 3,
        "GroupID": 4,
        "IsChecked": true
      },
      {
        "FieldName": "sample string 1",
        "Description": "sample string 2",
        "FlagValue": 3,
        "GroupID": 4,
        "IsChecked": true
      }
    ]
  },
  "DepartmentCodes": [
    {
      "Id": "sample string 1",
      "Title": "sample string 2",
      "Order": 1
    },
    {
      "Id": "sample string 1",
      "Title": "sample string 2",
      "Order": 1
    }
  ]
}

application/xml, text/xml

Sample:
<ProfileByAccessCodeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UPS.Ship.API.Models.Profile">
  <CustomerName>sample string 1</CustomerName>
  <DepartmentCodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/UPS.ShipApp.Models">
    <d2p1:IdTitleModel>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Order>1</d2p1:Order>
      <d2p1:Title>sample string 2</d2p1:Title>
    </d2p1:IdTitleModel>
    <d2p1:IdTitleModel>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:Order>1</d2p1:Order>
      <d2p1:Title>sample string 2</d2p1:Title>
    </d2p1:IdTitleModel>
  </DepartmentCodes>
  <Profile xmlns:d2p1="http://schemas.datacontract.org/2004/07/UPS.ShipApp.Models.Account">
    <d2p1:Activity>1</d2p1:Activity>
    <d2p1:BirthDate>2021-09-09T05:22:18.3198213+03:00</d2p1:BirthDate>
    <d2p1:Email>sample string 10</d2p1:Email>
    <d2p1:FirstName>sample string 6</d2p1:FirstName>
    <d2p1:FirstNameHeb>sample string 5</d2p1:FirstNameHeb>
    <d2p1:Flags>
      <d2p1:ProfileReportFlagModel>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:FieldName>sample string 1</d2p1:FieldName>
        <d2p1:FlagValue>3</d2p1:FlagValue>
        <d2p1:GroupID>4</d2p1:GroupID>
        <d2p1:IsChecked>true</d2p1:IsChecked>
      </d2p1:ProfileReportFlagModel>
      <d2p1:ProfileReportFlagModel>
        <d2p1:Description>sample string 2</d2p1:Description>
        <d2p1:FieldName>sample string 1</d2p1:FieldName>
        <d2p1:FlagValue>3</d2p1:FlagValue>
        <d2p1:GroupID>4</d2p1:GroupID>
        <d2p1:IsChecked>true</d2p1:IsChecked>
      </d2p1:ProfileReportFlagModel>
    </d2p1:Flags>
    <d2p1:IdentificationNumber>sample string 8</d2p1:IdentificationNumber>
    <d2p1:LastName>sample string 7</d2p1:LastName>
    <d2p1:LastNameHeb>sample string 4</d2p1:LastNameHeb>
    <d2p1:Mobile>sample string 3</d2p1:Mobile>
    <d2p1:Phone>sample string 9</d2p1:Phone>
    <d2p1:Remark>sample string 2</d2p1:Remark>
  </Profile>
</ProfileByAccessCodeModel>