GET api/Position?portalId={portalId}&selected={selected}
Retrieve Postions based on the specified portal id.
Possible Service Responses:
200/OK - match found and participation records are in the body of the response.
404/Contact Not Found - no match found for the specified portal id.
404/Positons Not Found - no match found for the specified contact.
500/Internal Server - unexpected server error, details in the body of the response.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| portalId |
Portal Id of contact |
System.String |
Required |
| selected |
Defines whether to return all positions or just the contacts selected postition |
System.Boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
Contact
System.Collections.Generic.List`1[Altai.Web.Services.Models.Position]| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | System.String |
None. |
|
| Id | System.String |
None. |
|
| ContactId | System.String |
None. |
|
| AccountId | System.String |
None. |
|
| PositionTitleId | System.String |
None. |
|
| PositionTitle | System.String |
None. |
|
| Program | Altai.Web.Services.Models.Program |
None. |
|
| PortalAdminType | System.String |
None. |
|
| StartDate | System.String |
None. |
|
| EndDate | System.String |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Name": "sample string 1",
"Id": "sample string 2",
"ContactId": "sample string 3",
"AccountId": "sample string 4",
"PositionTitleId": "sample string 5",
"PositionTitle": "sample string 6",
"Program": {
"Id": "sample string 1",
"Name": "sample string 2",
"ShortName": "sample string 3",
"Type": "sample string 4",
"ProgramGroup": "sample string 5",
"BillingTermLength": 6,
"ActivePriceListId": "sample string 7",
"BachelorsDegreeMonthsRequired": 8,
"DoctorateDegreeMonthsRequired": 9,
"HighSchoolMonthsRequired": 10,
"MastersDegreeMonthsRequired": 11
},
"PortalAdminType": "sample string 7",
"StartDate": "sample string 8",
"EndDate": "sample string 9"
},
{
"Name": "sample string 1",
"Id": "sample string 2",
"ContactId": "sample string 3",
"AccountId": "sample string 4",
"PositionTitleId": "sample string 5",
"PositionTitle": "sample string 6",
"Program": {
"Id": "sample string 1",
"Name": "sample string 2",
"ShortName": "sample string 3",
"Type": "sample string 4",
"ProgramGroup": "sample string 5",
"BillingTermLength": 6,
"ActivePriceListId": "sample string 7",
"BachelorsDegreeMonthsRequired": 8,
"DoctorateDegreeMonthsRequired": 9,
"HighSchoolMonthsRequired": 10,
"MastersDegreeMonthsRequired": 11
},
"PortalAdminType": "sample string 7",
"StartDate": "sample string 8",
"EndDate": "sample string 9"
}
]
application/xml, text/xml
Sample:
<ArrayOfPosition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Web.Services.Models">
<Position>
<AccountId>sample string 4</AccountId>
<ContactId>sample string 3</ContactId>
<EndDate>sample string 9</EndDate>
<Id>sample string 2</Id>
<Name>sample string 1</Name>
<PortalAdminType>sample string 7</PortalAdminType>
<PositionTitle>sample string 6</PositionTitle>
<PositionTitleId>sample string 5</PositionTitleId>
<Program>
<ActivePriceListId>sample string 7</ActivePriceListId>
<BachelorsDegreeMonthsRequired>8</BachelorsDegreeMonthsRequired>
<BillingTermLength>6</BillingTermLength>
<DoctorateDegreeMonthsRequired>9</DoctorateDegreeMonthsRequired>
<HighSchoolMonthsRequired>10</HighSchoolMonthsRequired>
<Id>sample string 1</Id>
<MastersDegreeMonthsRequired>11</MastersDegreeMonthsRequired>
<Name>sample string 2</Name>
<ProgramGroup>sample string 5</ProgramGroup>
<ShortName>sample string 3</ShortName>
<Type>sample string 4</Type>
</Program>
<StartDate>sample string 8</StartDate>
</Position>
<Position>
<AccountId>sample string 4</AccountId>
<ContactId>sample string 3</ContactId>
<EndDate>sample string 9</EndDate>
<Id>sample string 2</Id>
<Name>sample string 1</Name>
<PortalAdminType>sample string 7</PortalAdminType>
<PositionTitle>sample string 6</PositionTitle>
<PositionTitleId>sample string 5</PositionTitleId>
<Program>
<ActivePriceListId>sample string 7</ActivePriceListId>
<BachelorsDegreeMonthsRequired>8</BachelorsDegreeMonthsRequired>
<BillingTermLength>6</BillingTermLength>
<DoctorateDegreeMonthsRequired>9</DoctorateDegreeMonthsRequired>
<HighSchoolMonthsRequired>10</HighSchoolMonthsRequired>
<Id>sample string 1</Id>
<MastersDegreeMonthsRequired>11</MastersDegreeMonthsRequired>
<Name>sample string 2</Name>
<ProgramGroup>sample string 5</ProgramGroup>
<ShortName>sample string 3</ShortName>
<Type>sample string 4</Type>
</Program>
<StartDate>sample string 8</StartDate>
</Position>
</ArrayOfPosition>