GET api/servicecompany/{id}/{option}

Returns a set of Service Company records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCode' - service company record where id = ServiceCompanyCode,

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	Required
option		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ServiceCompany

Name	Description	Type	Additional information
ServiceCompanyId	Sedona internal autonumber for the Service Company record	integer	None.
ServiceCompanyCode	Abbreviated Service Company Code	string	String length: inclusive between 0 and 25
Description	Full description of Service Company	string	String length: inclusive between 0 and 50
Inactive		boolean	None.
TicketForm		string	String length: inclusive between 0 and 50
InspUseSvc		boolean	None.
Address1		string	String length: inclusive between 0 and 30
GETable1Id		integer	None.
GETable2Id		integer	None.
GETable3Id		integer	None.
CountryId		integer	None.
Address2		string	String length: inclusive between 0 and 30
Address3		string	String length: inclusive between 0 and 30
GETable4Id		integer	None.
GETable5Id		integer	None.
ZipCodePlus4		string	String length: inclusive between 0 and 10
VendorId		integer	None.
VendorWarehouseId		integer	None.
RegularDayStart		integer	None.
RegularDayEnd		integer	None.
RegularHourStart		string	None.
RegularHourEnd		string	None.
AppointmentInterval		integer	None.
CategoryId		integer	None.
COGSId		integer	None.
ExpenseInventory		boolean	None.
ExpenseAtInvoice		boolean	None.
LaborToGL		boolean	None.
LaborType		boolean	None.
LaborExpenseId		integer	None.
LaborWIPId		integer	None.
LaborDeferredId		integer	None.
HourlyCost		decimal number	None.
Expires		string	None.
Message		string	String length: inclusive between 0 and 255
UserName		string	String length: inclusive between 0 and 30
Timestamp		string	None.
Email		string	String length: inclusive between 0 and 50
PrimaryCompany		boolean	None.
SecondaryCompany		boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ServiceCompanyId": 1,
    "ServiceCompanyCode": "sample string 2",
    "Description": "sample string 3",
    "Inactive": true,
    "TicketForm": "sample string 5",
    "InspUseSvc": true,
    "Address1": "sample string 7",
    "GETable1Id": 8,
    "GETable2Id": 9,
    "GETable3Id": 10,
    "CountryId": 11,
    "Address2": "sample string 12",
    "Address3": "sample string 13",
    "GETable4Id": 14,
    "GETable5Id": 15,
    "ZipCodePlus4": "sample string 16",
    "VendorId": 17,
    "VendorWarehouseId": 18,
    "RegularDayStart": 19,
    "RegularDayEnd": 20,
    "RegularHourStart": "sample string 21",
    "RegularHourEnd": "sample string 22",
    "AppointmentInterval": 23,
    "CategoryId": 24,
    "COGSId": 25,
    "ExpenseInventory": true,
    "ExpenseAtInvoice": true,
    "LaborToGL": true,
    "LaborType": true,
    "LaborExpenseId": 30,
    "LaborWIPId": 31,
    "LaborDeferredId": 32,
    "HourlyCost": 33.0,
    "Expires": "sample string 34",
    "Message": "sample string 35",
    "UserName": "sample string 36",
    "Timestamp": "sample string 37",
    "Email": "sample string 38",
    "PrimaryCompany": true,
    "SecondaryCompany": true
  },
  {
    "ServiceCompanyId": 1,
    "ServiceCompanyCode": "sample string 2",
    "Description": "sample string 3",
    "Inactive": true,
    "TicketForm": "sample string 5",
    "InspUseSvc": true,
    "Address1": "sample string 7",
    "GETable1Id": 8,
    "GETable2Id": 9,
    "GETable3Id": 10,
    "CountryId": 11,
    "Address2": "sample string 12",
    "Address3": "sample string 13",
    "GETable4Id": 14,
    "GETable5Id": 15,
    "ZipCodePlus4": "sample string 16",
    "VendorId": 17,
    "VendorWarehouseId": 18,
    "RegularDayStart": 19,
    "RegularDayEnd": 20,
    "RegularHourStart": "sample string 21",
    "RegularHourEnd": "sample string 22",
    "AppointmentInterval": 23,
    "CategoryId": 24,
    "COGSId": 25,
    "ExpenseInventory": true,
    "ExpenseAtInvoice": true,
    "LaborToGL": true,
    "LaborType": true,
    "LaborExpenseId": 30,
    "LaborWIPId": 31,
    "LaborDeferredId": 32,
    "HourlyCost": 33.0,
    "Expires": "sample string 34",
    "Message": "sample string 35",
    "UserName": "sample string 36",
    "Timestamp": "sample string 37",
    "Email": "sample string 38",
    "PrimaryCompany": true,
    "SecondaryCompany": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfServiceCompany xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <ServiceCompany>
    <Address1>sample string 7</Address1>
    <Address2>sample string 12</Address2>
    <Address3>sample string 13</Address3>
    <AppointmentInterval>23</AppointmentInterval>
    <COGSId>25</COGSId>
    <CategoryId>24</CategoryId>
    <CountryId>11</CountryId>
    <Description>sample string 3</Description>
    <Email>sample string 38</Email>
    <ExpenseAtInvoice>true</ExpenseAtInvoice>
    <ExpenseInventory>true</ExpenseInventory>
    <Expires>sample string 34</Expires>
    <GETable1Id>8</GETable1Id>
    <GETable2Id>9</GETable2Id>
    <GETable3Id>10</GETable3Id>
    <GETable4Id>14</GETable4Id>
    <GETable5Id>15</GETable5Id>
    <HourlyCost>33</HourlyCost>
    <Inactive>true</Inactive>
    <InspUseSvc>true</InspUseSvc>
    <LaborDeferredId>32</LaborDeferredId>
    <LaborExpenseId>30</LaborExpenseId>
    <LaborToGL>true</LaborToGL>
    <LaborType>true</LaborType>
    <LaborWIPId>31</LaborWIPId>
    <Message>sample string 35</Message>
    <PrimaryCompany>true</PrimaryCompany>
    <RegularDayEnd>20</RegularDayEnd>
    <RegularDayStart>19</RegularDayStart>
    <RegularHourEnd>sample string 22</RegularHourEnd>
    <RegularHourStart>sample string 21</RegularHourStart>
    <SecondaryCompany>true</SecondaryCompany>
    <ServiceCompanyCode>sample string 2</ServiceCompanyCode>
    <ServiceCompanyId>1</ServiceCompanyId>
    <TicketForm>sample string 5</TicketForm>
    <Timestamp>sample string 37</Timestamp>
    <UserName>sample string 36</UserName>
    <VendorId>17</VendorId>
    <VendorWarehouseId>18</VendorWarehouseId>
    <ZipCodePlus4>sample string 16</ZipCodePlus4>
  </ServiceCompany>
  <ServiceCompany>
    <Address1>sample string 7</Address1>
    <Address2>sample string 12</Address2>
    <Address3>sample string 13</Address3>
    <AppointmentInterval>23</AppointmentInterval>
    <COGSId>25</COGSId>
    <CategoryId>24</CategoryId>
    <CountryId>11</CountryId>
    <Description>sample string 3</Description>
    <Email>sample string 38</Email>
    <ExpenseAtInvoice>true</ExpenseAtInvoice>
    <ExpenseInventory>true</ExpenseInventory>
    <Expires>sample string 34</Expires>
    <GETable1Id>8</GETable1Id>
    <GETable2Id>9</GETable2Id>
    <GETable3Id>10</GETable3Id>
    <GETable4Id>14</GETable4Id>
    <GETable5Id>15</GETable5Id>
    <HourlyCost>33</HourlyCost>
    <Inactive>true</Inactive>
    <InspUseSvc>true</InspUseSvc>
    <LaborDeferredId>32</LaborDeferredId>
    <LaborExpenseId>30</LaborExpenseId>
    <LaborToGL>true</LaborToGL>
    <LaborType>true</LaborType>
    <LaborWIPId>31</LaborWIPId>
    <Message>sample string 35</Message>
    <PrimaryCompany>true</PrimaryCompany>
    <RegularDayEnd>20</RegularDayEnd>
    <RegularDayStart>19</RegularDayStart>
    <RegularHourEnd>sample string 22</RegularHourEnd>
    <RegularHourStart>sample string 21</RegularHourStart>
    <SecondaryCompany>true</SecondaryCompany>
    <ServiceCompanyCode>sample string 2</ServiceCompanyCode>
    <ServiceCompanyId>1</ServiceCompanyId>
    <TicketForm>sample string 5</TicketForm>
    <Timestamp>sample string 37</Timestamp>
    <UserName>sample string 36</UserName>
    <VendorId>17</VendorId>
    <VendorWarehouseId>18</VendorWarehouseId>
    <ZipCodePlus4>sample string 16</ZipCodePlus4>
  </ServiceCompany>
</ArrayOfServiceCompany>