GET Api/ScheduleApi/GetById?id={id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

ScheduleDTO

Name	Type	Additional 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.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "AgentId": 2,
  "ScheduleDate": "2025-05-25T20:10:07.3200626+04:00",
  "Description": "sample string 4",
  "Status": "a16ae8b1-c58e-4441-b9f6-2cdcd25298a0",
  "VisitDetails": "sample string 5",
  "DivisionId": "f7406a64-64b9-491b-9681-da539e8a875f",
  "AssetId": "cc763827-9219-408a-9715-981fc2949f0a",
  "BuildingId": "8cbb7ed1-586b-45ac-a4a3-109bb42dc941",
  "SubBuildingId": "1034f59f-69c3-4bbb-bcc1-0604706b6f1d",
  "LocationId": "fa96b396-8068-4df9-ab5b-0691b1c98f31",
  "LevelId": "79e4aeed-bf19-4f8c-8393-f70a4cf7c5dd",
  "CategoryId": "587e72e7-f6fe-40cf-8811-3447343ce80a",
  "SectorId": "80a876fd-310c-419c-ac92-3520c1fb6618",
  "SubSectorId": "7a592324-33d0-42cf-b090-4d87a394f48f",
  "CreatedBy": 6,
  "CreatedOn": "2025-05-25T20:10:07.3200626+04:00",
  "UpdatedBy": 1,
  "UpdatedOn": "2025-05-25T20:10:07.3200626+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": "9f577608-2bb1-445b-885f-9637565b7215",
  "RegularVisits": true,
  "RelatedTo": 34,
  "NoOfTrial": 35,
  "WorkflowStatus": "e0917ae4-0df8-4bde-9db5-2fea30f6c090",
  "CheckListIds": [
    1,
    2
  ],
  "IsCreatingMultipleCategorySchedule": true,
  "CategoryList": [
    "650f1939-e712-49c9-97e1-d441d4ba1830",
    "4be40137-12dc-472a-a81e-1accbca2f71e"
  ]
}

text/html, multipart/form-data

Sample:

{"Id":1,"AgentId":2,"ScheduleDate":"2025-05-25T20:10:07.3200626+04:00","Description":"sample string 4","Status":"a16ae8b1-c58e-4441-b9f6-2cdcd25298a0","VisitDetails":"sample string 5","DivisionId":"f7406a64-64b9-491b-9681-da539e8a875f","AssetId":"cc763827-9219-408a-9715-981fc2949f0a","BuildingId":"8cbb7ed1-586b-45ac-a4a3-109bb42dc941","SubBuildingId":"1034f59f-69c3-4bbb-bcc1-0604706b6f1d","LocationId":"fa96b396-8068-4df9-ab5b-0691b1c98f31","LevelId":"79e4aeed-bf19-4f8c-8393-f70a4cf7c5dd","CategoryId":"587e72e7-f6fe-40cf-8811-3447343ce80a","SectorId":"80a876fd-310c-419c-ac92-3520c1fb6618","SubSectorId":"7a592324-33d0-42cf-b090-4d87a394f48f","CreatedBy":6,"CreatedOn":"2025-05-25T20:10:07.3200626+04:00","UpdatedBy":1,"UpdatedOn":"2025-05-25T20:10:07.3200626+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":"9f577608-2bb1-445b-885f-9637565b7215","RegularVisits":true,"RelatedTo":34,"NoOfTrial":35,"WorkflowStatus":"e0917ae4-0df8-4bde-9db5-2fea30f6c090","CheckListIds":[1,2],"IsCreatingMultipleCategorySchedule":true,"CategoryList":["650f1939-e712-49c9-97e1-d441d4ba1830","4be40137-12dc-472a-a81e-1accbca2f71e"]}

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>cc763827-9219-408a-9715-981fc2949f0a</AssetId>
  <BuildingId>8cbb7ed1-586b-45ac-a4a3-109bb42dc941</BuildingId>
  <CategoryId>587e72e7-f6fe-40cf-8811-3447343ce80a</CategoryId>
  <CategoryList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>650f1939-e712-49c9-97e1-d441d4ba1830</d2p1:guid>
    <d2p1:guid>4be40137-12dc-472a-a81e-1accbca2f71e</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-05-25T20:10:07.3200626+04:00</CreatedOn>
  <Description>sample string 4</Description>
  <DivisionId>f7406a64-64b9-491b-9681-da539e8a875f</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>79e4aeed-bf19-4f8c-8393-f70a4cf7c5dd</LevelId>
  <LocationId>fa96b396-8068-4df9-ab5b-0691b1c98f31</LocationId>
  <NoOfTrial>35</NoOfTrial>
  <Notes>sample string 33</Notes>
  <RegularVisits>true</RegularVisits>
  <RelatedTo>34</RelatedTo>
  <ScheduleDate>2025-05-25T20:10:07.3200626+04:00</ScheduleDate>
  <SectorId>80a876fd-310c-419c-ac92-3520c1fb6618</SectorId>
  <Source>sample string 10</Source>
  <Status>a16ae8b1-c58e-4441-b9f6-2cdcd25298a0</Status>
  <SubBuildingId>1034f59f-69c3-4bbb-bcc1-0604706b6f1d</SubBuildingId>
  <SubSectorId>7a592324-33d0-42cf-b090-4d87a394f48f</SubSectorId>
  <UpdatedBy>1</UpdatedBy>
  <UpdatedByName>sample string 12</UpdatedByName>
  <UpdatedOn>2025-05-25T20:10:07.3200626+04:00</UpdatedOn>
  <VisitDetails>sample string 5</VisitDetails>
  <VisitType>9f577608-2bb1-445b-885f-9637565b7215</VisitType>
  <WorkflowStatus>e0917ae4-0df8-4bde-9db5-2fea30f6c090</WorkflowStatus>
</ScheduleDTO>