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 | Description | 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": "2026-09-15T08:49:51.1312192+04:00",
"Description": "sample string 4",
"Status": "f2f65d0e-4868-466b-b21d-e707efe1e56c",
"VisitDetails": "sample string 5",
"DivisionId": "47320220-e4e0-4fc2-a031-8d3075c5d7d6",
"AssetId": "e49b1a39-0588-47e5-ae4f-3e09cf21175b",
"BuildingId": "09cd7e1f-28d8-4c54-a221-1147a28c48fc",
"SubBuildingId": "90af6500-14e7-47e3-a327-b5a0dd274fca",
"LocationId": "41879c22-30d1-4456-8c6f-df80f67f80d0",
"LevelId": "1c6de4f5-9b2f-45a0-afe3-89c11004eb76",
"CategoryId": "98ade9fb-bc58-4dfd-8cd4-f5ee1cba11c5",
"SectorId": "a8f08f0d-e116-4373-8d60-807f0a957abe",
"SubSectorId": "34d50b93-bca0-437e-a5ab-00cfb318183e",
"CreatedBy": 6,
"CreatedOn": "2026-09-15T08:49:51.1312192+04:00",
"UpdatedBy": 1,
"UpdatedOn": "2026-09-15T08:49:51.1312192+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": "56936f73-807f-4dc5-a4dd-8449bbb29e4d",
"RegularVisits": true,
"RelatedTo": 34,
"NoOfTrial": 35,
"WorkflowStatus": "6663ae77-4c32-43db-b9af-e8be5cd48229",
"CheckListIds": [
1,
2
],
"IsCreatingMultipleCategorySchedule": true,
"CategoryList": [
"db1cac5f-e05d-4dc3-b135-163474c90dc4",
"12e3b961-8463-4cd2-82d7-a9e11def8d6d"
]
}
text/html, multipart/form-data
Sample:
{"Id":1,"AgentId":2,"ScheduleDate":"2026-09-15T08:49:51.1312192+04:00","Description":"sample string 4","Status":"f2f65d0e-4868-466b-b21d-e707efe1e56c","VisitDetails":"sample string 5","DivisionId":"47320220-e4e0-4fc2-a031-8d3075c5d7d6","AssetId":"e49b1a39-0588-47e5-ae4f-3e09cf21175b","BuildingId":"09cd7e1f-28d8-4c54-a221-1147a28c48fc","SubBuildingId":"90af6500-14e7-47e3-a327-b5a0dd274fca","LocationId":"41879c22-30d1-4456-8c6f-df80f67f80d0","LevelId":"1c6de4f5-9b2f-45a0-afe3-89c11004eb76","CategoryId":"98ade9fb-bc58-4dfd-8cd4-f5ee1cba11c5","SectorId":"a8f08f0d-e116-4373-8d60-807f0a957abe","SubSectorId":"34d50b93-bca0-437e-a5ab-00cfb318183e","CreatedBy":6,"CreatedOn":"2026-09-15T08:49:51.1312192+04:00","UpdatedBy":1,"UpdatedOn":"2026-09-15T08:49:51.1312192+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":"56936f73-807f-4dc5-a4dd-8449bbb29e4d","RegularVisits":true,"RelatedTo":34,"NoOfTrial":35,"WorkflowStatus":"6663ae77-4c32-43db-b9af-e8be5cd48229","CheckListIds":[1,2],"IsCreatingMultipleCategorySchedule":true,"CategoryList":["db1cac5f-e05d-4dc3-b135-163474c90dc4","12e3b961-8463-4cd2-82d7-a9e11def8d6d"]}
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>e49b1a39-0588-47e5-ae4f-3e09cf21175b</AssetId>
<BuildingId>09cd7e1f-28d8-4c54-a221-1147a28c48fc</BuildingId>
<CategoryId>98ade9fb-bc58-4dfd-8cd4-f5ee1cba11c5</CategoryId>
<CategoryList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>db1cac5f-e05d-4dc3-b135-163474c90dc4</d2p1:guid>
<d2p1:guid>12e3b961-8463-4cd2-82d7-a9e11def8d6d</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>2026-09-15T08:49:51.1312192+04:00</CreatedOn>
<Description>sample string 4</Description>
<DivisionId>47320220-e4e0-4fc2-a031-8d3075c5d7d6</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>1c6de4f5-9b2f-45a0-afe3-89c11004eb76</LevelId>
<LocationId>41879c22-30d1-4456-8c6f-df80f67f80d0</LocationId>
<NoOfTrial>35</NoOfTrial>
<Notes>sample string 33</Notes>
<RegularVisits>true</RegularVisits>
<RelatedTo>34</RelatedTo>
<ScheduleDate>2026-09-15T08:49:51.1312192+04:00</ScheduleDate>
<SectorId>a8f08f0d-e116-4373-8d60-807f0a957abe</SectorId>
<Source>sample string 10</Source>
<Status>f2f65d0e-4868-466b-b21d-e707efe1e56c</Status>
<SubBuildingId>90af6500-14e7-47e3-a327-b5a0dd274fca</SubBuildingId>
<SubSectorId>34d50b93-bca0-437e-a5ab-00cfb318183e</SubSectorId>
<UpdatedBy>1</UpdatedBy>
<UpdatedByName>sample string 12</UpdatedByName>
<UpdatedOn>2026-09-15T08:49:51.1312192+04:00</UpdatedOn>
<VisitDetails>sample string 5</VisitDetails>
<VisitType>56936f73-807f-4dc5-a4dd-8449bbb29e4d</VisitType>
<WorkflowStatus>6663ae77-4c32-43db-b9af-e8be5cd48229</WorkflowStatus>
</ScheduleDTO>