POST Api/TaskBroadcastMessage

Request Information

URI Parameters

None.

Body Parameters

ReportParameter
NameDescriptionTypeAdditional information
PartnerID

globally unique identifier

None.
ClientID

globally unique identifier

None.
VehicleID

globally unique identifier

None.
FromDate

date

None.
ToDate

date

None.
SchoolID

globally unique identifier

None.
ClassID

globally unique identifier

None.
TripID

globally unique identifier

None.
StudentID

globally unique identifier

None.
Month

integer

None.
Year

integer

None.
AuditModule

integer

None.
DriverID

globally unique identifier

None.
EmployeeID

globally unique identifier

None.
UserID

globally unique identifier

None.
BusinessHourID

globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "PartnerID": "aad56249-f58f-4854-9208-77283bf7c16e",
  "ClientID": "459e484f-ad4d-4cc3-93ad-41d986472750",
  "VehicleID": "33b42dc7-7544-4f50-92d3-7473f1ea6242",
  "FromDate": "2025-05-20T21:10:07.86602+04:00",
  "ToDate": "2025-05-20T21:10:07.86602+04:00",
  "SchoolID": "ed4e4382-a047-45b0-bc77-63a4bb4a883e",
  "ClassID": "a09773db-d0d8-4f84-9966-85ca1c1673e7",
  "TripID": "c5faf6ca-6a67-43a7-b762-3c3e86c698a5",
  "StudentID": "26228151-d716-4122-a258-534a837d1b8f",
  "Month": 1,
  "Year": 1,
  "AuditModule": 8,
  "DriverID": "2696a0f2-b8ca-4d12-9e47-4c7d5bee0a64",
  "EmployeeID": "68445569-e42b-4d5f-a322-e75f0044bef1",
  "UserID": "2a765d63-932f-4f60-a20f-524e7b428d3c",
  "BusinessHourID": "3807da25-1d9f-4362-ba4b-29f05e95f235"
}

application/xml, text/xml

Sample: 
<ReportParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fleetroot.Entity.Reports">
  <AuditModule>8</AuditModule>
  <BusinessHourID>3807da25-1d9f-4362-ba4b-29f05e95f235</BusinessHourID>
  <ClassID>a09773db-d0d8-4f84-9966-85ca1c1673e7</ClassID>
  <ClientID>459e484f-ad4d-4cc3-93ad-41d986472750</ClientID>
  <DriverID>2696a0f2-b8ca-4d12-9e47-4c7d5bee0a64</DriverID>
  <EmployeeID>68445569-e42b-4d5f-a322-e75f0044bef1</EmployeeID>
  <FromDate>2025-05-20T21:10:07.86602+04:00</FromDate>
  <Month>1</Month>
  <PartnerID>aad56249-f58f-4854-9208-77283bf7c16e</PartnerID>
  <SchoolID>ed4e4382-a047-45b0-bc77-63a4bb4a883e</SchoolID>
  <StudentID>26228151-d716-4122-a258-534a837d1b8f</StudentID>
  <ToDate>2025-05-20T21:10:07.86602+04:00</ToDate>
  <TripID>c5faf6ca-6a67-43a7-b762-3c3e86c698a5</TripID>
  <UserID>2a765d63-932f-4f60-a20f-524e7b428d3c</UserID>
  <VehicleID>33b42dc7-7544-4f50-92d3-7473f1ea6242</VehicleID>
  <Year>1</Year>
</ReportParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of BroadcastMessages
NameDescriptionTypeAdditional information
Message

string

None.
BroadcastBy

string

None.
BroadcastOn

date

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Message": "sample string 1",
    "BroadcastBy": "sample string 2",
    "BroadcastOn": "2025-05-20T21:10:07.881644+04:00"
  },
  {
    "Message": "sample string 1",
    "BroadcastBy": "sample string 2",
    "BroadcastOn": "2025-05-20T21:10:07.881644+04:00"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfBroadcastMessages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FleetrootDriver.Service.Controllers">
  <BroadcastMessages>
    <BroadcastBy>sample string 2</BroadcastBy>
    <BroadcastOn>2025-05-20T21:10:07.881644+04:00</BroadcastOn>
    <Message>sample string 1</Message>
  </BroadcastMessages>
  <BroadcastMessages>
    <BroadcastBy>sample string 2</BroadcastBy>
    <BroadcastOn>2025-05-20T21:10:07.881644+04:00</BroadcastOn>
    <Message>sample string 1</Message>
  </BroadcastMessages>
</ArrayOfBroadcastMessages>