POST api/Sync/ReceiveAccountBatch

Receive a batch of accounts associated with a partner.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SyncPointId	Represent the identifier to verify crediantials of batch sent.	globally unique identifier	Required
CountryCode	Represent the country code of account. (ex: Chile=CL, Brasil=BR, Mexico=MX, etc...)	string	Required
CreationDate	Creation datetime of the batch.	date	Required
AccountsPartner	Collection of Account Partner.	Collection of AccountPartner	None.

Request Formats

application/json, text/json

Sample:

{
  "SyncPointId": "760f78ea-1e0f-429f-ad7a-7fdd0c92ed8a",
  "CountryCode": "sample string 2",
  "CreationDate": "2024-05-08T19:26:16.772796+00:00",
  "AccountsPartner": [
    {
      "UserEmail": "sample string 1",
      "UserFullName": "sample string 2",
      "UserTaxID": "sample string 3",
      "UserBirthDate": "2024-05-08T19:26:16.772796+00:00",
      "AccountCode": "sample string 4",
      "AccountName": "sample string 5",
      "AccountState": "sample string 6",
      "AccountCity": "sample string 7",
      "AccountAddress": "sample string 8",
      "AccountContactEmail": "sample string 9",
      "AccountPhoneNumber": "sample string 10",
      "PartnerToken": "sample string 11",
      "TokenUsed": true,
      "UpdatedTimestamp": "2024-05-08T19:26:16.772796+00:00"
    },
    {
      "UserEmail": "sample string 1",
      "UserFullName": "sample string 2",
      "UserTaxID": "sample string 3",
      "UserBirthDate": "2024-05-08T19:26:16.772796+00:00",
      "AccountCode": "sample string 4",
      "AccountName": "sample string 5",
      "AccountState": "sample string 6",
      "AccountCity": "sample string 7",
      "AccountAddress": "sample string 8",
      "AccountContactEmail": "sample string 9",
      "AccountPhoneNumber": "sample string 10",
      "PartnerToken": "sample string 11",
      "TokenUsed": true,
      "UpdatedTimestamp": "2024-05-08T19:26:16.772796+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<AccountPartnerBatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gosocket.Web.Api.Models">
  <AccountsPartner>
    <AccountPartner>
      <AccountAddress>sample string 8</AccountAddress>
      <AccountCity>sample string 7</AccountCity>
      <AccountCode>sample string 4</AccountCode>
      <AccountContactEmail>sample string 9</AccountContactEmail>
      <AccountName>sample string 5</AccountName>
      <AccountPhoneNumber>sample string 10</AccountPhoneNumber>
      <AccountState>sample string 6</AccountState>
      <PartnerToken>sample string 11</PartnerToken>
      <TokenUsed>true</TokenUsed>
      <UpdatedTimestamp>2024-05-08T19:26:16.772796+00:00</UpdatedTimestamp>
      <UserBirthDate>2024-05-08T19:26:16.772796+00:00</UserBirthDate>
      <UserEmail>sample string 1</UserEmail>
      <UserFullName>sample string 2</UserFullName>
      <UserTaxID>sample string 3</UserTaxID>
    </AccountPartner>
    <AccountPartner>
      <AccountAddress>sample string 8</AccountAddress>
      <AccountCity>sample string 7</AccountCity>
      <AccountCode>sample string 4</AccountCode>
      <AccountContactEmail>sample string 9</AccountContactEmail>
      <AccountName>sample string 5</AccountName>
      <AccountPhoneNumber>sample string 10</AccountPhoneNumber>
      <AccountState>sample string 6</AccountState>
      <PartnerToken>sample string 11</PartnerToken>
      <TokenUsed>true</TokenUsed>
      <UpdatedTimestamp>2024-05-08T19:26:16.772796+00:00</UpdatedTimestamp>
      <UserBirthDate>2024-05-08T19:26:16.772796+00:00</UserBirthDate>
      <UserEmail>sample string 1</UserEmail>
      <UserFullName>sample string 2</UserFullName>
      <UserTaxID>sample string 3</UserTaxID>
    </AccountPartner>
  </AccountsPartner>
  <CountryCode>sample string 2</CountryCode>
  <CreationDate>2024-05-08T19:26:16.772796+00:00</CreationDate>
  <SyncPointId>760f78ea-1e0f-429f-ad7a-7fdd0c92ed8a</SyncPointId>
</AccountPartnerBatchModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AccountPartnerBatchResponse

Name	Description	Type	Additional information
BatchId	Represent the identifier of the batch.	globally unique identifier	None.
ReceptionDate	Reception Datetime value of the batch.	date	None.
Status	Represent the status response. 1 = Ok, 2 = Error.	integer	None.
StatusMessage	Represent the description of the status response.	string	None.
BatchCount	Represent the number of accounts in the batch.	integer	None.
AccountsPartnerResponse	Collection of Account Partner.	Collection of AccountPartnerResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "BatchId": "0cb90d09-c765-420a-b785-e32c7ec64ca8",
  "ReceptionDate": "2024-05-08T19:26:16.8139732+00:00",
  "Status": 3,
  "StatusMessage": "sample string 4",
  "BatchCount": 5,
  "AccountsPartnerResponse": [
    {
      "AccountCode": "sample string 1",
      "AccountName": "sample string 2",
      "PartnerToken": "sample string 3",
      "Status": 4,
      "StatusMessage": "sample string 5"
    },
    {
      "AccountCode": "sample string 1",
      "AccountName": "sample string 2",
      "PartnerToken": "sample string 3",
      "Status": 4,
      "StatusMessage": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<AccountPartnerBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gosocket.Web.Api.Models">
  <AccountsPartnerResponse>
    <AccountPartnerResponse>
      <AccountCode>sample string 1</AccountCode>
      <AccountName>sample string 2</AccountName>
      <PartnerToken>sample string 3</PartnerToken>
      <Status>4</Status>
      <StatusMessage>sample string 5</StatusMessage>
    </AccountPartnerResponse>
    <AccountPartnerResponse>
      <AccountCode>sample string 1</AccountCode>
      <AccountName>sample string 2</AccountName>
      <PartnerToken>sample string 3</PartnerToken>
      <Status>4</Status>
      <StatusMessage>sample string 5</StatusMessage>
    </AccountPartnerResponse>
  </AccountsPartnerResponse>
  <BatchCount>5</BatchCount>
  <BatchId>0cb90d09-c765-420a-b785-e32c7ec64ca8</BatchId>
  <ReceptionDate>2024-05-08T19:26:16.8139732+00:00</ReceptionDate>
  <Status>3</Status>
  <StatusMessage>sample string 4</StatusMessage>
</AccountPartnerBatchResponse>