GET api/v1/SystemOwners?SystemOwnerId={SystemOwnerId}

Returns a single SystemOwnerViewModel if the API token has rights to view it

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SystemOwnerId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

SystemOwnerViewModel
NameDescriptionTypeAdditional information
SystemOwnerId

Represents the PK of the SystemOwner

globally unique identifier

None.

Name

Represents the name of the SystemOwner

string

None.

CompanyId

Represents the PK of the Company for the SystemOwner

globally unique identifier

None.

CompanyName

Represents the name of the Company for the SystemOwner

string

None.

StreetAddress1

Represents the primary street address of the SystemOwner

string

None.

StreetAddress2

Represents the secondary street address of the SystemOwner

string

None.

City

Represents the city of the SystemOwner

string

None.

RegionId

Represents the PK of the region (State, Province, County, etc) of the SystemOwner

globally unique identifier

None.

RegionName

Represents the name of the region (State, Province, County, etc) of the SystemOwner

string

None.

CountryId

Represents the PK of the country of the SystemOwner

globally unique identifier

None.

CountryName

Represents the name of the country of the SystemOwner

string

None.

PostalCode

Represents the Postal Code/Zip Code of the SystemOwner

string

None.

Phone

Represents the primary phone number of the SystemOwner

string

None.

Deleted

Represents the SystemOwner number used to refer to the SystemOwner (typically from an accounting package)

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SystemOwnerId": "5225c1e1-1e20-4104-84a4-30bf24029d51",
  "Name": "sample string 2",
  "CompanyId": "c5a4ce02-04ef-4c1b-85c6-ff6116c80dbd",
  "CompanyName": "sample string 4",
  "StreetAddress1": "sample string 5",
  "StreetAddress2": "sample string 6",
  "City": "sample string 7",
  "RegionId": "13e7b637-79ad-4bc1-825d-f8533f7ebe40",
  "RegionName": "sample string 9",
  "CountryId": "28a55b41-f86c-489d-b595-5fd37537222b",
  "CountryName": "sample string 11",
  "PostalCode": "sample string 12",
  "Phone": "sample string 13",
  "Deleted": true
}

application/xml, text/xml

Sample:
<SystemOwnerViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <City>sample string 7</City>
  <CompanyId>c5a4ce02-04ef-4c1b-85c6-ff6116c80dbd</CompanyId>
  <CompanyName>sample string 4</CompanyName>
  <CountryId>28a55b41-f86c-489d-b595-5fd37537222b</CountryId>
  <CountryName>sample string 11</CountryName>
  <Deleted>true</Deleted>
  <Name>sample string 2</Name>
  <Phone>sample string 13</Phone>
  <PostalCode>sample string 12</PostalCode>
  <RegionId>13e7b637-79ad-4bc1-825d-f8533f7ebe40</RegionId>
  <RegionName>sample string 9</RegionName>
  <StreetAddress1>sample string 5</StreetAddress1>
  <StreetAddress2>sample string 6</StreetAddress2>
  <SystemOwnerId>5225c1e1-1e20-4104-84a4-30bf24029d51</SystemOwnerId>
</SystemOwnerViewModel>