GET V3/odata/Program({key})
Gets Program entity by key
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
ProgramId from Program entity |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
QicsUnity.Api.Areas.V3.Models.Program| Name | Description | Type | Additional information |
|---|---|---|---|
| ProgramId |
Gets or sets program id |
integer |
Required 64-bit signed integer |
| Code |
Gets or sets program code |
string |
Required |
| Name |
Gets or sets program name |
string |
Required |
| IsDefault |
Gets or sets a value indicating whether program is default |
boolean |
Required |
Response Formats
application/json, text/json, application/scim+json
Sample:
{
"ProgramId": "1",
"Code": "sample 2",
"Name": "sample 3",
"IsDefault": true
}
application/xml, text/xml
Sample:
<Program xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QicsUnity.Api.Areas.V3.Models"> <Code>sample 2</Code> <IsDefault>true</IsDefault> <Name>sample 3</Name> <ProgramId>1</ProgramId> </Program>