GET v1/ams/{externalPartner}/client-fields/divisions/{divisionId}

Request Information

URI Parameters

Name	Description	Type	Additional information
externalPartner		ExternalPartners	Required
divisionId		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of AMSIntegrationClientSyncFieldDTO

Name	Type	Additional information
Code	string	None.
Description	string	None.
InternalDisplayName	string	None.
ExternalDisplayName	string	None.
IsActive	boolean	None.
IsInternallyRequired	boolean	None.
IsExternallyRequired	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "code": "sample string 1",
    "description": "sample string 2",
    "internalDisplayName": "sample string 3",
    "externalDisplayName": "sample string 4",
    "isActive": true,
    "isInternallyRequired": true,
    "isExternallyRequired": true
  },
  {
    "code": "sample string 1",
    "description": "sample string 2",
    "internalDisplayName": "sample string 3",
    "externalDisplayName": "sample string 4",
    "isActive": true,
    "isInternallyRequired": true,
    "isExternallyRequired": true
  }
]

text/xml

Sample:

<ArrayOfAMSIntegrationClientSyncFieldDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <AMSIntegrationClientSyncFieldDTO>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <ExternalDisplayName>sample string 4</ExternalDisplayName>
    <InternalDisplayName>sample string 3</InternalDisplayName>
    <IsActive>true</IsActive>
    <IsExternallyRequired>true</IsExternallyRequired>
    <IsInternallyRequired>true</IsInternallyRequired>
  </AMSIntegrationClientSyncFieldDTO>
  <AMSIntegrationClientSyncFieldDTO>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <ExternalDisplayName>sample string 4</ExternalDisplayName>
    <InternalDisplayName>sample string 3</InternalDisplayName>
    <IsActive>true</IsActive>
    <IsExternallyRequired>true</IsExternallyRequired>
    <IsInternallyRequired>true</IsInternallyRequired>
  </AMSIntegrationClientSyncFieldDTO>
</ArrayOfAMSIntegrationClientSyncFieldDTO>