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
SystemOwnerViewModelName | 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": "df91f716-aee5-4bce-9ecb-5017177ba48d", "Name": "sample string 2", "CompanyId": "ecdfd659-858e-4c5f-be1f-acaf5e8e3bac", "CompanyName": "sample string 4", "StreetAddress1": "sample string 5", "StreetAddress2": "sample string 6", "City": "sample string 7", "RegionId": "65debb96-9edf-4865-a5c6-2dcf2fb85170", "RegionName": "sample string 9", "CountryId": "34c1206f-af0f-42bb-a80d-b3f255a8c5d0", "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>ecdfd659-858e-4c5f-be1f-acaf5e8e3bac</CompanyId> <CompanyName>sample string 4</CompanyName> <CountryId>34c1206f-af0f-42bb-a80d-b3f255a8c5d0</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>65debb96-9edf-4865-a5c6-2dcf2fb85170</RegionId> <RegionName>sample string 9</RegionName> <StreetAddress1>sample string 5</StreetAddress1> <StreetAddress2>sample string 6</StreetAddress2> <SystemOwnerId>df91f716-aee5-4bce-9ecb-5017177ba48d</SystemOwnerId> </SystemOwnerViewModel>