Reference for https://tsapi.southhills.edu/Recruitment/prospects/{PROSPECTID}/opportunities/{OPPORTUNITYID}
Updats an opportunity for a prospect.
Url: https://tsapi.southhills.edu/Recruitment/prospects/{PROSPECTID}/opportunities/{OPPORTUNITYID}
HTTP Method: POST
Message direction | Format | Body |
---|---|---|
Request | Xml | Example,Schema |
Request | Json | Example |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example request Xml body:
<UpdateOpportunityRequest xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract.Requests"> <CustomFieldValues> <CustomFieldValue xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract"> <FieldName>String content</FieldName> <!--Valid elements of type: ArrayOfCustomFieldValue, CustomFieldValue, Opportunity, schema, UpdateOpportunityRequest--> <Value i:type="ArrayOfCustomFieldValue" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CustomFieldValue> <FieldName>String content</FieldName> <!--Valid elements of type: ArrayOfCustomFieldValue, CustomFieldValue, Opportunity, schema, UpdateOpportunityRequest--> <Value i:type="ArrayOfCustomFieldValue"> <CustomFieldValue i:nil="true" /> <CustomFieldValue i:nil="true" /> </Value> </CustomFieldValue> <CustomFieldValue> <FieldName>String content</FieldName> <!--Valid elements of type: ArrayOfCustomFieldValue, CustomFieldValue, Opportunity, schema, UpdateOpportunityRequest--> <Value i:type="ArrayOfCustomFieldValue"> <CustomFieldValue i:nil="true" /> <CustomFieldValue i:nil="true" /> </Value> </CustomFieldValue> </Value> </CustomFieldValue> <CustomFieldValue xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract"> <FieldName>String content</FieldName> <!--Valid elements of type: ArrayOfCustomFieldValue, CustomFieldValue, Opportunity, schema, UpdateOpportunityRequest--> <Value i:type="ArrayOfCustomFieldValue" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <CustomFieldValue> <FieldName>String content</FieldName> <!--Valid elements of type: ArrayOfCustomFieldValue, CustomFieldValue, Opportunity, schema, UpdateOpportunityRequest--> <Value i:type="ArrayOfCustomFieldValue"> <CustomFieldValue i:nil="true" /> <CustomFieldValue i:nil="true" /> </Value> </CustomFieldValue> <CustomFieldValue> <FieldName>String content</FieldName> <!--Valid elements of type: ArrayOfCustomFieldValue, CustomFieldValue, Opportunity, schema, UpdateOpportunityRequest--> <Value i:type="ArrayOfCustomFieldValue"> <CustomFieldValue i:nil="true" /> <CustomFieldValue i:nil="true" /> </Value> </CustomFieldValue> </Value> </CustomFieldValue> </CustomFieldValues> <Opportunity> <AdmissionStage xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">String content</AdmissionStage> <Campaign xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">String content</Campaign> <CreatedDateTime xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">1999-05-31T11:20:00</CreatedDateTime> <DeliveryMode xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">String content</DeliveryMode> <ExternalProviderIdentifier xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">String content</ExternalProviderIdentifier> <IsDefault xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">true</IsDefault> <LeadProvider xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">String content</LeadProvider> <LeadSource xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">String content</LeadSource> <ModifiedDateTime xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">1999-05-31T11:20:00</ModifiedDateTime> <OpportunityId xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">2147483647</OpportunityId> <Program xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">String content</Program> <ProspectId xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">2147483647</ProspectId> <StartDate xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">1999-05-31T11:20:00</StartDate> <Term xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract">String content</Term> </Opportunity> </UpdateOpportunityRequest>
The following is an example request Json body:
{ "CustomFieldValues":[{ "FieldName":"String content", "Value":{ "CustomFieldValue":{ "FieldName":"String content", "Value":{ "CustomFieldValue":null } } } }], "Opportunity":{ "AdmissionStage":"String content", "Campaign":"String content", "CreatedDateTime":"\/Date(928164000000-0400)\/", "DeliveryMode":"String content", "ExternalProviderIdentifier":"String content", "IsDefault":true, "LeadProvider":"String content", "LeadSource":"String content", "ModifiedDateTime":"\/Date(928164000000-0400)\/", "OpportunityId":2147483647, "Program":"String content", "ProspectId":2147483647, "StartDate":"\/Date(928164000000-0400)\/", "Term":"String content" } }
The following is an example response Xml body:
<UpdateOpportunityResponse xmlns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract.Responses"> <Messages xmlns="http://schemas.datacontract.org/2004/07/TSSystem"> <RuntimeMessage> <Code>String content</Code> <Message>String content</Message> <Scope>Undefined</Scope> <Type>Exception</Type> </RuntimeMessage> <RuntimeMessage> <Code>String content</Code> <Message>String content</Message> <Scope>Undefined</Scope> <Type>Exception</Type> </RuntimeMessage> </Messages> <Status xmlns="http://schemas.datacontract.org/2004/07/TSSystem">Undefined</Status> <OpportunityId>2147483647</OpportunityId> <ProspectId>2147483647</ProspectId> </UpdateOpportunityResponse>
The following is an example response Json body:
{ "Messages":[{ "Code":"String content", "Message":"String content", "Scope":0, "Type":0 }], "Status":0, "OpportunityId":2147483647, "ProspectId":2147483647 }
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract.Requests" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract.Requests" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract" /> <xs:complexType name="UpdateOpportunityRequest"> <xs:sequence> <xs:element minOccurs="0" name="CustomFieldValues" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract" type="q1:ArrayOfCustomFieldValue" /> <xs:element minOccurs="0" name="Opportunity" nillable="true" xmlns:q2="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract" type="q2:Opportunity" /> </xs:sequence> </xs:complexType> <xs:element name="UpdateOpportunityRequest" nillable="true" type="tns:UpdateOpportunityRequest" /> </xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfCustomFieldValue"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="CustomFieldValue" nillable="true" type="tns:CustomFieldValue" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfCustomFieldValue" nillable="true" type="tns:ArrayOfCustomFieldValue" /> <xs:complexType name="CustomFieldValue"> <xs:sequence> <xs:element minOccurs="0" name="FieldName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Value" nillable="true" type="xs:anyType" /> </xs:sequence> </xs:complexType> <xs:element name="CustomFieldValue" nillable="true" type="tns:CustomFieldValue" /> <xs:complexType name="Opportunity"> <xs:sequence> <xs:element minOccurs="0" name="AdmissionStage" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Campaign" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CreatedDateTime" type="xs:dateTime" /> <xs:element minOccurs="0" name="DeliveryMode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ExternalProviderIdentifier" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IsDefault" type="xs:boolean" /> <xs:element minOccurs="0" name="LeadProvider" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="LeadSource" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ModifiedDateTime" type="xs:dateTime" /> <xs:element minOccurs="0" name="OpportunityId" type="xs:int" /> <xs:element minOccurs="0" name="Program" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ProspectId" type="xs:int" /> <xs:element minOccurs="0" name="StartDate" nillable="true" type="xs:dateTime" /> <xs:element minOccurs="0" name="Term" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="Opportunity" nillable="true" type="tns:Opportunity" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract.Responses" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TopSchool.Recruitment.Contract.Responses" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/TSSystem" /> <xs:complexType name="UpdateOpportunityResponse"> <xs:complexContent mixed="false"> <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/TSSystem" base="q1:ResponseBase"> <xs:sequence> <xs:element minOccurs="0" name="OpportunityId" type="xs:int" /> <xs:element minOccurs="0" name="ProspectId" type="xs:int" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="UpdateOpportunityResponse" nillable="true" type="tns:UpdateOpportunityResponse" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/TSSystem" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/TSSystem" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:complexType name="ResponseBase"> <xs:sequence> <xs:element minOccurs="0" name="Messages" nillable="true" type="tns:ArrayOfRuntimeMessage" /> <xs:element minOccurs="0" name="Status" type="tns:ResponseStatus" /> </xs:sequence> </xs:complexType> <xs:element name="ResponseBase" nillable="true" type="tns:ResponseBase" /> <xs:complexType name="ArrayOfRuntimeMessage"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="RuntimeMessage" nillable="true" type="tns:RuntimeMessage" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfRuntimeMessage" nillable="true" type="tns:ArrayOfRuntimeMessage" /> <xs:complexType name="RuntimeMessage"> <xs:sequence> <xs:element minOccurs="0" name="Code" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Scope" type="tns:MessageScope" /> <xs:element minOccurs="0" name="Type" type="tns:MessageType" /> </xs:sequence> </xs:complexType> <xs:element name="RuntimeMessage" nillable="true" type="tns:RuntimeMessage" /> <xs:simpleType name="MessageScope"> <xs:restriction base="xs:string"> <xs:enumeration value="Undefined" /> <xs:enumeration value="FriendlyError" /> <xs:enumeration value="SystemError" /> <xs:enumeration value="Warning"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Information"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="MessageScope" nillable="true" type="tns:MessageScope" /> <xs:simpleType name="MessageType"> <xs:restriction base="xs:string"> <xs:enumeration value="Exception" /> <xs:enumeration value="Runtime" /> <xs:enumeration value="Validation" /> </xs:restriction> </xs:simpleType> <xs:element name="MessageType" nillable="true" type="tns:MessageType" /> <xs:simpleType name="ResponseStatus"> <xs:restriction base="xs:string"> <xs:enumeration value="Undefined"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Success"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Error"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Warning"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="ResponseStatus" nillable="true" type="tns:ResponseStatus" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>