POST Api/ScheduleApi/Create

Request Information

URI Parameters

None.

Body Parameters

ScheduleDTO
NameDescriptionTypeAdditional information
Id

integer

None.
AgentId

integer

Required
ScheduleDate

date

Required

Data type: DateTime
Description

string

None.
Status

globally unique identifier

None.
VisitDetails

string

None.
DivisionId

globally unique identifier

Required
AssetId

globally unique identifier

None.
BuildingId

globally unique identifier

None.
SubBuildingId

globally unique identifier

None.
LocationId

globally unique identifier

None.
LevelId

globally unique identifier

None.
CategoryId

globally unique identifier

None.
SectorId

globally unique identifier

None.
SubSectorId

globally unique identifier

None.
CreatedBy

integer

None.
CreatedOn

date

None.
UpdatedBy

integer

None.
UpdatedOn

date

Data type: DateTime
IsActive

boolean

None.
IsDeleted

boolean

None.
Source

string

None.
CreatedByName

string

None.
UpdatedByName

string

None.
FirstName

string

None.
FirstNameOther

string

None.
AgentLastName

string

None.
AgentLastNameOther

string

None.
EnLocation

string

None.
ArLocation

string

None.
EnCategory

string

None.
ArCategory

string

None.
EnAsset

string

None.
ArAsset

string

None.
EnBuilding

string

None.
ArBuilding

string

None.
ArSubBuilding

string

None.
EnSubBuilding

string

None.
EnSectors

string

None.
ArSectors

string

None.
EnSubSectors

string

None.
ArSubSectors

string

None.
EnStatus

string

None.
ArStatus

string

None.
Notes

string

None.
VisitType

globally unique identifier

Required
RegularVisits

boolean

None.
RelatedTo

integer

None.
NoOfTrial

integer

None.
WorkflowStatus

globally unique identifier

None.
CheckListIds

Collection of integer

None.
IsCreatingMultipleCategorySchedule

boolean

None.
CategoryList

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "AgentId": 2,
  "ScheduleDate": "2025-09-14T08:16:48.0985191+04:00",
  "Description": "sample string 4",
  "Status": "3cbea645-f2c0-4997-a986-69657faa5fa7",
  "VisitDetails": "sample string 5",
  "DivisionId": "0d9f5eb0-6cfa-4c6f-8330-d8cdfbd8611a",
  "AssetId": "bf00cb63-6fe4-4165-a3f8-2a17b769c9e1",
  "BuildingId": "6e423c8b-be0c-48ff-904f-b57d5bf04b68",
  "SubBuildingId": "a3f4a1ca-5b39-4618-ad03-4afb2cd5cb3e",
  "LocationId": "c0feb6ba-8dae-48aa-948f-0992b23acfef",
  "LevelId": "318076a7-be13-49d2-8b5a-f834148aec1d",
  "CategoryId": "501af2c9-9ec7-4168-a38f-21070f4c0be4",
  "SectorId": "ba28f9b0-05bf-4111-949b-07cb9fac8d08",
  "SubSectorId": "a4544f33-00fd-41ad-8066-13e9a449d0ff",
  "CreatedBy": 6,
  "CreatedOn": "2025-09-14T08:16:48.0985191+04:00",
  "UpdatedBy": 1,
  "UpdatedOn": "2025-09-14T08:16:48.0985191+04:00",
  "IsActive": true,
  "IsDeleted": true,
  "Source": "sample string 10",
  "CreatedByName": "sample string 11",
  "UpdatedByName": "sample string 12",
  "FirstName": "sample string 13",
  "FirstNameOther": "sample string 14",
  "AgentLastName": "sample string 15",
  "AgentLastNameOther": "sample string 16",
  "EnLocation": "sample string 17",
  "ArLocation": "sample string 18",
  "EnCategory": "sample string 19",
  "ArCategory": "sample string 20",
  "EnAsset": "sample string 21",
  "ArAsset": "sample string 22",
  "EnBuilding": "sample string 23",
  "ArBuilding": "sample string 24",
  "ArSubBuilding": "sample string 25",
  "EnSubBuilding": "sample string 26",
  "EnSectors": "sample string 27",
  "ArSectors": "sample string 28",
  "EnSubSectors": "sample string 29",
  "ArSubSectors": "sample string 30",
  "EnStatus": "sample string 31",
  "ArStatus": "sample string 32",
  "Notes": "sample string 33",
  "VisitType": "51a33d3e-ad86-494c-b4fc-90bee0b62f86",
  "RegularVisits": true,
  "RelatedTo": 34,
  "NoOfTrial": 35,
  "WorkflowStatus": "286b4796-cf54-4e10-b0e8-6a1f2bd93fb3",
  "CheckListIds": [
    1,
    2
  ],
  "IsCreatingMultipleCategorySchedule": true,
  "CategoryList": [
    "a8f550bf-fb6c-4cc6-a812-06464221a321",
    "f1960bb6-844a-4fe2-b68d-ab741d335d1c"
  ]
}

