POST api/ServiceRequest/Capture
Flow of service is Schedule, Book In, Assign to Technician, Start Work (opt: Wait for parts or cyclist feedback), Complete work, final inspection(where update to bike gear happens) , waiting for collection, collect While in status Schedule, or book in, this function exposes the fields to capture reqeusts from the client and cycle shop
Request Information
URI Parameters
None.
Body Parameters
JobCardCaptureModelName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
DateCheckedIn | date |
None. |
|
DateRequiredBy | date |
None. |
|
PriceEstimate | decimal number |
None. |
|
Client_Notes | string |
None. |
|
InitialAssesment_Notes | string |
None. |
|
CheckList | Collection of JobCardChecklist |
None. |
Request Formats
application/json, text/json
{ "ID": 1, "DateCheckedIn": "2025-09-05T16:02:11.4362327+00:00", "DateRequiredBy": "2025-09-05T16:02:11.4362327+00:00", "PriceEstimate": 3.1, "Client_Notes": "sample string 4", "InitialAssesment_Notes": "sample string 5", "CheckList": [ { "ID": 1, "Description": "sample string 2", "ChecklistConfigID": 3, "GroupDescription": "sample string 4", "ServiceID": 5, "Initial_Note": "sample string 6", "Technician_Note": "sample string 7", "AttendTo": true }, { "ID": 1, "Description": "sample string 2", "ChecklistConfigID": 3, "GroupDescription": "sample string 4", "ServiceID": 5, "Initial_Note": "sample string 6", "Technician_Note": "sample string 7", "AttendTo": true } ] }
application/xml, text/xml
<JobCardCaptureModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Models.DTO"> <CheckList> <JobCardChecklist> <AttendTo>true</AttendTo> <ChecklistConfigID>3</ChecklistConfigID> <Description>sample string 2</Description> <GroupDescription>sample string 4</GroupDescription> <ID>1</ID> <Initial_Note>sample string 6</Initial_Note> <ServiceID>5</ServiceID> <Technician_Note>sample string 7</Technician_Note> </JobCardChecklist> <JobCardChecklist> <AttendTo>true</AttendTo> <ChecklistConfigID>3</ChecklistConfigID> <Description>sample string 2</Description> <GroupDescription>sample string 4</GroupDescription> <ID>1</ID> <Initial_Note>sample string 6</Initial_Note> <ServiceID>5</ServiceID> <Technician_Note>sample string 7</Technician_Note> </JobCardChecklist> </CheckList> <Client_Notes>sample string 4</Client_Notes> <DateCheckedIn>2025-09-05T16:02:11.4362327+00:00</DateCheckedIn> <DateRequiredBy>2025-09-05T16:02:11.4362327+00:00</DateRequiredBy> <ID>1</ID> <InitialAssesment_Notes>sample string 5</InitialAssesment_Notes> <PriceEstimate>3.1</PriceEstimate> </JobCardCaptureModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
JobCardModelName | Description | Type | Additional information |
---|---|---|---|
ID | integer |
None. |
|
JobCardNo | string |
None. |
|
PartnerID | integer |
None. |
|
PartnerDescription | string |
None. |
|
BikeID | integer |
None. |
|
BikeDescription | string |
None. |
|
HasServicePlan | boolean |
None. |
|
CyclistDescription | string |
None. |
|
CustomerGroup | string |
None. |
|
CyclistID | integer |
None. |
|
Name | string |
None. |
|
Surname | string |
None. |
|
PhoneNumber | string |
None. |
|
string |
None. |
||
DateOfBirth | date |
None. |
|
DateCheckedIn |
Date Scheduled |
date |
None. |
DateBookedIn |
Date bike was brought into the shop |
date |
None. |
DateRequiredBy | date |
None. |
|
DateStarted | date |
None. |
|
DateCompleted | date |
None. |
|
PriceEstimate | decimal number |
None. |
|
Client_Notes | string |
None. |
|
InitialAssesment_Notes | string |
None. |
|
Technician_Notes | string |
None. |
|
PostServiceInspection_Notes | string |
None. |
|
StatusID | integer |
None. |
|
StatusDescription | string |
None. |
|
TechnicianID | integer |
None. |
|
TechnicianDescription | string |
None. |
|
TypeID | integer |
None. |
|
TypeDescription | string |
None. |
|
Types | Collection of ServiceTypeModel |
None. |
|
Duration | integer |
None. |
|
SerialNo | string |
None. |
|
PaidWithStripe | boolean |
None. |
|
IsFitting | boolean |
None. |
|
PaidWithPOS | boolean |
None. |
|
HearAbout | string |
None. |
|
Collection | boolean |
None. |
|
DropOff | boolean |
None. |
|
Collected | boolean |
None. |
|
DroppedOff | boolean |
None. |
|
ContactDetails | string |
None. |
|
OriginalBookInDate | date |
None. |
|
DaysSinceOriginalDate | integer |
None. |
|
CouponCode | string |
None. |
|
ExternalVoucherCode | string |
None. |
|
BikeBay | string |
None. |
|
BikeIsHere | boolean |
None. |
|
GoalsOfFitSession | string |
None. |
|
BikeTypeID | integer |
None. |
|
BikeType | string |
None. |
|
CreatedBy | integer |
None. |
|
CreatedByName | string |
None. |
|
ComplaintFlagged | boolean |
None. |
|
ThirdPartyID | integer |
None. |
|
ThirdPartyIsResponsibleForPayment | boolean |
None. |
|
CheckList | Collection of JobCardChecklist |
None. |
Response Formats
application/json, text/json
{ "ID": 1, "JobCardNo": "sample string 2", "PartnerID": 3, "PartnerDescription": "sample string 4", "BikeID": 5, "BikeDescription": "sample string 6", "HasServicePlan": true, "CyclistDescription": "sample string 8", "CustomerGroup": "sample string 9", "CyclistID": 10, "Name": "sample string 11", "Surname": "sample string 12", "PhoneNumber": "sample string 13", "Email": "sample string 14", "DateOfBirth": "2025-09-05T16:02:11.4518266+00:00", "DateCheckedIn": "2025-09-05T16:02:11.4518266+00:00", "DateBookedIn": "2025-09-05T16:02:11.4518266+00:00", "DateRequiredBy": "2025-09-05T16:02:11.4518266+00:00", "DateStarted": "2025-09-05T16:02:11.4518266+00:00", "DateCompleted": "2025-09-05T16:02:11.4518266+00:00", "PriceEstimate": 15.1, "Client_Notes": "sample string 16", "InitialAssesment_Notes": "sample string 17", "Technician_Notes": "sample string 18", "PostServiceInspection_Notes": "sample string 19", "StatusID": 20, "StatusDescription": "sample string 21", "TechnicianID": 22, "TechnicianDescription": "sample string 23", "TypeID": 24, "TypeDescription": "sample string 25", "Types": [ { "ID": 1, "ServiceID": 2, "TypeID": 3, "TypeDescription": "sample string 4" }, { "ID": 1, "ServiceID": 2, "TypeID": 3, "TypeDescription": "sample string 4" } ], "Duration": 26, "SerialNo": "sample string 27", "PaidWithStripe": true, "IsFitting": true, "PaidWithPOS": true, "HearAbout": "sample string 31", "Collection": true, "DropOff": true, "Collected": true, "DroppedOff": true, "ContactDetails": "sample string 32", "OriginalBookInDate": "2025-09-05T16:02:11.4518266+00:00", "DaysSinceOriginalDate": 34, "CouponCode": "sample string 35", "ExternalVoucherCode": "sample string 36", "BikeBay": "sample string 37", "BikeIsHere": true, "GoalsOfFitSession": "sample string 39", "BikeTypeID": 40, "BikeType": "sample string 41", "CreatedBy": 42, "CreatedByName": "sample string 43", "ComplaintFlagged": true, "ThirdPartyID": 1, "ThirdPartyIsResponsibleForPayment": true, "CheckList": [ { "ID": 1, "Description": "sample string 2", "ChecklistConfigID": 3, "GroupDescription": "sample string 4", "ServiceID": 5, "Initial_Note": "sample string 6", "Technician_Note": "sample string 7", "AttendTo": true }, { "ID": 1, "Description": "sample string 2", "ChecklistConfigID": 3, "GroupDescription": "sample string 4", "ServiceID": 5, "Initial_Note": "sample string 6", "Technician_Note": "sample string 7", "AttendTo": true } ] }
application/xml, text/xml
<JobCardModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Models.DTO"> <BikeBay>sample string 37</BikeBay> <BikeDescription>sample string 6</BikeDescription> <BikeID>5</BikeID> <BikeIsHere>true</BikeIsHere> <BikeType>sample string 41</BikeType> <BikeTypeID>40</BikeTypeID> <CheckList> <JobCardChecklist> <AttendTo>true</AttendTo> <ChecklistConfigID>3</ChecklistConfigID> <Description>sample string 2</Description> <GroupDescription>sample string 4</GroupDescription> <ID>1</ID> <Initial_Note>sample string 6</Initial_Note> <ServiceID>5</ServiceID> <Technician_Note>sample string 7</Technician_Note> </JobCardChecklist> <JobCardChecklist> <AttendTo>true</AttendTo> <ChecklistConfigID>3</ChecklistConfigID> <Description>sample string 2</Description> <GroupDescription>sample string 4</GroupDescription> <ID>1</ID> <Initial_Note>sample string 6</Initial_Note> <ServiceID>5</ServiceID> <Technician_Note>sample string 7</Technician_Note> </JobCardChecklist> </CheckList> <Client_Notes>sample string 16</Client_Notes> <Collected>true</Collected> <Collection>true</Collection> <ComplaintFlagged>true</ComplaintFlagged> <ContactDetails>sample string 32</ContactDetails> <CouponCode>sample string 35</CouponCode> <CreatedBy>42</CreatedBy> <CreatedByName>sample string 43</CreatedByName> <CustomerGroup>sample string 9</CustomerGroup> <CyclistDescription>sample string 8</CyclistDescription> <CyclistID>10</CyclistID> <DateBookedIn>2025-09-05T16:02:11.4518266+00:00</DateBookedIn> <DateCheckedIn>2025-09-05T16:02:11.4518266+00:00</DateCheckedIn> <DateCompleted>2025-09-05T16:02:11.4518266+00:00</DateCompleted> <DateOfBirth>2025-09-05T16:02:11.4518266+00:00</DateOfBirth> <DateRequiredBy>2025-09-05T16:02:11.4518266+00:00</DateRequiredBy> <DateStarted>2025-09-05T16:02:11.4518266+00:00</DateStarted> <DaysSinceOriginalDate>34</DaysSinceOriginalDate> <DropOff>true</DropOff> <DroppedOff>true</DroppedOff> <Duration>26</Duration> <Email>sample string 14</Email> <ExternalVoucherCode>sample string 36</ExternalVoucherCode> <GoalsOfFitSession>sample string 39</GoalsOfFitSession> <HasServicePlan>true</HasServicePlan> <HearAbout>sample string 31</HearAbout> <ID>1</ID> <InitialAssesment_Notes>sample string 17</InitialAssesment_Notes> <IsFitting>true</IsFitting> <JobCardNo>sample string 2</JobCardNo> <Name>sample string 11</Name> <OriginalBookInDate>2025-09-05T16:02:11.4518266+00:00</OriginalBookInDate> <PaidWithPOS>true</PaidWithPOS> <PaidWithStripe>true</PaidWithStripe> <PartnerDescription>sample string 4</PartnerDescription> <PartnerID>3</PartnerID> <PhoneNumber>sample string 13</PhoneNumber> <PostServiceInspection_Notes>sample string 19</PostServiceInspection_Notes> <PriceEstimate>15.1</PriceEstimate> <SerialNo>sample string 27</SerialNo> <StatusDescription>sample string 21</StatusDescription> <StatusID>20</StatusID> <Surname>sample string 12</Surname> <TechnicianDescription>sample string 23</TechnicianDescription> <TechnicianID>22</TechnicianID> <Technician_Notes>sample string 18</Technician_Notes> <ThirdPartyID>1</ThirdPartyID> <ThirdPartyIsResponsibleForPayment>true</ThirdPartyIsResponsibleForPayment> <TypeDescription>sample string 25</TypeDescription> <TypeID>24</TypeID> <Types> <ServiceTypeModel> <ID>1</ID> <ServiceID>2</ServiceID> <TypeDescription>sample string 4</TypeDescription> <TypeID>3</TypeID> </ServiceTypeModel> <ServiceTypeModel> <ID>1</ID> <ServiceID>2</ServiceID> <TypeDescription>sample string 4</TypeDescription> <TypeID>3</TypeID> </ServiceTypeModel> </Types> </JobCardModel>