POST api/administrators/{appID}/branchoffices/update

Request Information

URI Parameters

NameDescriptionTypeAdditional information
appID

globally unique identifier

Required

Body Parameters

ApplicationBranchOfficeData
NameDescriptionTypeAdditional information
AppID

globally unique identifier

None.

Code

string

None.

Name

string

None.

CityID

integer

None.

CityName

string

None.

DepartmentID

integer

None.

DepartmentName

string

None.

ProvinceID

integer

None.

ProvinceName

string

None.

CountryID

integer

None.

CountryName

string

None.

StreetNameAndNumber

string

None.

Phones

string

None.

Email

string

None.

ApplicationDataSelected

ApplicationInfoData

None.

EnvironmentSelected

EnvironmentData

None.

ID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AppID": "b078d886-44ad-4082-9e91-d20dd9acb5ff",
  "Code": "sample string 1",
  "Name": "sample string 2",
  "CityID": 1,
  "CityName": "sample string 3",
  "DepartmentID": 1,
  "DepartmentName": "sample string 4",
  "ProvinceID": 1,
  "ProvinceName": "sample string 5",
  "CountryID": 1,
  "CountryName": "sample string 6",
  "StreetNameAndNumber": "sample string 7",
  "Phones": "sample string 8",
  "Email": "sample string 9",
  "ApplicationDataSelected": {
    "AppID": "aeb435b1-7436-4678-aecd-821533c67547",
    "Name": "sample string 1",
    "SoftwareName": "sample string 2",
    "StreetNameAndNumber": "sample string 3",
    "CityName": "sample string 4",
    "Phone": "sample string 5",
    "Discount": 1.0,
    "DateFrom": "2025-08-02T19:20:19.0706054+00:00",
    "DateTo": "2025-08-02T19:20:19.0706054+00:00",
    "Status": "sample string 6",
    "RemainingDays": 7,
    "MonthlyAmount": 1.0,
    "MonthlyPayment": true,
    "HasEnabledCustomDomain": true,
    "BranchOfficeCount": 1,
    "TerminalsCount": 1,
    "Items": [
      {
        "ItemNumber": 1,
        "Description": "sample string 2",
        "UnitPrice": 1.0,
        "Quantity": 1.0,
        "TotalPrice": 1.0,
        "ByBranchOffice": true
      },
      {
        "ItemNumber": 1,
        "Description": "sample string 2",
        "UnitPrice": 1.0,
        "Quantity": 1.0,
        "TotalPrice": 1.0,
        "ByBranchOffice": true
      }
    ],
    "Settings": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ApplicationEnvironments": [
      {
        "ID": 1,
        "AppID": "e46bc2f8-151b-4ae4-8d74-95055b168541",
        "EnvironmentID": 1,
        "Name": "sample string 1",
        "Type": 0,
        "Url": "sample string 2",
        "LastUpdate": "2025-08-02T19:20:19.0706054+00:00"
      },
      {
        "ID": 1,
        "AppID": "e46bc2f8-151b-4ae4-8d74-95055b168541",
        "EnvironmentID": 1,
        "Name": "sample string 1",
        "Type": 0,
        "Url": "sample string 2",
        "LastUpdate": "2025-08-02T19:20:19.0706054+00:00"
      }
    ],
    "DisplayText": "sample string 2 - sample string 1",
    "TotalAmount": 2.0
  },
  "EnvironmentSelected": {
    "ID": 1,
    "SoftwareName": "sample string 1",
    "Name": "sample string 2",
    "Type": 0,
    "Url": "sample string 3"
  },
  "ID": 1
}

text/xml

Sample:
<ApplicationBranchOfficeData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data.Administrator">
  <ID xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">1</ID>
  <AppID>b078d886-44ad-4082-9e91-d20dd9acb5ff</AppID>
  <ApplicationDataSelected>
    <AppID>aeb435b1-7436-4678-aecd-821533c67547</AppID>
    <ApplicationEnvironments>
      <ApplicationEnvironmentData>
        <AppID>e46bc2f8-151b-4ae4-8d74-95055b168541</AppID>
        <EnvironmentID>1</EnvironmentID>
        <ID>1</ID>
        <LastUpdate>2025-08-02T19:20:19.0706054+00:00</LastUpdate>
        <Name>sample string 1</Name>
        <Type>PROD</Type>
        <Url>sample string 2</Url>
      </ApplicationEnvironmentData>
      <ApplicationEnvironmentData>
        <AppID>e46bc2f8-151b-4ae4-8d74-95055b168541</AppID>
        <EnvironmentID>1</EnvironmentID>
        <ID>1</ID>
        <LastUpdate>2025-08-02T19:20:19.0706054+00:00</LastUpdate>
        <Name>sample string 1</Name>
        <Type>PROD</Type>
        <Url>sample string 2</Url>
      </ApplicationEnvironmentData>
    </ApplicationEnvironments>
    <BranchOfficeCount>1</BranchOfficeCount>
    <CityName>sample string 4</CityName>
    <DateFrom>2025-08-02T19:20:19.0706054+00:00</DateFrom>
    <DateTo>2025-08-02T19:20:19.0706054+00:00</DateTo>
    <Discount>1</Discount>
    <HasEnabledCustomDomain>true</HasEnabledCustomDomain>
    <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/StackBase.Common.Data.License">
      <d3p1:LicenseItemData>
        <d3p1:ByBranchOffice>true</d3p1:ByBranchOffice>
        <d3p1:Description>sample string 2</d3p1:Description>
        <d3p1:ItemNumber>1</d3p1:ItemNumber>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:TotalPrice>1</d3p1:TotalPrice>
        <d3p1:UnitPrice>1</d3p1:UnitPrice>
      </d3p1:LicenseItemData>
      <d3p1:LicenseItemData>
        <d3p1:ByBranchOffice>true</d3p1:ByBranchOffice>
        <d3p1:Description>sample string 2</d3p1:Description>
        <d3p1:ItemNumber>1</d3p1:ItemNumber>
        <d3p1:Quantity>1</d3p1:Quantity>
        <d3p1:TotalPrice>1</d3p1:TotalPrice>
        <d3p1:UnitPrice>1</d3p1:UnitPrice>
      </d3p1:LicenseItemData>
    </Items>
    <MonthlyAmount>1</MonthlyAmount>
    <MonthlyPayment>true</MonthlyPayment>
    <Name>sample string 1</Name>
    <Phone>sample string 5</Phone>
    <RemainingDays>7</RemainingDays>
    <Settings xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Settings>
    <SoftwareName>sample string 2</SoftwareName>
    <Status>sample string 6</Status>
    <StreetNameAndNumber>sample string 3</StreetNameAndNumber>
    <TerminalsCount>1</TerminalsCount>
  </ApplicationDataSelected>
  <CityID>1</CityID>
  <CityName>sample string 3</CityName>
  <Code>sample string 1</Code>
  <CountryID>1</CountryID>
  <CountryName>sample string 6</CountryName>
  <DepartmentID>1</DepartmentID>
  <DepartmentName>sample string 4</DepartmentName>
  <Email>sample string 9</Email>
  <EnvironmentSelected>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <SoftwareName>sample string 1</SoftwareName>
    <Type>PROD</Type>
    <Url>sample string 3</Url>
  </EnvironmentSelected>
  <Name>sample string 2</Name>
  <Phones>sample string 8</Phones>
  <ProvinceID>1</ProvinceID>
  <ProvinceName>sample string 5</ProvinceName>
  <StreetNameAndNumber>sample string 7</StreetNameAndNumber>
</ApplicationBranchOfficeData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:
"sample string 1"

text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>