text/html, multipart/form-data

Sample: 
{"Id":1,"AgentId":2,"ScheduleDate":"2025-09-14T08:16:48.0985191+04:00","Description":"sample string 4","Status":"3cbea645-f2c0-4997-a986-69657faa5fa7","VisitDetails":"sample string 5","DivisionId":"0d9f5eb0-6cfa-4c6f-8330-d8cdfbd8611a","AssetId":"bf00cb63-6fe4-4165-a3f8-2a17b769c9e1","BuildingId":"6e423c8b-be0c-48ff-904f-b57d5bf04b68","SubBuildingId":"a3f4a1ca-5b39-4618-ad03-4afb2cd5cb3e","LocationId":"c0feb6ba-8dae-48aa-948f-0992b23acfef","LevelId":"318076a7-be13-49d2-8b5a-f834148aec1d","CategoryId":"501af2c9-9ec7-4168-a38f-21070f4c0be4","SectorId":"ba28f9b0-05bf-4111-949b-07cb9fac8d08","SubSectorId":"a4544f33-00fd-41ad-8066-13e9a449d0ff","CreatedBy":6,"CreatedOn":"2025-09-14T08:16:48.0985191+04:00","UpdatedBy":1,"UpdatedOn":"2025-09-14T08:16:48.0985191+04:00","IsActive":true,"IsDeleted":true,"Source":"sample string 10","CreatedByName":"sample string 11","UpdatedByName":"sample string 12","FirstName":"sample string 13","FirstNameOther":"sample string 14","AgentLastName":"sample string 15","AgentLastNameOther":"sample string 16","EnLocation":"sample string 17","ArLocation":"sample string 18","EnCategory":"sample string 19","ArCategory":"sample string 20","EnAsset":"sample string 21","ArAsset":"sample string 22","EnBuilding":"sample string 23","ArBuilding":"sample string 24","ArSubBuilding":"sample string 25","EnSubBuilding":"sample string 26","EnSectors":"sample string 27","ArSectors":"sample string 28","EnSubSectors":"sample string 29","ArSubSectors":"sample string 30","EnStatus":"sample string 31","ArStatus":"sample string 32","Notes":"sample string 33","VisitType":"51a33d3e-ad86-494c-b4fc-90bee0b62f86","RegularVisits":true,"RelatedTo":34,"NoOfTrial":35,"WorkflowStatus":"286b4796-cf54-4e10-b0e8-6a1f2bd93fb3","CheckListIds":[1,2],"IsCreatingMultipleCategorySchedule":true,"CategoryList":["a8f550bf-fb6c-4cc6-a812-06464221a321","f1960bb6-844a-4fe2-b68d-ab741d335d1c"]}

application/xml, text/xml

