GET api/v1/SystemOwners?SystemOwnerId={SystemOwnerId}
Returns a single SystemOwnerViewModel if the API token has rights to view it
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SystemOwnerId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
SystemOwnerViewModel| Name | Description | Type | Additional 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
{
"SystemOwnerId": "0a4c4103-03ca-485b-8754-f0c3eae1a93f",
"Name": "sample string 2",
"CompanyId": "1ea5d1b0-d8e9-4fe8-a449-a73281a93d5c",
"CompanyName": "sample string 4",
"StreetAddress1": "sample string 5",
"StreetAddress2": "sample string 6",
"City": "sample string 7",
"RegionId": "e1802449-ee41-4c8b-a5c8-f81c434144ff",
"RegionName": "sample string 9",
"CountryId": "5ca8b9d0-fbff-428c-99c5-27deacbcc118",
"CountryName": "sample string 11",
"PostalCode": "sample string 12",
"Phone": "sample string 13",
"Deleted": true
}
application/xml, text/xml
<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>1ea5d1b0-d8e9-4fe8-a449-a73281a93d5c</CompanyId> <CompanyName>sample string 4</CompanyName> <CountryId>5ca8b9d0-fbff-428c-99c5-27deacbcc118</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>e1802449-ee41-4c8b-a5c8-f81c434144ff</RegionId> <RegionName>sample string 9</RegionName> <StreetAddress1>sample string 5</StreetAddress1> <StreetAddress2>sample string 6</StreetAddress2> <SystemOwnerId>0a4c4103-03ca-485b-8754-f0c3eae1a93f</SystemOwnerId> </SystemOwnerViewModel>