GET api/Client?selectedClientName={selectedClientName}&isCustomerId={isCustomerId}

Request Information

URI Parameters

Name	Description	Type	Additional information
selectedClientName		string	Required
isCustomerId		string	Required

Body Parameters

None.

Response Information

Resource Description

ClientViewModel

Name	Type	Additional information
Id	string	None.
UniqueId	globally unique identifier	None.
ClientName	string	None.
StatusId	integer	None.
ContactName	string	None.
Salutation	string	None.
Street	string	None.
Suburb	string	None.
City	string	None.
State	string	None.
Zip	string	None.
ReferredBy	string	None.
Phone	string	None.
Fax	string	None.
Mobile	string	None.
Email	string	None.
CompanyNumber	string	None.
ClientNote	string	None.
IsOwner	boolean	None.
Inactive	boolean	None.
Payment1Percent	integer	None.
Payment2Percent	integer	None.
Payment3Percent	integer	None.
Payment2Days	integer	None.
Terms2	integer	None.
Payment3Days	integer	None.
Terms3	integer	None.
Tag	string	None.
CriticalNote	string	None.
ShowCritical	boolean	None.
DefaultContactUid	globally unique identifier	None.
CustomerId	string	None.
Discount	decimal number	None.
BlobRelatedFiles	string	None.
SchedBorderClr	integer	None.
SchedFillClr	integer	None.
SchedTextClr	integer	None.
ContactId	integer	None.
ContactClientId	integer	None.
ContactClientName	string	None.
ContactContactName	string	None.
ContactSalutation	string	None.
ContactRole	string	None.
ContactPhone	string	None.
ContactFax	string	None.
ContactMobile	string	None.
ContactTag	string	None.
ContactEmail	string	None.
ContactContactNote	string	None.
ContactStatusId	integer	None.
ContactUserField	string	None.
IsDirty	boolean	None.
LaborMaterialsDirty	boolean	None.
ContactsLookup	Collection of LookupDto	None.
SharedCheckBox	CheckBoxDto	None.

Response Formats

application/json, text/json

Sample:

{
  "sharedCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "id": "sample string 1",
  "uniqueId": "02a373a1-46ab-4c24-a19b-8f255e79a1fb",
  "clientName": "sample string 2",
  "statusId": 3,
  "contactName": "sample string 4",
  "salutation": "sample string 5",
  "street": "sample string 6",
  "suburb": "sample string 7",
  "city": "sample string 8",
  "state": "sample string 9",
  "zip": "sample string 10",
  "referredBy": "sample string 11",
  "phone": "sample string 12",
  "fax": "sample string 13",
  "mobile": "sample string 14",
  "email": "sample string 15",
  "companyNumber": "sample string 16",
  "clientNote": "sample string 17",
  "isOwner": true,
  "inactive": true,
  "payment1Percent": 20,
  "payment2Percent": 21,
  "payment3Percent": 22,
  "payment2Days": 23,
  "terms2": 24,
  "payment3Days": 25,
  "terms3": 26,
  "tag": "sample string 27",
  "criticalNote": "sample string 28",
  "showCritical": true,
  "defaultContactUid": "291528b1-f376-4105-872a-c20d649dffe5",
  "customerId": "sample string 30",
  "discount": 31.0,
  "blobRelatedFiles": "sample string 32",
  "schedBorderClr": 33,
  "schedFillClr": 34,
  "schedTextClr": 35,
  "contactId": 36,
  "contactClientId": 37,
  "contactClientName": "sample string 38",
  "contactContactName": "sample string 39",
  "contactSalutation": "sample string 40",
  "contactRole": "sample string 41",
  "contactPhone": "sample string 42",
  "contactFax": "sample string 43",
  "contactMobile": "sample string 44",
  "contactTag": "sample string 45",
  "contactEmail": "sample string 46",
  "contactContactNote": "sample string 47",
  "contactStatusId": 1,
  "contactUserField": "sample string 48",
  "isDirty": true,
  "laborMaterialsDirty": true,
  "contactsLookup": [
    {
      "id": 1,
      "idString": "sample string 2",
      "name": "sample string 3",
      "parentId": "sample string 4",
      "description": "sample string 5",
      "selected": true,
      "sortIndex": 7,
      "uniqueId": "fe4a3775-f328-440e-adb0-667ea85294af",
      "parentUid": "0463ec1f-05d6-4daa-8f26-dc3fd5874ba8"
    },
    {
      "id": 1,
      "idString": "sample string 2",
      "name": "sample string 3",
      "parentId": "sample string 4",
      "description": "sample string 5",
      "selected": true,
      "sortIndex": 7,
      "uniqueId": "fe4a3775-f328-440e-adb0-667ea85294af",
      "parentUid": "0463ec1f-05d6-4daa-8f26-dc3fd5874ba8"
    }
  ]
}

