POST api/v1/account/registration/registerUser

Request Information

URI Parameters

None.

Body Parameters

RegisterModel
NameDescriptionTypeAdditional information
CustomerId

string

None.

Password

string

None.

AccessCode

globally unique identifier

None.

Profile

ProfileModel

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerId": "sample string 1",
  "Password": "sample string 2",
  "AccessCode": "25475f97-4558-41bc-a676-2d9764cf043b",
  "Profile": {
    "Activity": 1,
    "Remark": "sample string 2",
    "Mobile": "sample string 3",
    "BirthDate": "2021-09-09T05:22:22.2573209+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
      }
    ]
  }
}

application/xml, text/xml

Sample:
<RegisterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UPS.Ship.API.Models.Account">
  <AccessCode>25475f97-4558-41bc-a676-2d9764cf043b</AccessCode>
  <CustomerId>sample string 1</CustomerId>
  <Password>sample string 2</Password>
  <Profile xmlns:d2p1="http://schemas.datacontract.org/2004/07/UPS.ShipApp.Models.Account">
    <d2p1:Activity>1</d2p1:Activity>
    <d2p1:BirthDate>2021-09-09T05:22:22.2573209+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>
</RegisterModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseEditModel
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

ActivityCode

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "ActivityCode": 3
}

application/xml, text/xml

Sample:
<BaseEditModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UPS.Ship.API.Models.Shared">
  <ActivityCode>3</ActivityCode>
  <Message>sample string 2</Message>
  <Success>true</Success>
</BaseEditModel>