GET v1/organization/ordermap?serviceprovider={serviceprovider}&full={full}

Get Order Map: Get a list of order map entries in the given service provider's published Order Map.

Request Information

URI Parameters

Name	Description	Type	Additional information
serviceprovider	Name of service provider associated with order map.	string	Required
full	If supplied and set to true, all the Order Map Entry fields will be returned. If not supplied or set to false, only the Ordering Description and Service Provider Code fields will be returned.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

GetOrderMapResponse

Name	Description	Type	Additional information
entryList	List of Order Map Entries in order map	Collection of OrderMapEntry	None.
Error	Will be set to True if any errors occur during the processing of the API method.	boolean	None.
ErrorMessage	Will contain an error message string if Error is True.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "entryList": [
    {
      "OrderingDescription": "sample string 1",
      "OrderingCode": "sample string 2",
      "ServiceProviderDescription": "sample string 3",
      "ServiceProviderCode": "sample string 4",
      "ServiceProviderCategory": "sample string 5",
      "CustomCategory": "sample string 6",
      "Confidentiality": "sample string 7"
    },
    {
      "OrderingDescription": "sample string 1",
      "OrderingCode": "sample string 2",
      "ServiceProviderDescription": "sample string 3",
      "ServiceProviderCode": "sample string 4",
      "ServiceProviderCategory": "sample string 5",
      "CustomCategory": "sample string 6",
      "Confidentiality": "sample string 7"
    }
  ],
  "Error": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<GetOrderMapResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>true</Error>
  <ErrorMessage>sample string 2</ErrorMessage>
  <entryList>
    <OrderMapEntry>
      <OrderingDescription>sample string 1</OrderingDescription>
      <OrderingCode>sample string 2</OrderingCode>
      <ServiceProviderDescription>sample string 3</ServiceProviderDescription>
      <ServiceProviderCode>sample string 4</ServiceProviderCode>
      <ServiceProviderCategory>sample string 5</ServiceProviderCategory>
      <CustomCategory>sample string 6</CustomCategory>
      <Confidentiality>sample string 7</Confidentiality>
    </OrderMapEntry>
    <OrderMapEntry>
      <OrderingDescription>sample string 1</OrderingDescription>
      <OrderingCode>sample string 2</OrderingCode>
      <ServiceProviderDescription>sample string 3</ServiceProviderDescription>
      <ServiceProviderCode>sample string 4</ServiceProviderCode>
      <ServiceProviderCategory>sample string 5</ServiceProviderCategory>
      <CustomCategory>sample string 6</CustomCategory>
      <Confidentiality>sample string 7</Confidentiality>
    </OrderMapEntry>
  </entryList>
</GetOrderMapResponse>