application/xml, text/xml

Sample:

<ClientViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <BlobRelatedFiles>sample string 32</BlobRelatedFiles>
  <City>sample string 8</City>
  <ClientName>sample string 2</ClientName>
  <ClientNote>sample string 17</ClientNote>
  <CompanyNumber>sample string 16</CompanyNumber>
  <ContactClientId>37</ContactClientId>
  <ContactClientName>sample string 38</ContactClientName>
  <ContactContactName>sample string 39</ContactContactName>
  <ContactContactNote>sample string 47</ContactContactNote>
  <ContactEmail>sample string 46</ContactEmail>
  <ContactFax>sample string 43</ContactFax>
  <ContactId>36</ContactId>
  <ContactMobile>sample string 44</ContactMobile>
  <ContactName>sample string 4</ContactName>
  <ContactPhone>sample string 42</ContactPhone>
  <ContactRole>sample string 41</ContactRole>
  <ContactSalutation>sample string 40</ContactSalutation>
  <ContactStatusId>1</ContactStatusId>
  <ContactTag>sample string 45</ContactTag>
  <ContactUserField>sample string 48</ContactUserField>
  <ContactsLookup xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
    <d2p1:LookupDto>
      <d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
      <d2p1:_x003C_ParentUid_x003E_k__BackingField>0463ec1f-05d6-4daa-8f26-dc3fd5874ba8</d2p1:_x003C_ParentUid_x003E_k__BackingField>
      <d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
      <d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
      <d2p1:_x003C_UniqueId_x003E_k__BackingField>fe4a3775-f328-440e-adb0-667ea85294af</d2p1:_x003C_UniqueId_x003E_k__BackingField>
    </d2p1:LookupDto>
    <d2p1:LookupDto>
      <d2p1:_x003C_Description_x003E_k__BackingField>sample string 5</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d2p1:_x003C_IdString_x003E_k__BackingField>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 3</d2p1:_x003C_Name_x003E_k__BackingField>
      <d2p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d2p1:_x003C_ParentId_x003E_k__BackingField>
      <d2p1:_x003C_ParentUid_x003E_k__BackingField>0463ec1f-05d6-4daa-8f26-dc3fd5874ba8</d2p1:_x003C_ParentUid_x003E_k__BackingField>
      <d2p1:_x003C_Selected_x003E_k__BackingField>true</d2p1:_x003C_Selected_x003E_k__BackingField>
      <d2p1:_x003C_SortIndex_x003E_k__BackingField>7</d2p1:_x003C_SortIndex_x003E_k__BackingField>
      <d2p1:_x003C_UniqueId_x003E_k__BackingField>fe4a3775-f328-440e-adb0-667ea85294af</d2p1:_x003C_UniqueId_x003E_k__BackingField>
    </d2p1:LookupDto>
  </ContactsLookup>
  <CriticalNote>sample string 28</CriticalNote>
  <CustomerId>sample string 30</CustomerId>
  <DefaultContactUid>291528b1-f376-4105-872a-c20d649dffe5</DefaultContactUid>
  <Discount>31</Discount>
  <Email>sample string 15</Email>
  <Fax>sample string 13</Fax>
  <Id>sample string 1</Id>
  <Inactive>true</Inactive>
  <IsDirty>true</IsDirty>
  <IsOwner>true</IsOwner>
  <LaborMaterialsDirty>true</LaborMaterialsDirty>
  <Mobile>sample string 14</Mobile>
  <Payment1Percent>20</Payment1Percent>
  <Payment2Days>23</Payment2Days>
  <Payment2Percent>21</Payment2Percent>
  <Payment3Days>25</Payment3Days>
  <Payment3Percent>22</Payment3Percent>
  <Phone>sample string 12</Phone>
  <ReferredBy>sample string 11</ReferredBy>
  <Salutation>sample string 5</Salutation>
  <SchedBorderClr>33</SchedBorderClr>
  <SchedFillClr>34</SchedFillClr>
  <SchedTextClr>35</SchedTextClr>
  <SharedCheckBox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 4</d2p1:Caption>
    <d2p1:Checked>true</d2p1:Checked>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </SharedCheckBox>
  <ShowCritical>true</ShowCritical>
  <State>sample string 9</State>
  <StatusId>3</StatusId>
  <Street>sample string 6</Street>
  <Suburb>sample string 7</Suburb>
  <Tag>sample string 27</Tag>
  <Terms2>24</Terms2>
  <Terms3>26</Terms3>
  <UniqueId>02a373a1-46ab-4c24-a19b-8f255e79a1fb</UniqueId>
  <Zip>sample string 10</Zip>
</ClientViewModel>