POST api/ANZCAPSubscription/join

Request Information

URI Parameters

None.

Body Parameters

JoinANZCAPOrAwardRecognitionSubscriptionRequestModel

Name	Type	Additional information
SubscriptionPriceId	globally unique identifier	None.
StripeChargeId	string	None.
StripeChargeStatus	string	None.
SubscriptionPriceValue	decimal number	None.
StripeChargeAmount	decimal number	None.
Comments	string	None.
SubscriptionAwardLevel	string	None.
Pathway	string	None.
DiscountCode	string	None.
PortfolioId	string	None.
RecognitionNumber	string	None.
Action	string	None.
PrimaryWorkplace	Workplace	None.
OtherWorkplaces	Collection of Workplace	None.

Request Formats

application/json, text/json

Sample:

{
  "SubscriptionPriceId": "ec88aafd-856e-46b5-9416-5ca4c095469d",
  "StripeChargeId": "sample string 2",
  "StripeChargeStatus": "sample string 3",
  "SubscriptionPriceValue": 4.0,
  "StripeChargeAmount": 5.0,
  "Comments": "sample string 6",
  "SubscriptionAwardLevel": "sample string 7",
  "Pathway": "sample string 8",
  "DiscountCode": "sample string 9",
  "PortfolioId": "sample string 10",
  "RecognitionNumber": "sample string 11",
  "Action": "sample string 12",
  "PrimaryWorkplace": {
    "WorkplaceId": "0eb3eedf-28f8-478b-856c-3f5fa6af3605",
    "UseWorkplaceDetails": true,
    "WorkType": 0,
    "WorkSuburb": "sample string 2",
    "WorkState": "sample string 3",
    "WorkPostCode": "sample string 4",
    "WorkCountry": "sample string 5",
    "WorkCountryCode": "sample string 6",
    "WorkPhone": "sample string 7"
  },
  "OtherWorkplaces": [
    {
      "WorkplaceId": "0eb3eedf-28f8-478b-856c-3f5fa6af3605",
      "UseWorkplaceDetails": true,
      "WorkType": 0,
      "WorkSuburb": "sample string 2",
      "WorkState": "sample string 3",
      "WorkPostCode": "sample string 4",
      "WorkCountry": "sample string 5",
      "WorkCountryCode": "sample string 6",
      "WorkPhone": "sample string 7"
    },
    {
      "WorkplaceId": "0eb3eedf-28f8-478b-856c-3f5fa6af3605",
      "UseWorkplaceDetails": true,
      "WorkType": 0,
      "WorkSuburb": "sample string 2",
      "WorkState": "sample string 3",
      "WorkPostCode": "sample string 4",
      "WorkCountry": "sample string 5",
      "WorkCountryCode": "sample string 6",
      "WorkPhone": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<JoinANZCAPOrAwardRecognitionSubscriptionRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SHPACollegeAPI.Models.RequestModels">
  <Action>sample string 12</Action>
  <Comments>sample string 6</Comments>
  <DiscountCode>sample string 9</DiscountCode>
  <OtherWorkplaces>
    <Workplace>
      <UseWorkplaceDetails>true</UseWorkplaceDetails>
      <WorkCountry>sample string 5</WorkCountry>
      <WorkCountryCode>sample string 6</WorkCountryCode>
      <WorkPhone>sample string 7</WorkPhone>
      <WorkPostCode>sample string 4</WorkPostCode>
      <WorkState>sample string 3</WorkState>
      <WorkSuburb>sample string 2</WorkSuburb>
      <WorkType>Academia</WorkType>
      <WorkplaceId>0eb3eedf-28f8-478b-856c-3f5fa6af3605</WorkplaceId>
    </Workplace>
    <Workplace>
      <UseWorkplaceDetails>true</UseWorkplaceDetails>
      <WorkCountry>sample string 5</WorkCountry>
      <WorkCountryCode>sample string 6</WorkCountryCode>
      <WorkPhone>sample string 7</WorkPhone>
      <WorkPostCode>sample string 4</WorkPostCode>
      <WorkState>sample string 3</WorkState>
      <WorkSuburb>sample string 2</WorkSuburb>
      <WorkType>Academia</WorkType>
      <WorkplaceId>0eb3eedf-28f8-478b-856c-3f5fa6af3605</WorkplaceId>
    </Workplace>
  </OtherWorkplaces>
  <Pathway>sample string 8</Pathway>
  <PortfolioId>sample string 10</PortfolioId>
  <PrimaryWorkplace>
    <UseWorkplaceDetails>true</UseWorkplaceDetails>
    <WorkCountry>sample string 5</WorkCountry>
    <WorkCountryCode>sample string 6</WorkCountryCode>
    <WorkPhone>sample string 7</WorkPhone>
    <WorkPostCode>sample string 4</WorkPostCode>
    <WorkState>sample string 3</WorkState>
    <WorkSuburb>sample string 2</WorkSuburb>
    <WorkType>Academia</WorkType>
    <WorkplaceId>0eb3eedf-28f8-478b-856c-3f5fa6af3605</WorkplaceId>
  </PrimaryWorkplace>
  <RecognitionNumber>sample string 11</RecognitionNumber>
  <StripeChargeAmount>5</StripeChargeAmount>
  <StripeChargeId>sample string 2</StripeChargeId>
  <StripeChargeStatus>sample string 3</StripeChargeStatus>
  <SubscriptionAwardLevel>sample string 7</SubscriptionAwardLevel>
  <SubscriptionPriceId>ec88aafd-856e-46b5-9416-5ca4c095469d</SubscriptionPriceId>
  <SubscriptionPriceValue>4</SubscriptionPriceValue>
</JoinANZCAPOrAwardRecognitionSubscriptionRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.