Sample: 
<ScheduleDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSMChecklistFlow.DTO">
  <AgentId>2</AgentId>
  <AgentLastName>sample string 15</AgentLastName>
  <AgentLastNameOther>sample string 16</AgentLastNameOther>
  <ArAsset>sample string 22</ArAsset>
  <ArBuilding>sample string 24</ArBuilding>
  <ArCategory>sample string 20</ArCategory>
  <ArLocation>sample string 18</ArLocation>
  <ArSectors>sample string 28</ArSectors>
  <ArStatus>sample string 32</ArStatus>
  <ArSubBuilding>sample string 25</ArSubBuilding>
  <ArSubSectors>sample string 30</ArSubSectors>
  <AssetId>bf00cb63-6fe4-4165-a3f8-2a17b769c9e1</AssetId>
  <BuildingId>6e423c8b-be0c-48ff-904f-b57d5bf04b68</BuildingId>
  <CategoryId>501af2c9-9ec7-4168-a38f-21070f4c0be4</CategoryId>
  <CategoryList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>a8f550bf-fb6c-4cc6-a812-06464221a321</d2p1:guid>
    <d2p1:guid>f1960bb6-844a-4fe2-b68d-ab741d335d1c</d2p1:guid>
  </CategoryList>
  <CheckListIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CheckListIds>
  <CreatedBy>6</CreatedBy>
  <CreatedByName>sample string 11</CreatedByName>
  <CreatedOn>2025-09-14T08:16:48.0985191+04:00</CreatedOn>
  <Description>sample string 4</Description>
  <DivisionId>0d9f5eb0-6cfa-4c6f-8330-d8cdfbd8611a</DivisionId>
  <EnAsset>sample string 21</EnAsset>
  <EnBuilding>sample string 23</EnBuilding>
  <EnCategory>sample string 19</EnCategory>
  <EnLocation>sample string 17</EnLocation>
  <EnSectors>sample string 27</EnSectors>
  <EnStatus>sample string 31</EnStatus>
  <EnSubBuilding>sample string 26</EnSubBuilding>
  <EnSubSectors>sample string 29</EnSubSectors>
  <FirstName>sample string 13</FirstName>
  <FirstNameOther>sample string 14</FirstNameOther>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <IsCreatingMultipleCategorySchedule>true</IsCreatingMultipleCategorySchedule>
  <IsDeleted>true</IsDeleted>
  <LevelId>318076a7-be13-49d2-8b5a-f834148aec1d</LevelId>
  <LocationId>c0feb6ba-8dae-48aa-948f-0992b23acfef</LocationId>
  <NoOfTrial>35</NoOfTrial>
  <Notes>sample string 33</Notes>
  <RegularVisits>true</RegularVisits>
  <RelatedTo>34</RelatedTo>
  <ScheduleDate>2025-09-14T08:16:48.0985191+04:00</ScheduleDate>
  <SectorId>ba28f9b0-05bf-4111-949b-07cb9fac8d08</SectorId>
  <Source>sample string 10</Source>
  <Status>3cbea645-f2c0-4997-a986-69657faa5fa7</Status>
  <SubBuildingId>a3f4a1ca-5b39-4618-ad03-4afb2cd5cb3e</SubBuildingId>
  <SubSectorId>a4544f33-00fd-41ad-8066-13e9a449d0ff</SubSectorId>
  <UpdatedBy>1</UpdatedBy>
  <UpdatedByName>sample string 12</UpdatedByName>
  <UpdatedOn>2025-09-14T08:16:48.0985191+04:00</UpdatedOn>
  <VisitDetails>sample string 5</VisitDetails>
  <VisitType>51a33d3e-ad86-494c-b4fc-90bee0b62f86</VisitType>
  <WorkflowStatus>286b4796-cf54-4e10-b0e8-6a1f2bd93fb3</WorkflowStatus>
</ScheduleDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ScheduleDTO'.

Response Information

Resource Description

integer

Response Formats

application/json, text/json, text/html, multipart/form-data

Sample: 
1

application/xml, text/xml

Sample: 
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>