POST api/{programid}/Authorizations/GetServiceCodesForAssociation

Description : Fetching list of services for consumer/employee association, based on consumer authorization and allowed employee services

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	Program Id	string	Required

Body Parameters

AuthorizationServiceParams

Name	Description	Type	Additional information
ConsumerNo	Consumer Number	string	None.
ProviderNo		string	None.
WorkStartDate		date	None.
WorkEndDate		date	None.
PayrollControlType		string	None.
UserRoleContext		Collection of RoleContext	None.

Request Formats

application/json, text/json

Sample:

{
  "ConsumerNo": "sample string 1",
  "ProviderNo": "sample string 2",
  "WorkStartDate": "2024-11-16T04:42:06.0814744-05:00",
  "WorkEndDate": "2024-11-16T04:42:06.0814744-05:00",
  "PayrollControlType": "sample string 5",
  "UserRoleContext": [
    {
      "AssemblyName": "sample string 1",
      "Namespace": "sample string 2",
      "FieldName": "sample string 3",
      "ObjectName": "sample string 4",
      "MappingFieldNameOnContextViewInDB": "sample string 5",
      "FieldValue": "sample string 6"
    },
    {
      "AssemblyName": "sample string 1",
      "Namespace": "sample string 2",
      "FieldName": "sample string 3",
      "ObjectName": "sample string 4",
      "MappingFieldNameOnContextViewInDB": "sample string 5",
      "FieldValue": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:

<AuthorizationServiceParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.Authorization">
  <UserRoleContext xmlns:d2p1="http://schemas.datacontract.org/2004/07/PPL.DataProviders.Common" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models">
    <d2p1:RoleContext>
      <d2p1:AssemblyName>sample string 1</d2p1:AssemblyName>
      <d2p1:FieldName>sample string 3</d2p1:FieldName>
      <d2p1:FieldValue>sample string 6</d2p1:FieldValue>
      <d2p1:MappingFieldNameOnContextViewInDB>sample string 5</d2p1:MappingFieldNameOnContextViewInDB>
      <d2p1:Namespace>sample string 2</d2p1:Namespace>
      <d2p1:ObjectName>sample string 4</d2p1:ObjectName>
    </d2p1:RoleContext>
    <d2p1:RoleContext>
      <d2p1:AssemblyName>sample string 1</d2p1:AssemblyName>
      <d2p1:FieldName>sample string 3</d2p1:FieldName>
      <d2p1:FieldValue>sample string 6</d2p1:FieldValue>
      <d2p1:MappingFieldNameOnContextViewInDB>sample string 5</d2p1:MappingFieldNameOnContextViewInDB>
      <d2p1:Namespace>sample string 2</d2p1:Namespace>
      <d2p1:ObjectName>sample string 4</d2p1:ObjectName>
    </d2p1:RoleContext>
  </UserRoleContext>
  <ConsumerNo>sample string 1</ConsumerNo>
  <PayrollControlType>sample string 5</PayrollControlType>
  <ProviderNo>sample string 2</ProviderNo>
  <WorkEndDate>2024-11-16T04:42:06.0814744-05:00</WorkEndDate>
  <WorkStartDate>2024-11-16T04:42:06.0814744-05:00</WorkStartDate>
</AuthorizationServiceParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AuthorizationServiceParams'.

Response Information

Resource Description

AuthorizedServices

Name	Type	Additional information
ServiceCode	string	None.
Description	string	None.
DescriptionOnCheck	string	None.
AuthBeginDate	date	None.
AuthEndDate	date	None.
ExternalData1	string	None.
ExternalData2	string	None.
ValuedOutcome	string	None.
Comment	string	None.
ExternalReferenceId	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ServiceCode": "sample string 1",
  "Description": "sample string 2",
  "DescriptionOnCheck": "sample string 3",
  "AuthBeginDate": "2024-11-16T04:42:06.0814744-05:00",
  "AuthEndDate": "2024-11-16T04:42:06.0814744-05:00",
  "ExternalData1": "sample string 6",
  "ExternalData2": "sample string 7",
  "ValuedOutcome": "sample string 8",
  "Comment": "sample string 9",
  "ExternalReferenceId": "sample string 10"
}

application/xml, text/xml

Sample:

<AuthorizedServices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses.Authorization">
  <AuthBeginDate>2024-11-16T04:42:06.0814744-05:00</AuthBeginDate>
  <AuthEndDate>2024-11-16T04:42:06.0814744-05:00</AuthEndDate>
  <Comment>sample string 9</Comment>
  <Description>sample string 2</Description>
  <DescriptionOnCheck>sample string 3</DescriptionOnCheck>
  <ExternalData1>sample string 6</ExternalData1>
  <ExternalData2>sample string 7</ExternalData2>
  <ExternalReferenceId>sample string 10</ExternalReferenceId>
  <ServiceCode>sample string 1</ServiceCode>
  <ValuedOutcome>sample string 8</ValuedOutcome>
</AuthorizedServices>