POST api/Partner/v3/ScheduleService?SendCommunication={SendCommunication}

Request Information

URI Parameters

Name	Description	Type	Additional information
SendCommunication		boolean	Default value is True

Body Parameters

PartnerScheduleServiceModel

Name	Description	Type	Additional information
ID	PartnerID	integer	None.
BikeID		integer	None.
ServiceTypeID		integer	None.
ServiceTypes		Collection of integer	None.
ServiceDate		date	None.
RequiredByDate		date	None.
PleaseBookIn		boolean	None.
NewJobcardID		integer	None.
Notes		string	None.
TechnicianID		integer	None.
isBikeHere		boolean	None.
CouponCode		string	None.
ExternalVoucherCode		string	None.
BikeBay		string	None.
PreServiceChecklist		Collection of PreServiceChecklist	None.
IsCollection		boolean	None.
IsDelivery		boolean	None.
CollectionInfo		CollectionInfo	None.
DeliveryInfo		CollectionInfo	None.
CreatedBy		integer	None.
PreApprovedAmount		decimal number	None.
ConsentForMarketing		boolean	None.
SelectedThirdParty		integer	None.
SelectedThirdPartyIsResponsibileForPayment		boolean	None.
ServiceTypeQuestions		Collection of ServiceTypeQuestions	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "BikeID": 2,
  "ServiceTypeID": 3,
  "ServiceTypes": [
    1,
    2
  ],
  "ServiceDate": "2025-09-05T16:03:41.4213047+00:00",
  "RequiredByDate": "2025-09-05T16:03:41.4213047+00:00",
  "PleaseBookIn": true,
  "NewJobcardID": 6,
  "Notes": "sample string 7",
  "TechnicianID": 8,
  "isBikeHere": true,
  "CouponCode": "sample string 10",
  "ExternalVoucherCode": "sample string 11",
  "BikeBay": "sample string 12",
  "PreServiceChecklist": [
    {
      "ID": 1,
      "ControlType": "sample string 2",
      "DefaultValue": "sample string 3",
      "FrontValue": "sample string 4",
      "RearValue": "sample string 5"
    },
    {
      "ID": 1,
      "ControlType": "sample string 2",
      "DefaultValue": "sample string 3",
      "FrontValue": "sample string 4",
      "RearValue": "sample string 5"
    }
  ],
  "IsCollection": true,
  "IsDelivery": true,
  "CollectionInfo": {
    "ScheduleDate": "sample string 1",
    "FullAddress": "sample string 2",
    "Notes": "sample string 3",
    "AddressDetails": {
      "street_no": "sample string 1",
      "street_address": "sample string 2",
      "city": "sample string 3",
      "country": "sample string 4",
      "postal_code": "sample string 5",
      "latitude": 6.1,
      "longitude": 7.1
    },
    "TimeSlot": {
      "deliveryVehicleID": 1,
      "slotStartTime": "sample string 2",
      "slotEndTime": "sample string 3"
    },
    "CollectionFee": [
      {
        "ProductID": 1
      },
      {
        "ProductID": 1
      }
    ],
    "DeliveryFee": [
      {
        "ProductID": 1
      },
      {
        "ProductID": 1
      }
    ]
  },
  "DeliveryInfo": {
    "ScheduleDate": "sample string 1",
    "FullAddress": "sample string 2",
    "Notes": "sample string 3",
    "AddressDetails": {
      "street_no": "sample string 1",
      "street_address": "sample string 2",
      "city": "sample string 3",
      "country": "sample string 4",
      "postal_code": "sample string 5",
      "latitude": 6.1,
      "longitude": 7.1
    },
    "TimeSlot": {
      "deliveryVehicleID": 1,
      "slotStartTime": "sample string 2",
      "slotEndTime": "sample string 3"
    },
    "CollectionFee": [
      {
        "ProductID": 1
      },
      {
        "ProductID": 1
      }
    ],
    "DeliveryFee": [
      {
        "ProductID": 1
      },
      {
        "ProductID": 1
      }
    ]
  },
  "CreatedBy": 1,
  "PreApprovedAmount": 15.1,
  "ConsentForMarketing": true,
  "SelectedThirdParty": 1,
  "SelectedThirdPartyIsResponsibileForPayment": true,
  "ServiceTypeQuestions": [
    {
      "GroupName": "sample string 1",
      "ServiceTypeID": 2,
      "ServiceType": "sample string 3",
      "CustomQuestions": [
        {
          "CustomQuestionID": 1,
          "Question": "sample string 2",
          "Hint": "sample string 3",
          "ControlType": "sample string 4",
          "Mandatory": true,
          "Response": "sample string 6"
        },
        {
          "CustomQuestionID": 1,
          "Question": "sample string 2",
          "Hint": "sample string 3",
          "ControlType": "sample string 4",
          "Mandatory": true,
          "Response": "sample string 6"
        }
      ]
    },
    {
      "GroupName": "sample string 1",
      "ServiceTypeID": 2,
      "ServiceType": "sample string 3",
      "CustomQuestions": [
        {
          "CustomQuestionID": 1,
          "Question": "sample string 2",
          "Hint": "sample string 3",
          "ControlType": "sample string 4",
          "Mandatory": true,
          "Response": "sample string 6"
        },
        {
          "CustomQuestionID": 1,
          "Question": "sample string 2",
          "Hint": "sample string 3",
          "ControlType": "sample string 4",
          "Mandatory": true,
          "Response": "sample string 6"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<PartnerScheduleServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hub.Server.Models.DTO">
  <BikeBay>sample string 12</BikeBay>
  <BikeID>2</BikeID>
  <CollectionInfo>
    <AddressDetails>
      <city>sample string 3</city>
      <country>sample string 4</country>
      <latitude>6.1</latitude>
      <longitude>7.1</longitude>
      <postal_code>sample string 5</postal_code>
      <street_address>sample string 2</street_address>
      <street_no>sample string 1</street_no>
    </AddressDetails>
    <CollectionFee>
      <Fee>
        <ProductID>1</ProductID>
      </Fee>
      <Fee>
        <ProductID>1</ProductID>
      </Fee>
    </CollectionFee>
    <DeliveryFee>
      <Fee>
        <ProductID>1</ProductID>
      </Fee>
      <Fee>
        <ProductID>1</ProductID>
      </Fee>
    </DeliveryFee>
    <FullAddress>sample string 2</FullAddress>
    <Notes>sample string 3</Notes>
    <ScheduleDate>sample string 1</ScheduleDate>
    <TimeSlot>
      <deliveryVehicleID>1</deliveryVehicleID>
      <slotEndTime>sample string 3</slotEndTime>
      <slotStartTime>sample string 2</slotStartTime>
    </TimeSlot>
  </CollectionInfo>
  <ConsentForMarketing>true</ConsentForMarketing>
  <CouponCode>sample string 10</CouponCode>
  <CreatedBy>1</CreatedBy>
  <DeliveryInfo>
    <AddressDetails>
      <city>sample string 3</city>
      <country>sample string 4</country>
      <latitude>6.1</latitude>
      <longitude>7.1</longitude>
      <postal_code>sample string 5</postal_code>
      <street_address>sample string 2</street_address>
      <street_no>sample string 1</street_no>
    </AddressDetails>
    <CollectionFee>
      <Fee>
        <ProductID>1</ProductID>
      </Fee>
      <Fee>
        <ProductID>1</ProductID>
      </Fee>
    </CollectionFee>
    <DeliveryFee>
      <Fee>
        <ProductID>1</ProductID>
      </Fee>
      <Fee>
        <ProductID>1</ProductID>
      </Fee>
    </DeliveryFee>
    <FullAddress>sample string 2</FullAddress>
    <Notes>sample string 3</Notes>
    <ScheduleDate>sample string 1</ScheduleDate>
    <TimeSlot>
      <deliveryVehicleID>1</deliveryVehicleID>
      <slotEndTime>sample string 3</slotEndTime>
      <slotStartTime>sample string 2</slotStartTime>
    </TimeSlot>
  </DeliveryInfo>
  <ExternalVoucherCode>sample string 11</ExternalVoucherCode>
  <ID>1</ID>
  <IsCollection>true</IsCollection>
  <IsDelivery>true</IsDelivery>
  <NewJobcardID>6</NewJobcardID>
  <Notes>sample string 7</Notes>
  <PleaseBookIn>true</PleaseBookIn>
  <PreApprovedAmount>15.1</PreApprovedAmount>
  <PreServiceChecklist xmlns:d2p1="http://schemas.datacontract.org/2004/07/Hub.Server.Business.Models">
    <d2p1:PreServiceChecklist>
      <d2p1:ControlType>sample string 2</d2p1:ControlType>
      <d2p1:DefaultValue>sample string 3</d2p1:DefaultValue>
      <d2p1:FrontValue>sample string 4</d2p1:FrontValue>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:RearValue>sample string 5</d2p1:RearValue>
    </d2p1:PreServiceChecklist>
    <d2p1:PreServiceChecklist>
      <d2p1:ControlType>sample string 2</d2p1:ControlType>
      <d2p1:DefaultValue>sample string 3</d2p1:DefaultValue>
      <d2p1:FrontValue>sample string 4</d2p1:FrontValue>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:RearValue>sample string 5</d2p1:RearValue>
    </d2p1:PreServiceChecklist>
  </PreServiceChecklist>
  <RequiredByDate>2025-09-05T16:03:41.4213047+00:00</RequiredByDate>
  <SelectedThirdParty>1</SelectedThirdParty>
  <SelectedThirdPartyIsResponsibileForPayment>true</SelectedThirdPartyIsResponsibileForPayment>
  <ServiceDate>2025-09-05T16:03:41.4213047+00:00</ServiceDate>
  <ServiceTypeID>3</ServiceTypeID>
  <ServiceTypeQuestions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Hub.Server.Business.Models">
    <d2p1:ServiceTypeQuestions>
      <d2p1:CustomQuestions>
        <d2p1:CustomQuestion>
          <d2p1:ControlType>sample string 4</d2p1:ControlType>
          <d2p1:CustomQuestionID>1</d2p1:CustomQuestionID>
          <d2p1:Hint>sample string 3</d2p1:Hint>
          <d2p1:Mandatory>true</d2p1:Mandatory>
          <d2p1:Question>sample string 2</d2p1:Question>
          <d2p1:Response>sample string 6</d2p1:Response>
        </d2p1:CustomQuestion>
        <d2p1:CustomQuestion>
          <d2p1:ControlType>sample string 4</d2p1:ControlType>
          <d2p1:CustomQuestionID>1</d2p1:CustomQuestionID>
          <d2p1:Hint>sample string 3</d2p1:Hint>
          <d2p1:Mandatory>true</d2p1:Mandatory>
          <d2p1:Question>sample string 2</d2p1:Question>
          <d2p1:Response>sample string 6</d2p1:Response>
        </d2p1:CustomQuestion>
      </d2p1:CustomQuestions>
      <d2p1:GroupName>sample string 1</d2p1:GroupName>
      <d2p1:ServiceType>sample string 3</d2p1:ServiceType>
      <d2p1:ServiceTypeID>2</d2p1:ServiceTypeID>
    </d2p1:ServiceTypeQuestions>
    <d2p1:ServiceTypeQuestions>
      <d2p1:CustomQuestions>
        <d2p1:CustomQuestion>
          <d2p1:ControlType>sample string 4</d2p1:ControlType>
          <d2p1:CustomQuestionID>1</d2p1:CustomQuestionID>
          <d2p1:Hint>sample string 3</d2p1:Hint>
          <d2p1:Mandatory>true</d2p1:Mandatory>
          <d2p1:Question>sample string 2</d2p1:Question>
          <d2p1:Response>sample string 6</d2p1:Response>
        </d2p1:CustomQuestion>
        <d2p1:CustomQuestion>
          <d2p1:ControlType>sample string 4</d2p1:ControlType>
          <d2p1:CustomQuestionID>1</d2p1:CustomQuestionID>
          <d2p1:Hint>sample string 3</d2p1:Hint>
          <d2p1:Mandatory>true</d2p1:Mandatory>
          <d2p1:Question>sample string 2</d2p1:Question>
          <d2p1:Response>sample string 6</d2p1:Response>
        </d2p1:CustomQuestion>
      </d2p1:CustomQuestions>
      <d2p1:GroupName>sample string 1</d2p1:GroupName>
      <d2p1:ServiceType>sample string 3</d2p1:ServiceType>
      <d2p1:ServiceTypeID>2</d2p1:ServiceTypeID>
    </d2p1:ServiceTypeQuestions>
  </ServiceTypeQuestions>
  <ServiceTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ServiceTypes>
  <TechnicianID>8</TechnicianID>
  <isBikeHere>true</isBikeHere>
</PartnerScheduleServiceModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JobCardModel

Name	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.
Email		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

Sample:

{
  "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:03:41.4837965+00:00",
  "DateCheckedIn": "2025-09-05T16:03:41.4837965+00:00",
  "DateBookedIn": "2025-09-05T16:03:41.4837965+00:00",
  "DateRequiredBy": "2025-09-05T16:03:41.4837965+00:00",
  "DateStarted": "2025-09-05T16:03:41.4837965+00:00",
  "DateCompleted": "2025-09-05T16:03:41.4837965+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:03:41.4837965+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

Sample:

<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:03:41.4837965+00:00</DateBookedIn>
  <DateCheckedIn>2025-09-05T16:03:41.4837965+00:00</DateCheckedIn>
  <DateCompleted>2025-09-05T16:03:41.4837965+00:00</DateCompleted>
  <DateOfBirth>2025-09-05T16:03:41.4837965+00:00</DateOfBirth>
  <DateRequiredBy>2025-09-05T16:03:41.4837965+00:00</DateRequiredBy>
  <DateStarted>2025-09-05T16:03:41.4837965+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:03:41.4837965+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>