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-06-15T21:10:33.9103895+04:00",
"Description": "sample string 4",
"Status": "e3f41083-5a7a-477e-8d1d-7eebd0b77eb7",
"VisitDetails": "sample string 5",
"DivisionId": "83a8190e-aedb-434e-ae87-5bf7e2dedb72",
"AssetId": "b95ba610-52be-4402-9249-aba767b3aa09",
"BuildingId": "5d6694b5-b95b-4baa-815f-c22d45167dca",
"SubBuildingId": "d8ba053c-181f-46ca-a0eb-78747f31895e",
"LocationId": "ba97d9c8-e6ff-4a40-b908-4edcb85fcaff",
"LevelId": "acd27a7b-7e01-4493-8c97-69e8a18c7d18",
"CategoryId": "365d6fee-416f-4a7e-a0f4-45863ff062b3",
"SectorId": "ac3662cc-0ada-4e78-b182-57ff75b9ddcd",
"SubSectorId": "c9c9faf6-ce33-472b-8744-b7c4965faed9",
"CreatedBy": 6,
"CreatedOn": "2026-06-15T21:10:33.9103895+04:00",
"UpdatedBy": 1,
"UpdatedOn": "2026-06-15T21:10:33.9103895+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": "3b8ab76e-d889-4d7d-9d23-553eefa6d516",
"RegularVisits": true,
"RelatedTo": 34,
"NoOfTrial": 35,
"WorkflowStatus": "8a7bad82-1255-4ad2-bc9b-43f6dc6b7890",
"CheckListIds": [
1,
2
],
"IsCreatingMultipleCategorySchedule": true,
"CategoryList": [
"2d76bd29-c2ab-42a0-813e-25f3c8beaa1c",
"5ecf0390-cfe2-443b-a215-b38121575fa9"
]
}
text/html, multipart/form-data
Sample:
{"Id":1,"AgentId":2,"ScheduleDate":"2026-06-15T21:10:33.9103895+04:00","Description":"sample string 4","Status":"e3f41083-5a7a-477e-8d1d-7eebd0b77eb7","VisitDetails":"sample string 5","DivisionId":"83a8190e-aedb-434e-ae87-5bf7e2dedb72","AssetId":"b95ba610-52be-4402-9249-aba767b3aa09","BuildingId":"5d6694b5-b95b-4baa-815f-c22d45167dca","SubBuildingId":"d8ba053c-181f-46ca-a0eb-78747f31895e","LocationId":"ba97d9c8-e6ff-4a40-b908-4edcb85fcaff","LevelId":"acd27a7b-7e01-4493-8c97-69e8a18c7d18","CategoryId":"365d6fee-416f-4a7e-a0f4-45863ff062b3","SectorId":"ac3662cc-0ada-4e78-b182-57ff75b9ddcd","SubSectorId":"c9c9faf6-ce33-472b-8744-b7c4965faed9","CreatedBy":6,"CreatedOn":"2026-06-15T21:10:33.9103895+04:00","UpdatedBy":1,"UpdatedOn":"2026-06-15T21:10:33.9103895+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":"3b8ab76e-d889-4d7d-9d23-553eefa6d516","RegularVisits":true,"RelatedTo":34,"NoOfTrial":35,"WorkflowStatus":"8a7bad82-1255-4ad2-bc9b-43f6dc6b7890","CheckListIds":[1,2],"IsCreatingMultipleCategorySchedule":true,"CategoryList":["2d76bd29-c2ab-42a0-813e-25f3c8beaa1c","5ecf0390-cfe2-443b-a215-b38121575fa9"]}
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>b95ba610-52be-4402-9249-aba767b3aa09</AssetId>
<BuildingId>5d6694b5-b95b-4baa-815f-c22d45167dca</BuildingId>
<CategoryId>365d6fee-416f-4a7e-a0f4-45863ff062b3</CategoryId>
<CategoryList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>2d76bd29-c2ab-42a0-813e-25f3c8beaa1c</d2p1:guid>
<d2p1:guid>5ecf0390-cfe2-443b-a215-b38121575fa9</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-06-15T21:10:33.9103895+04:00</CreatedOn>
<Description>sample string 4</Description>
<DivisionId>83a8190e-aedb-434e-ae87-5bf7e2dedb72</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>acd27a7b-7e01-4493-8c97-69e8a18c7d18</LevelId>
<LocationId>ba97d9c8-e6ff-4a40-b908-4edcb85fcaff</LocationId>
<NoOfTrial>35</NoOfTrial>
<Notes>sample string 33</Notes>
<RegularVisits>true</RegularVisits>
<RelatedTo>34</RelatedTo>
<ScheduleDate>2026-06-15T21:10:33.9103895+04:00</ScheduleDate>
<SectorId>ac3662cc-0ada-4e78-b182-57ff75b9ddcd</SectorId>
<Source>sample string 10</Source>
<Status>e3f41083-5a7a-477e-8d1d-7eebd0b77eb7</Status>
<SubBuildingId>d8ba053c-181f-46ca-a0eb-78747f31895e</SubBuildingId>
<SubSectorId>c9c9faf6-ce33-472b-8744-b7c4965faed9</SubSectorId>
<UpdatedBy>1</UpdatedBy>
<UpdatedByName>sample string 12</UpdatedByName>
<UpdatedOn>2026-06-15T21:10:33.9103895+04:00</UpdatedOn>
<VisitDetails>sample string 5</VisitDetails>
<VisitType>3b8ab76e-d889-4d7d-9d23-553eefa6d516</VisitType>
<WorkflowStatus>8a7bad82-1255-4ad2-bc9b-43f6dc6b7890</WorkflowStatus>
</ScheduleDTO>