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-05-01T05:23:03.8507884+04:00",
"Description": "sample string 4",
"Status": "f190fafc-eb22-41c9-8fff-7b9f26d28cec",
"VisitDetails": "sample string 5",
"DivisionId": "664d3ef7-8cdd-462a-a59c-dcd489148061",
"AssetId": "7df54e71-3a71-41b2-84cf-260daf4795bb",
"BuildingId": "8476ed51-1bb1-4922-9a97-b0283220016a",
"SubBuildingId": "5007b200-0d55-4f62-91b0-ab3a1a4aa0cc",
"LocationId": "4d5ef1da-8b01-40dc-8355-9ab562b7d3b5",
"LevelId": "735a01e1-e117-4f30-a2d0-6aa7305ba6d4",
"CategoryId": "055a6cf4-743e-4381-9bf1-6b0fc66524d1",
"SectorId": "dd450a23-79b3-44a4-84e1-26e9ffe02af9",
"SubSectorId": "4954a186-b240-4397-88b4-a41447305924",
"CreatedBy": 6,
"CreatedOn": "2026-05-01T05:23:03.8507884+04:00",
"UpdatedBy": 1,
"UpdatedOn": "2026-05-01T05:23:03.8507884+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": "308af729-184c-4014-ad9c-2a96cadc0420",
"RegularVisits": true,
"RelatedTo": 34,
"NoOfTrial": 35,
"WorkflowStatus": "b6025661-4882-476f-afe3-a76079c0ad2a",
"CheckListIds": [
1,
2
],
"IsCreatingMultipleCategorySchedule": true,
"CategoryList": [
"1e244777-81b5-417e-995f-829a628de2b2",
"4cd549f1-2e92-4de5-a9ec-bea014ba7bfa"
]
}
text/html, multipart/form-data
Sample:
{"Id":1,"AgentId":2,"ScheduleDate":"2026-05-01T05:23:03.8507884+04:00","Description":"sample string 4","Status":"f190fafc-eb22-41c9-8fff-7b9f26d28cec","VisitDetails":"sample string 5","DivisionId":"664d3ef7-8cdd-462a-a59c-dcd489148061","AssetId":"7df54e71-3a71-41b2-84cf-260daf4795bb","BuildingId":"8476ed51-1bb1-4922-9a97-b0283220016a","SubBuildingId":"5007b200-0d55-4f62-91b0-ab3a1a4aa0cc","LocationId":"4d5ef1da-8b01-40dc-8355-9ab562b7d3b5","LevelId":"735a01e1-e117-4f30-a2d0-6aa7305ba6d4","CategoryId":"055a6cf4-743e-4381-9bf1-6b0fc66524d1","SectorId":"dd450a23-79b3-44a4-84e1-26e9ffe02af9","SubSectorId":"4954a186-b240-4397-88b4-a41447305924","CreatedBy":6,"CreatedOn":"2026-05-01T05:23:03.8507884+04:00","UpdatedBy":1,"UpdatedOn":"2026-05-01T05:23:03.8507884+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":"308af729-184c-4014-ad9c-2a96cadc0420","RegularVisits":true,"RelatedTo":34,"NoOfTrial":35,"WorkflowStatus":"b6025661-4882-476f-afe3-a76079c0ad2a","CheckListIds":[1,2],"IsCreatingMultipleCategorySchedule":true,"CategoryList":["1e244777-81b5-417e-995f-829a628de2b2","4cd549f1-2e92-4de5-a9ec-bea014ba7bfa"]}
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>7df54e71-3a71-41b2-84cf-260daf4795bb</AssetId>
<BuildingId>8476ed51-1bb1-4922-9a97-b0283220016a</BuildingId>
<CategoryId>055a6cf4-743e-4381-9bf1-6b0fc66524d1</CategoryId>
<CategoryList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>1e244777-81b5-417e-995f-829a628de2b2</d2p1:guid>
<d2p1:guid>4cd549f1-2e92-4de5-a9ec-bea014ba7bfa</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-05-01T05:23:03.8507884+04:00</CreatedOn>
<Description>sample string 4</Description>
<DivisionId>664d3ef7-8cdd-462a-a59c-dcd489148061</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>735a01e1-e117-4f30-a2d0-6aa7305ba6d4</LevelId>
<LocationId>4d5ef1da-8b01-40dc-8355-9ab562b7d3b5</LocationId>
<NoOfTrial>35</NoOfTrial>
<Notes>sample string 33</Notes>
<RegularVisits>true</RegularVisits>
<RelatedTo>34</RelatedTo>
<ScheduleDate>2026-05-01T05:23:03.8507884+04:00</ScheduleDate>
<SectorId>dd450a23-79b3-44a4-84e1-26e9ffe02af9</SectorId>
<Source>sample string 10</Source>
<Status>f190fafc-eb22-41c9-8fff-7b9f26d28cec</Status>
<SubBuildingId>5007b200-0d55-4f62-91b0-ab3a1a4aa0cc</SubBuildingId>
<SubSectorId>4954a186-b240-4397-88b4-a41447305924</SubSectorId>
<UpdatedBy>1</UpdatedBy>
<UpdatedByName>sample string 12</UpdatedByName>
<UpdatedOn>2026-05-01T05:23:03.8507884+04:00</UpdatedOn>
<VisitDetails>sample string 5</VisitDetails>
<VisitType>308af729-184c-4014-ad9c-2a96cadc0420</VisitType>
<WorkflowStatus>b6025661-4882-476f-afe3-a76079c0ad2a</WorkflowStatus>
</ScheduleDTO>