POST Pathway/format

Request Information

URI Parameters

None.

Body Parameters

RA.Models.Input.PathwayRequest
NameDescriptionTypeAdditional information
Pathway

RA.Models.Input.Pathway

None.

PathwayComponents

Collection of RA.Models.Input.PathwayComponent

None.

ComponentConditions

Collection of RA.Models.Input.ComponentCondition

None.

DefaultLanguage

string

None.

PublishForOrganizationIdentifier

string

None.

RegistryEnvelopeId

string

None.

Community

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Pathway": {
    "Ctid": "sample string 1",
    "InLanguage": [
      "sample string 1",
      "sample string 2"
    ],
    "Name": "sample string 2",
    "Name_Map": null,
    "Description": "sample string 3",
    "Description_Map": null,
    "SubjectWebpage": "sample string 4",
    "HasChild": [
      "sample string 1",
      "sample string 2"
    ],
    "HasDestinationComponent": [
      "sample string 1",
      "sample string 2"
    ],
    "OwnedBy": [
      {
        "Type": "sample string 1",
        "SocialMedia": [
          "sample string 1",
          "sample string 2"
        ],
        "Id": "sample string 2",
        "CTID": "sample string 3",
        "Name": "sample string 4",
        "SubjectWebpage": "sample string 5",
        "Description": "sample string 6"
      },
      {
        "Type": "sample string 1",
        "SocialMedia": [
          "sample string 1",
          "sample string 2"
        ],
        "Id": "sample string 2",
        "CTID": "sample string 3",
        "Name": "sample string 4",
        "SubjectWebpage": "sample string 5",
        "Description": "sample string 6"
      }
    ],
    "OfferedBy": [
      {
        "Type": "sample string 1",
        "SocialMedia": [
          "sample string 1",
          "sample string 2"
        ],
        "Id": "sample string 2",
        "CTID": "sample string 3",
        "Name": "sample string 4",
        "SubjectWebpage": "sample string 5",
        "Description": "sample string 6"
      },
      {
        "Type": "sample string 1",
        "SocialMedia": [
          "sample string 1",
          "sample string 2"
        ],
        "Id": "sample string 2",
        "CTID": "sample string 3",
        "Name": "sample string 4",
        "SubjectWebpage": "sample string 5",
        "Description": "sample string 6"
      }
    ]
  },
  "PathwayComponents": [
    {
      "PathwayComponentType": "sample string 1",
      "CTID": "sample string 2",
      "CodedNotation": "sample string 3",
      "Description": "sample string 4",
      "Description_Map": null,
      "HasCondition": [
        "sample string 1",
        "sample string 2"
      ],
      "HasChild": [
        "sample string 1",
        "sample string 2"
      ],
      "IsChildOf": [
        "sample string 1",
        "sample string 2"
      ],
      "IsDestinationComponentOf": [
        "sample string 1",
        "sample string 2"
      ],
      "Name": "sample string 5",
      "Name_Map": null,
      "Points": 6.0,
      "Preceeds": [
        "sample string 1",
        "sample string 2"
      ],
      "Prerequisite": [
        "sample string 1",
        "sample string 2"
      ],
      "SourceData": "sample string 7",
      "SubjectWebpage": "sample string 8",
      "ComponentCategory": "sample string 9",
      "ComponentCategory_Map": null,
      "ProgramTerm": "sample string 10",
      "ProgramTerm_Map": null,
      "CredentialType": {
        "Id": "sample string 1",
        "CTID": "sample string 2",
        "Type": "sample string 3",
        "Name": "sample string 4",
        "SubjectWebpage": "sample string 5",
        "Description": "sample string 6"
      }
    },
    {
      "PathwayComponentType": "sample string 1",
      "CTID": "sample string 2",
      "CodedNotation": "sample string 3",
      "Description": "sample string 4",
      "Description_Map": null,
      "HasCondition": [
        "sample string 1",
        "sample string 2"
      ],
      "HasChild": [
        "sample string 1",
        "sample string 2"
      ],
      "IsChildOf": [
        "sample string 1",
        "sample string 2"
      ],
      "IsDestinationComponentOf": [
        "sample string 1",
        "sample string 2"
      ],
      "Name": "sample string 5",
      "Name_Map": null,
      "Points": 6.0,
      "Preceeds": [
        "sample string 1",
        "sample string 2"
      ],
      "Prerequisite": [
        "sample string 1",
        "sample string 2"
      ],
      "SourceData": "sample string 7",
      "SubjectWebpage": "sample string 8",
      "ComponentCategory": "sample string 9",
      "ComponentCategory_Map": null,
      "ProgramTerm": "sample string 10",
      "ProgramTerm_Map": null,
      "CredentialType": {
        "Id": "sample string 1",
        "CTID": "sample string 2",
        "Type": "sample string 3",
        "Name": "sample string 4",
        "SubjectWebpage": "sample string 5",
        "Description": "sample string 6"
      }
    }
  ],
  "ComponentConditions": [
    {
      "Description": "sample string 1",
      "Description_Map": null,
      "Name": "sample string 2",
      "Name_Map": null,
      "RequiredNumber": 3,
      "TargetComponent": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Description": "sample string 1",
      "Description_Map": null,
      "Name": "sample string 2",
      "Name_Map": null,
      "RequiredNumber": 3,
      "TargetComponent": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "DefaultLanguage": "sample string 1",
  "PublishForOrganizationIdentifier": "sample string 2",
  "RegistryEnvelopeId": "sample string 3",
  "Community": "sample string 4"
}

text/html

Sample:
{"Pathway":{"Ctid":"sample string 1","InLanguage":["sample string 1","sample string 2"],"Name":"sample string 2","Name_Map":null,"Description":"sample string 3","Description_Map":null,"SubjectWebpage":"sample string 4","HasChild":["sample string 1","sample string 2"],"HasDestinationComponent":["sample string 1","sample string 2"],"OwnedBy":[{"Type":"sample string 1","SocialMedia":["sample string 1","sample string 2"],"Id":"sample string 2","CTID":"sample string 3","Name":"sample string 4","SubjectWebpage":"sample string 5","Description":"sample string 6"},{"Type":"sample string 1","SocialMedia":["sample string 1","sample string 2"],"Id":"sample string 2","CTID":"sample string 3","Name":"sample string 4","SubjectWebpage":"sample string 5","Description":"sample string 6"}],"OfferedBy":[{"Type":"sample string 1","SocialMedia":["sample string 1","sample string 2"],"Id":"sample string 2","CTID":"sample string 3","Name":"sample string 4","SubjectWebpage":"sample string 5","Description":"sample string 6"},{"Type":"sample string 1","SocialMedia":["sample string 1","sample string 2"],"Id":"sample string 2","CTID":"sample string 3","Name":"sample string 4","SubjectWebpage":"sample string 5","Description":"sample string 6"}]},"PathwayComponents":[{"PathwayComponentType":"sample string 1","CTID":"sample string 2","CodedNotation":"sample string 3","Description":"sample string 4","Description_Map":null,"HasCondition":["sample string 1","sample string 2"],"HasChild":["sample string 1","sample string 2"],"IsChildOf":["sample string 1","sample string 2"],"IsDestinationComponentOf":["sample string 1","sample string 2"],"Name":"sample string 5","Name_Map":null,"Points":6.0,"Preceeds":["sample string 1","sample string 2"],"Prerequisite":["sample string 1","sample string 2"],"SourceData":"sample string 7","SubjectWebpage":"sample string 8","ComponentCategory":"sample string 9","ComponentCategory_Map":null,"ProgramTerm":"sample string 10","ProgramTerm_Map":null,"CredentialType":{"Id":"sample string 1","CTID":"sample string 2","Type":"sample string 3","Name":"sample string 4","SubjectWebpage":"sample string 5","Description":"sample string 6"}},{"PathwayComponentType":"sample string 1","CTID":"sample string 2","CodedNotation":"sample string 3","Description":"sample string 4","Description_Map":null,"HasCondition":["sample string 1","sample string 2"],"HasChild":["sample string 1","sample string 2"],"IsChildOf":["sample string 1","sample string 2"],"IsDestinationComponentOf":["sample string 1","sample string 2"],"Name":"sample string 5","Name_Map":null,"Points":6.0,"Preceeds":["sample string 1","sample string 2"],"Prerequisite":["sample string 1","sample string 2"],"SourceData":"sample string 7","SubjectWebpage":"sample string 8","ComponentCategory":"sample string 9","ComponentCategory_Map":null,"ProgramTerm":"sample string 10","ProgramTerm_Map":null,"CredentialType":{"Id":"sample string 1","CTID":"sample string 2","Type":"sample string 3","Name":"sample string 4","SubjectWebpage":"sample string 5","Description":"sample string 6"}}],"ComponentConditions":[{"Description":"sample string 1","Description_Map":null,"Name":"sample string 2","Name_Map":null,"RequiredNumber":3,"TargetComponent":["sample string 1","sample string 2"]},{"Description":"sample string 1","Description_Map":null,"Name":"sample string 2","Name_Map":null,"RequiredNumber":3,"TargetComponent":["sample string 1","sample string 2"]}],"DefaultLanguage":"sample string 1","PublishForOrganizationIdentifier":"sample string 2","RegistryEnvelopeId":"sample string 3","Community":"sample string 4"}

application/xml, text/xml

Sample:
<PathwayRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RA.Models.Input">
  <Community>sample string 4</Community>
  <DefaultLanguage>sample string 1</DefaultLanguage>
  <PublishForOrganizationIdentifier>sample string 2</PublishForOrganizationIdentifier>
  <RegistryEnvelopeId>sample string 3</RegistryEnvelopeId>
  <ComponentConditions>
    <ComponentCondition>
      <Description>sample string 1</Description>
      <Description_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <Name>sample string 2</Name>
      <Name_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <RequiredNumber>3</RequiredNumber>
      <TargetComponent xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TargetComponent>
    </ComponentCondition>
    <ComponentCondition>
      <Description>sample string 1</Description>
      <Description_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <Name>sample string 2</Name>
      <Name_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <RequiredNumber>3</RequiredNumber>
      <TargetComponent xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TargetComponent>
    </ComponentCondition>
  </ComponentConditions>
  <Pathway>
    <Ctid>sample string 1</Ctid>
    <Description>sample string 3</Description>
    <Description_Map xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <HasChild xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </HasChild>
    <HasDestinationComponent xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </HasDestinationComponent>
    <InLanguage xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </InLanguage>
    <Name>sample string 2</Name>
    <Name_Map xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <OfferedBy>
      <OrganizationReference>
        <CTID>sample string 3</CTID>
        <Description>sample string 6</Description>
        <Id>sample string 2</Id>
        <Name>sample string 4</Name>
        <SubjectWebpage>sample string 5</SubjectWebpage>
        <Type>sample string 1</Type>
        <SocialMedia xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </SocialMedia>
      </OrganizationReference>
      <OrganizationReference>
        <CTID>sample string 3</CTID>
        <Description>sample string 6</Description>
        <Id>sample string 2</Id>
        <Name>sample string 4</Name>
        <SubjectWebpage>sample string 5</SubjectWebpage>
        <Type>sample string 1</Type>
        <SocialMedia xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </SocialMedia>
      </OrganizationReference>
    </OfferedBy>
    <OwnedBy>
      <OrganizationReference>
        <CTID>sample string 3</CTID>
        <Description>sample string 6</Description>
        <Id>sample string 2</Id>
        <Name>sample string 4</Name>
        <SubjectWebpage>sample string 5</SubjectWebpage>
        <Type>sample string 1</Type>
        <SocialMedia xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </SocialMedia>
      </OrganizationReference>
      <OrganizationReference>
        <CTID>sample string 3</CTID>
        <Description>sample string 6</Description>
        <Id>sample string 2</Id>
        <Name>sample string 4</Name>
        <SubjectWebpage>sample string 5</SubjectWebpage>
        <Type>sample string 1</Type>
        <SocialMedia xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </SocialMedia>
      </OrganizationReference>
    </OwnedBy>
    <SubjectWebpage>sample string 4</SubjectWebpage>
  </Pathway>
  <PathwayComponents>
    <PathwayComponent>
      <CTID>sample string 2</CTID>
      <CodedNotation>sample string 3</CodedNotation>
      <ComponentCategory>sample string 9</ComponentCategory>
      <ComponentCategory_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <CredentialType>
        <CTID>sample string 2</CTID>
        <Description>sample string 6</Description>
        <Id>sample string 1</Id>
        <Name>sample string 4</Name>
        <SubjectWebpage>sample string 5</SubjectWebpage>
        <Type>sample string 3</Type>
      </CredentialType>
      <Description>sample string 4</Description>
      <Description_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <HasChild xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </HasChild>
      <HasCondition xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </HasCondition>
      <IsChildOf xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </IsChildOf>
      <IsDestinationComponentOf xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </IsDestinationComponentOf>
      <Name>sample string 5</Name>
      <Name_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <PathwayComponentType>sample string 1</PathwayComponentType>
      <Points>6</Points>
      <Preceeds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Preceeds>
      <Prerequisite xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Prerequisite>
      <ProgramTerm>sample string 10</ProgramTerm>
      <ProgramTerm_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <SourceData>sample string 7</SourceData>
      <SubjectWebpage>sample string 8</SubjectWebpage>
    </PathwayComponent>
    <PathwayComponent>
      <CTID>sample string 2</CTID>
      <CodedNotation>sample string 3</CodedNotation>
      <ComponentCategory>sample string 9</ComponentCategory>
      <ComponentCategory_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <CredentialType>
        <CTID>sample string 2</CTID>
        <Description>sample string 6</Description>
        <Id>sample string 1</Id>
        <Name>sample string 4</Name>
        <SubjectWebpage>sample string 5</SubjectWebpage>
        <Type>sample string 3</Type>
      </CredentialType>
      <Description>sample string 4</Description>
      <Description_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <HasChild xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </HasChild>
      <HasCondition xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </HasCondition>
      <IsChildOf xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </IsChildOf>
      <IsDestinationComponentOf xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </IsDestinationComponentOf>
      <Name>sample string 5</Name>
      <Name_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <PathwayComponentType>sample string 1</PathwayComponentType>
      <Points>6</Points>
      <Preceeds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Preceeds>
      <Prerequisite xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Prerequisite>
      <ProgramTerm>sample string 10</ProgramTerm>
      <ProgramTerm_Map xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <SourceData>sample string 7</SourceData>
      <SubjectWebpage>sample string 8</SubjectWebpage>
    </PathwayComponent>
  </PathwayComponents>
</PathwayRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RA.Models.RegistryAssistantFormatResponse
NameDescriptionTypeAdditional information
Successful

boolean

None.

Messages

Collection of string

None.

Payload

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Successful": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "Payload": "sample string 2"
}

text/html

Sample:
{"Successful":true,"Messages":["sample string 1","sample string 2"],"Payload":"sample string 2"}

application/xml, text/xml

Sample:
<RegistryAssistantFormatResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RA.Models">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <Payload>sample string 2</Payload>
  <Successful>true</Successful>
</RegistryAssistantFormatResponse>